@upflowi/store-indexeddb
v0.2.1
Published
Browser IndexedDB UploadStore for upflowi — resume state survives a page reload or a crashed tab.
Maintainers
Readme
@upflowi/store-indexeddb
A browser UploadStore for upflowi backed by IndexedDB — resume state survives a page reload or a crashed tab.
pnpm add @upflowi/core @upflowi/store-indexeddbimport { createUploader } from "@upflowi/core";
import { createIndexedDbStore } from "@upflowi/store-indexeddb";
const uploader = createUploader({
provider,
transport,
store: createIndexedDbStore(),
});Optionally configure the database/store names:
createIndexedDbStore({ dbName: "my-app", storeName: "uploads" });Requirements
Requires a global indexedDB (any modern browser). Throws UploadValidationError immediately if called somewhere indexedDB isn't available (e.g. a Node.js server) instead of failing later on the first get/set/delete call — use @upflowi/store-memory outside the browser.
Paired with a StorageProvider that supports resuming (e.g. @upflowi/provider-s3's listParts), a multipart upload resumes after a reload without re-transferring parts already completed.
Peer dependency
Requires @upflowi/core as a peer dependency — install both.
Documentation
See the monorepo README for the full resumable-uploads example and AGENTS.md for the architecture.
