Mirrors/uppy
1
0
Fork 0
mirror of https://github.com/transloadit/uppy.git synced 2026-07-22 09:48:06 +00:00
Code Issues Projects Releases Wiki Activity

tus docs for resume: true

Browse source
This commit is contained in:
Artur Paikin 2018-01-08 12:53:26 -05:00
parent df2693d596
commit 2b584c81d3
1 changed files with 8 additions and 0 deletions
Download patch file Download diff file Expand all files Collapse all files

8
website/src/docs/tus.md
View file

@ -20,6 +20,14 @@ uppy.use(Tus, {
The Tus plugin supports all of [tus-js-client][]’s options. Additionally:
### `resume: true`
A boolean indicating whether tus should attempt to resume the upload if the upload has been started in the past. This includes storing the file’s upload url. Use false to force an entire reupload.
Note that this opition is about resuming when you start an upload again with the same file, or when using [Golden Retriever](/docs/golden-retriever/), which will attempt to restore upload state to what it was before page refresh / browser crash. Even if you set `resume: false` when using Tus uploader, users will still be able to pause/resume an ongoing upload.
In most cases you should leave this option as is, relax, and enjoy resumable uploads.
### `endpoint: ''`
URL to upload to, where your tus.io server is running.