From a6e44a953114e385466dcce884d37e433f030549 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Ren=C3=A9e=20Kooi?= Date: Wed, 4 Dec 2019 11:02:50 +0100 Subject: [PATCH] docs: add companionHeaders to s3-multipart docs --- website/src/docs/aws-s3-multipart.md | 10 +++++++++- 1 file changed, 9 insertions(+), 1 deletion(-) diff --git a/website/src/docs/aws-s3-multipart.md b/website/src/docs/aws-s3-multipart.md index dd3ffa47c5..8103feee64 100644 --- a/website/src/docs/aws-s3-multipart.md +++ b/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)