Renée Kooi c81780230d Add all the CI badges (#2725) 4 years ago
..
src 803611ed04 Move @uppy/utils/lib/prettyBytes -> @transloadit/prettier-bytes (#2231) 5 years ago
types be66c47deb Actually check types (#1918) 5 years ago
LICENSE b41a53bb90 Move `GoldenRetriever` into `@uppy/golden-retriever` package 6 years ago
README.md c81780230d Add all the CI badges (#2725) 4 years ago
package.json 1493a807fe Release 4 years ago

README.md

@uppy/golden-retriever

CI status for Uppy tests CI status for Companion tests CI status for browser tests

The GoldenRetriever plugin saves selected files in your browser cache (Local Storage for metadata, then Service Worker for all blobs + IndexedDB for small blobs), so that if the browser crashes, Uppy can restore everything and continue uploading like nothing happened. Read more about it on the blog.

Uppy is being developed by the folks at Transloadit, a versatile file encoding service.

Example

const Uppy = require('@uppy/core')
const GoldenRetriever = require('@uppy/golden-retriever')

const uppy = new Uppy()
uppy.use(GoldenRetriever, {
  // Options
})

Installation

$ npm install @uppy/golden-retriever

We recommend installing from npm and then using a module bundler such as Webpack, Browserify or Rollup.js.

Alternatively, you can also use this plugin in a pre-built bundle from Transloadit's CDN: Edgly. In that case Uppy will attach itself to the global window.Uppy object. See the main Uppy documentation for instructions.

Documentation

Documentation for this plugin can be found on the Uppy website.

License

The MIT License.