On this page
  1. Install
  2. API entry points and requirements
  3. Peer dependencies

@playstack/local-first-indexeddb

IndexedDB transactions, browser lifecycle events, Web Locks, and cross-tab wake-ups for Playstack Local First.

Pro. Covered by the Playstack Pro License. Registry access is required; check preview availability before installing. See package access.

@playstack/local-first-indexeddb stores engine records and product projections in one real IndexedDB transaction. Product code keeps ownership of its object stores, indexes, and migrations through the native transaction handle.

ts
const storage = createIndexedDbLocalFirstStorage({
  name: 'linegraph',
  version: 1,
  productStores: ['drafts', 'revisions'],
  upgrade(database) {
    database.createObjectStore('drafts', { keyPath: 'id' })
  },
})

const runtime = createBrowserLocalFirstRuntime({
  channelName: 'linegraph:sync',
})

Web Locks exclude competing tabs when available. BroadcastChannel wakes peers but is not treated as a correctness lock. Transaction callbacks must not await network or unrelated timer work because browsers may commit an idle transaction.

Install

After confirming preview access, install the package at your application's shared Playstack version:

sh
npm install --save-exact @playstack/local-first-indexeddb@0.1.0-beta.1

Check the peer requirements below before choosing a runtime or provider.

API entry points and requirements

Reference snapshot: @playstack/local-first-indexeddb@0.1.0-beta.1. Import only the entry point your runtime needs. Paths below are relative to the installed package; use Go to Definition in your editor to inspect exact parameters, return types and overloads. Do not import the declaration-file paths directly.

Public entry pointDeclaration file
@playstack/local-first-indexeddb./dist/index.d.ts
@playstack/local-first-indexeddb/playstack.integration.jsonNo TypeScript declaration (asset or metadata export).
@playstack/local-first-indexeddb/package.jsonNo TypeScript declaration (asset or metadata export).

Node.js engine requirement: >=20. This is not a claim that every entry point works in browsers or Workers.

Peer dependencies

This package declares no peer dependencies. Its ordinary dependencies are resolved by the package manager.

For a complete first program, start with Getting started. For API lookup and partial-example conventions, see Reading the reference. Provider failures, lifecycle requirements and application responsibilities remain described in the guide above; types alone do not establish production safety.

Go

Playstack Pro tag
OriginsPricingBlogNewsletterChangelogStatusRoadmap
ContributorsCommunityIn Use ShowcaseCase StudiesPartnersSponsors
FAQsSupportContact

© 2026 Playstack. All rights reserved.

With OSS
Terms of ServicePrivacy PolicyCookie PolicyImprint

By

Commune Software