Quellcode durchsuchen

tus docs for resume: true

Artur Paikin vor 7 Jahren
Ursprung
Commit
2b584c81d3
1 geänderte Dateien mit 8 neuen und 0 gelöschten Zeilen
  1. 8 0
      website/src/docs/tus.md

+ 8 - 0
website/src/docs/tus.md

@@ -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.