Skip to content

Commit

Permalink
docs: add companionHeaders to s3-multipart docs
Browse files Browse the repository at this point in the history
  • Loading branch information
goto-bus-stop committed Dec 4, 2019
1 parent 419a27d commit a6e44a9
Showing 1 changed file with 9 additions and 1 deletion.
10 changes: 9 additions & 1 deletion website/src/docs/aws-s3-multipart.md
Original file line number Diff line number Diff line change
Expand Up @@ -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)

Expand Down

0 comments on commit a6e44a9

Please sign in to comment.