Renée Kooi 1a0878a851 Merge pull request #1131 from mattes3/master 6 years ago
..
src 72689d01ac Export Plugin class from @uppy/core. 6 years ago
types c8cb89bde0 Convert to "export =" everywhere because... 6 years ago
LICENSE b41a53bb90 Move `GoldenRetriever` into `@uppy/golden-retriever` package 6 years ago
README.md b41a53bb90 Move `GoldenRetriever` into `@uppy/golden-retriever` package 6 years ago
package.json c68f2c7e68 Release 6 years ago

README.md

@uppy/golden-retriever

Build Status

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 = Uppy()
uppy.use(GoldenRetriever, {
  // Options
})

Installation

$ npm install @uppy/golden-retriever --save

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.