Browse Source

docs: add companionHeaders to s3-multipart docs

Renée Kooi 5 years ago
parent
commit
a6e44a9531
1 changed files with 9 additions and 1 deletions
  1. 9 1
      website/src/docs/aws-s3-multipart.md

+ 9 - 1
website/src/docs/aws-s3-multipart.md

@@ -44,7 +44,15 @@ The maximum amount of chunks to upload simultaneously. Set to `0` to disable lim
 
 ### companionUrl: null
 
-The Companion URL to use for proxying calls to the S3 Multipart API.
+URL of the [Companion](/docs/companion) instance to use for proxying calls to the S3 Multipart API.
+
+This will be used by the default implementations of the upload-related functions below. If you provide your own implementations, a `companionUrl` is unnecessary.
+
+### companionHeaders: {}
+
+Custom headers that should be sent along to [Companion](/docs/companion) on every request.
+
+This will be used by the default implementations of the upload-related functions below. If you provide your own implementations, these headers are not sent automatically.
 
 ### createMultipartUpload(file)