CreateStoreOptions

Defined in: packages/@livestore/livestore/src/store/create-store.ts:87

Type Parameters

TSchema

TSchema extends LiveStoreSchema

TContext

TContext = { }

Properties

adapter

adapter: Adapter

Defined in: packages/@livestore/livestore/src/store/create-store.ts:89

batchUpdates()?

optional batchUpdates: (run) => void

Defined in: packages/@livestore/livestore/src/store/create-store.ts:99

Parameters

run

() => void

Returns

void

boot()?

optional boot: (store, ctx) => void | Promise<void> | Effect<void, unknown, LiveStoreContextRunning | OtelTracer>

Defined in: packages/@livestore/livestore/src/store/create-store.ts:92

Parameters

store

Store<TSchema, TContext>

ctx

migrationsReport

{ migrations: readonly object[]; }

migrationsReport.migrations

readonly object[]

parentSpan

Span

Returns

void | Promise<void> | Effect<void, unknown, LiveStoreContextRunning | OtelTracer>

confirmUnsavedChanges?

optional confirmUnsavedChanges: boolean

Defined in: packages/@livestore/livestore/src/store/create-store.ts:114

Currently only used in the web adapter: If true, registers a beforeunload event listener to confirm unsaved changes.

Default

true

context?

optional context: TContext

Defined in: packages/@livestore/livestore/src/store/create-store.ts:91

debug?

optional debug: object

Defined in: packages/@livestore/livestore/src/store/create-store.ts:124

instanceId?

optional instanceId: string

disableDevtools?

optional disableDevtools: boolean | "auto"

Defined in: packages/@livestore/livestore/src/store/create-store.ts:105

Whether to disable devtools.

Default

'auto'

onBootStatus()?

optional onBootStatus: (status) => void

Defined in: packages/@livestore/livestore/src/store/create-store.ts:106

Parameters

status

{ stage: "loading"; } | { progress: { done: number; total: number; }; stage: "migrating"; } | { progress: { done: number; total: number; }; stage: "rehydrating"; } | { progress: { done: number; total: number; }; stage: "syncing"; } | { stage: "done"; }