CreateStoreOptions

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

Type Parameters

TSchema

TSchema extends LiveStoreSchema

TContext

TContext = { }

TSyncPayloadSchema

TSyncPayloadSchema extends Schema.Schema<any> = typeof Schema.JsonValue

Properties

adapter

adapter: Adapter

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

---

batchUpdates()?

optional batchUpdates: (run) => void

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

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

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

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

---

debug?

optional debug: object

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

instanceId?

optional instanceId: string

---

disableDevtools?

optional disableDevtools: boolean | "auto"

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

Whether to disable devtools.

Default

'auto'

---

onBootStatus()?

optional onBootStatus: (status) => void

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

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

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

---

shutdownDeferred?

optional shutdownDeferred: ShutdownDeferred

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

---

storeId

storeId: string

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

---

syncPayload?

optional syncPayload: Type<TSyncPayloadSchema>

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

Payload that is sent to the sync backend during connection establishment.

• Its TypeScript type is inferred from syncPayloadSchema (i.e. typeof SyncPayload.Type).
• At runtime this value is encoded with syncPayloadSchema and carried through the adapter to the backend where it can be decoded with the same schema.

Default

undefined

---

syncPayloadSchema?

optional syncPayloadSchema: TSyncPayloadSchema

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

Schema describing the shape of the sync payload and used to encode it.

• If omitted, Schema.JsonValue is used (no additional typing/validation).
• Prefer exporting a schema from your app (e.g. export const SyncPayload = Schema.Struct({ authToken: Schema.String })) and pass it here to get end-to-end type safety and validation.