Skip to content

Commit

Permalink
Update factory.js
Browse files Browse the repository at this point in the history
Document the `maxBodyLength` property on the `PutOptions` object. It will be passed through to `follow-redirects` in nodejs-environments, where it is the default axios backend.

See also those issues:
axios/axios#2696
axios/axios#1323

The option is documented here: https://www.npmjs.com/package/follow-redirects
  • Loading branch information
bennigraf authored Oct 12, 2020
1 parent 2416073 commit 00c5955
Showing 1 changed file with 2 additions and 1 deletion.
3 changes: 2 additions & 1 deletion source/factory.js
Original file line number Diff line number Diff line change
Expand Up @@ -25,7 +25,8 @@ const NOOP = () => {};
* Options for creating a resource
* @typedef {UserOptions} PutOptions
* @property {Boolean=} overwrite - Whether or not to overwrite existing files (default: true)
* @property {Number=} maxContentLength - The maximum amount of bytes to upload (default: 10 MiB)
* @property {Number=} maxContentLength - The maximum amount of bytes to download (default: 10 MiB)
* @property {Number=} maxBodyLength - The maximum amount of bytes to upload (default: 10 MiB) (only in nodejs-environments)
*/

/**
Expand Down

0 comments on commit 00c5955

Please sign in to comment.