Skip to content

Commit df6ac82

Browse files
authored
Add note about server-imposed chunkSize hardlimits
Adds a note to the readme to mention that exceeding any server-imposed chunk size hardlimits will result in chunked uploads failing. This is to help anyone who doesn't realise that they're hitting such limits. See the following for further information / discussion: - tus/tus-resumable-upload-protocol#89 - tus/tus-resumable-upload-protocol#93
1 parent 7c792b4 commit df6ac82

File tree

1 file changed

+3
-1
lines changed

1 file changed

+3
-1
lines changed

README.md

+3-1
Original file line numberDiff line numberDiff line change
@@ -167,7 +167,9 @@ be an Error instance.
167167
`withCredentials` in all XMLHttpRequests to use Cookies in requests. The
168168
remote server must accept CORS and credentials.
169169
* `chunkSize = Infinity`: a number indicating the maximum size of a chunk
170-
uploaded in a single request
170+
uploaded in a single request. Note that if the server has hard limits (such as
171+
the minimum 5MB chunk size imposed by S3), specifying a chunk size which falls
172+
outside those hard limits will cause chunked uploads to fail
171173
* `metadata = {}`: an object with string values used as additional meta data
172174
which will be passed along to the server when (and only when) creating a new
173175
upload. Can be used for filenames, file types etc.

0 commit comments

Comments
 (0)