Skip to content

Commit

Permalink
Add note about server-imposed chunkSize hardlimits
Browse files Browse the repository at this point in the history
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
  • Loading branch information
pauln authored Nov 19, 2017
1 parent 7c792b4 commit df6ac82
Showing 1 changed file with 3 additions and 1 deletion.
4 changes: 3 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -167,7 +167,9 @@ be an Error instance.
`withCredentials` in all XMLHttpRequests to use Cookies in requests. The
remote server must accept CORS and credentials.
* `chunkSize = Infinity`: a number indicating the maximum size of a chunk
uploaded in a single request
uploaded in a single request. Note that if the server has hard limits (such as
the minimum 5MB chunk size imposed by S3), specifying a chunk size which falls
outside those hard limits will cause chunked uploads to fail
* `metadata = {}`: an object with string values used as additional meta data
which will be passed along to the server when (and only when) creating a new
upload. Can be used for filenames, file types etc.
Expand Down

0 comments on commit df6ac82

Please sign in to comment.