From 00c5955b13cc173d4ba6018b582afd3993ac89a1 Mon Sep 17 00:00:00 2001 From: Benjamin Graf Date: Mon, 12 Oct 2020 19:14:09 +0200 Subject: [PATCH] Update factory.js 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: https://github.com/axios/axios/issues/2696 https://github.com/axios/axios/issues/1323 The option is documented here: https://www.npmjs.com/package/follow-redirects --- source/factory.js | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/source/factory.js b/source/factory.js index 1456d1c7..e649e5a9 100644 --- a/source/factory.js +++ b/source/factory.js @@ -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) */ /**