github-actions[bot] d425517c64 Release: uppy@4.0.0-beta.1 (#5047) 1 year ago
..
src 00405fb24c fix type imports (#5038) 1 year ago
.npmignore 8ae90c5b11 @uppy/golden-retriever: migrate to TS (#4989) 1 year ago
CHANGELOG.md d425517c64 Release: uppy@4.0.0-beta.1 (#5047) 1 year ago
LICENSE b41a53bb90 Move `GoldenRetriever` into `@uppy/golden-retriever` package 6 years ago
README.md 7adacb74a7 meta: Fix logos in all the readmes (#4407) 2 years ago
package.json d425517c64 Release: uppy@4.0.0-beta.1 (#5047) 1 year ago
tsconfig.build.json 8ae90c5b11 @uppy/golden-retriever: migrate to TS (#4989) 1 year ago
tsconfig.json 8ae90c5b11 @uppy/golden-retriever: migrate to TS (#4989) 1 year 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

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.