CreateStoreOptions

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

Type Parameters

TSchema

TSchema extends LiveStoreSchema

TContext

TContext = { }

Properties

adapter

adapter: Adapter

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

---

batchUpdates()?

optional batchUpdates: (run) => void

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

Parameters

run

() => void

Returns

void

---

boot()?

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

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

Parameters

store

Store<TSchema, TContext>

ctx

migrationsReport

{ migrations: readonly object[]; }

migrationsReport.migrations

readonly object[]

parentSpan

Span

Returns

SyncOrPromiseOrEffect<void, unknown, LiveStoreContextRunning | OtelTracer>

---

confirmUnsavedChanges?

optional confirmUnsavedChanges: boolean

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

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:94

---

debug?

optional debug: object

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

instanceId?

optional instanceId: string

---

disableDevtools?

optional disableDevtools: boolean | "auto"

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

Whether to disable devtools.

Default

'auto'

---

onBootStatus()?

optional onBootStatus: (status) => void

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

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"; }

Returns

void

---

params?

optional params: object

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

leaderPushBatchSize?

optional leaderPushBatchSize: number

simulation?

optional simulation: object

simulation.clientSessionSyncProcessor

clientSessionSyncProcessor: object

simulation.clientSessionSyncProcessor.pull

readonly pull: object

simulation.clientSessionSyncProcessor.pull.1_before_leader_push_fiber_interrupt

readonly 1_before_leader_push_fiber_interrupt: number

simulation.clientSessionSyncProcessor.pull.2_before_leader_push_queue_clear

readonly 2_before_leader_push_queue_clear: number

simulation.clientSessionSyncProcessor.pull.3_before_rebase_rollback

readonly 3_before_rebase_rollback: number

simulation.clientSessionSyncProcessor.pull.4_before_leader_push_queue_offer

readonly 4_before_leader_push_queue_offer: number

simulation.clientSessionSyncProcessor.pull.5_before_leader_push_fiber_run

readonly 5_before_leader_push_fiber_run: number

---

schema

schema: TSchema

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

---

shutdownDeferred?

optional shutdownDeferred: ShutdownDeferred

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

---

storeId

storeId: string

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

---

syncPayload?

optional syncPayload: JsonValue

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

Payload that will be passed to the sync backend when connecting

Default

undefined