Kevin van Zonneveld bfe659820e Upgrade linting to 2.0.0-0 (#3280) 3 years ago
..
src bfe659820e Upgrade linting to 2.0.0-0 (#3280) 3 years ago
types 5630f7dc07 tools: enable linter for TypeScript (#2997) 3 years ago
LICENSE b41a53bb90 Move `GoldenRetriever` into `@uppy/golden-retriever` package 6 years ago
README.md 55e0ffd04a Add retext to markdown linter (#3024) 3 years ago
package.json f0a478d21a meta: use `workspace:^` in peerDependencies (#3278) 3 years ago

README.md

@uppy/golden-retriever

npm version 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

import Uppy from '@uppy/core'
import GoldenRetriever from '@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.