A pure JavaScript client for the tus resumable upload protocol.
input.addEventListener("change", function(e) {
// Get the selected file from the input element
var file = e.target.files[0]
// Create a new tus upload
var upload = new tus.Upload(file, {
endpoint: "http://localhost:1080/files/",
onError: function(error) {
console.log("Failed because: " + error)
},
onProgress: function(bytesUploaded, bytesTotal) {
var percentage = (bytesUploaded / bytesTotal * 100).toFixed(2)
console.log(bytesUploaded, bytesTotal, percentage + "%")
},
onSuccess: function() {
console.log("Download %s from %s", upload.file.name, upload.url)
}
})
// Start the upload
upload.start()
})The sources are compiled into a UMD
(dist/tus.js) which can be loaded using different approaches:
- Embed using a script tag:
<script src="dist/tus.js"></script>and access the tus methods using thetusproperty inwindow - Install from NPM:
npm install tus-js-clientand load using browserify:var tus = require("tus-js-client") - Define using AMD:
define("alpha", ["dist/tus.js"], function(tus) {})
We use localStorage, XMLHttpRequest2, the File API and Blob API. About 85% of today's users should be able to use this software, calculated using iwanttouse.com.
Once a new file should be uploaded the client will create a new upload resource
on the server using a POST request. A successful response will contain a
Location header pointing to the upload URL. This URL will be used to transfer
the file to the server using one or multiple PATCH requests.
In addition tus-js-client will generate a unique fingerprint for every file and
store it and the upload URL using the Web Storage API. If the upload is
interrupted or aborted manually, the client is able to resume the upload by
retrieving the upload URL using the fingerprint. The client is even able to
resume after you close your browser or shut down your device. Now the client can
continue to send PATCH requests to the server until the upload is finished.
The tus specification defines multiple extensions which can be optionally implemented beside the core protocol enabling specific functionality. Not all of these extensions are interesting or even useful for a client-side library and therefore support for all of them in tus-js-client is not guranteed.
-
The Creation extension is mostly implemented and is used for creating the upload. Deferring the upload's length is not possible at the moment.
-
The Checksum extension requires that the checksum is calculated inside the browser. While this is totally doable today, it's particularly expensive and time intensive for bigger files and on mobile devices. One solution is to utilise the new Web Crypto API, which probably offers better performance and security, but you could argue whether it has reached critical mass yet.
-
The Concatenation extension is mostly meant for parallel uploads where you need to utilise multiple HTTP connections. In most cases, this does not apply to the environment of the browser but it can also be used for different things.
At the moment, coverage for these extensions is not great but we promise to improve this situation in the near future.
A boolean indicating whether the current browser has the features necessary to use tus-js-client. This can be used to test support and warn the user.
A object containing the default options used when creating a new upload:
endpoint = "": a URL which will be used to create new uploadsfingerprint: a function used to generate a unique string from a corresponding File object. This used to store the URL for an upload to resume. This option is only used if theresumeflag is set to true.resume = true: a boolean indicating whether the client should attempt to resume the upload if the upload has been started in the past. This includes storing the file's fingerprint. Usefalseto force an entire reupload.onProgress = null: a function that will be called each time progress information is available. The arguments will bebytesSentandbytesTotal.onChunkComplete = null: a function that will be called each time a chunk has been successfully uploaded. The arguments will bechunkSize,bytesAccepted,bytesTotal.onSuccess = null: a function called when the upload finished successfully.onError = null: a function called once an error appears. The arguments will be an Error instance.headers = {}: an object with custom header values used in all requests.withCredentials = false: a boolean which is be used as the value forwithCredentialsin 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 requestmetadata = {}: 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.
Create a new tus.Upload object. The upload will not be started automatically,
use start to do so.
The file argument should be an instance of File or Blob. The options
argument will be merged deeply with tus.defaultOptions.
The options argument used in the constructor merged deeply with
tus.defaultOptions.
The file argument used in the constructor.
The URL used to upload the file. Leave it set to null and the client will
create a new upload and set this property to the new upload URL.
You may supply your own URL using this property and the client will try to
resume using this URL.
Start or resume the upload using the specified file. If no file property is
available the error handler will be called. If you supplied your own URL using
the url property the client will try to resume using this URL.
If not, the client will look up if the file has been (fully or partially)
uploaded and tries to resume.
If no upload can be resume it will create a new upload using the supplied
endpoint option.
Abort the currently running upload request and don't continue. You can resume
the upload by calling the start method again.
When configuring a new uploader, the onProgress and onChunkComplete
callbacks are available. While they may seem to be equal based on their
naming and the arguments, they provide different information in reality.
Progress events are emitted using the onProgress option and provide numbers
about how must data has been sent to the server. However, this data may not
have been received or accepted by the endpoint. Imagine a network outage where
the browser reports to have successfully sent 100 bytes, but none of them ever
reach the backend. In order to provide reliable information about whether the
chunks have been accepted by the server, onChunkComplete is only invoked if
we have evidence that the remote endpoint has received and accepted the
uploaded bytes. When consuming this functionality, the chunkSize option is
from high importance since the callback will and invoked if an entire chunk
has been uploaded.
# Install dependencies
npm install
# Build dist/tus.js a single time
npm run build
# Build all dist files (including minification)
npm run dist
# Watch source and rebuild
npm run watchTests are implemented using Jasmine and can be found in the test/ directory.
In order to run the tests, open test/SpecRunner.html in a browser and you
should see a visual representation of the test results. No web server is
required, you can open SpecRunner.html using the file:/// protocol.
In addition, if do not want to download the repository, you can run the latest tests online by visiting https://rawgit.com/tus/tus-js-client/master/test/SpecRunner.html.
Tests can also be run on SauceLabs' cloud infrastructure using npm test.
Before using this command, you have to set up your SauceLabs account by filling
the SAUCE_USERNAME and SAUCE_ACCESS_KEY variables else the command will fail.
MIT