CreateStoreOptions

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

Extends

• LoggerOptions

Extended by

• RegistryStoreOptions

Type Parameters

TSchema

TSchema extends LiveStoreSchema

TContext

TContext = { }

TSyncPayloadSchema

TSyncPayloadSchema extends Schema.Codec<Schema.Json, Schema.Json> = typeof Schema.Json

Properties

adapter

adapter: Adapter

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

Adapter used for data storage and synchronization.

---

batchUpdates()?

optional batchUpdates: (run) => void

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

Needed in React so LiveStore can apply multiple events in a single render.

Parameters

run

() => void

Returns

void

Example

// With React DOM
import { unstable_batchedUpdates as batchUpdates } from 'react-dom'

// With React Native
import { unstable_batchedUpdates as batchUpdates } from 'react-native'

---

boot()?

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

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

Parameters

store

Store<TSchema, TContext>

ctx

migrationsReport

MigrationsReport

parentSpan

Span

Returns

SyncOrPromiseOrEffect<void, unknown, OtelTracer | LiveStoreContextRunning>

---

confirmUnsavedChanges?

optional confirmUnsavedChanges: boolean

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

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

User-defined context that will be attached to the created Store (e.g. for dependency injection).

---

debug?

optional debug: object

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

instanceId?

optional instanceId: string

---

disableDevtools?

optional disableDevtools: boolean | "auto"

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

Whether to disable devtools.

Default

'auto'

---

logger?

optional logger: Layer<never, never, never>

Defined in: packages/@livestore/common/dist/logging.d.ts:11

Optional Effect logger layer to control logging output.

Inherited from

LogConfig.LoggerOptions.logger

---

logLevel?

optional logLevel: LogLevel

Defined in: packages/@livestore/common/dist/logging.d.ts:13

Optional minimum log level for the runtime.

Inherited from

LogConfig.LoggerOptions.logLevel

---

onBootStatus()?

optional onBootStatus: (status) => void

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

Parameters

status

ReadonlySide<{ stage: Literal<"loading">; }, "Type"> | ReadonlySide<{ progress: Struct<{ done: Finite; total: Finite; }>; stage: Literal<"migrating">; }, "Type"> | ReadonlySide<{ progress: Struct<{ done: Finite; total: Finite; }>; stage: Literal<"rehydrating">; }, "Type"> | ReadonlySide<{ progress: Struct<{ done: Finite; total: Finite; }>; stage: Literal<"syncing">; }, "Type"> | ReadonlySide<{ stage: Literal<"done">; }, "Type"> | ReadonlySide<{ message: String; reason: Literals<readonly ["private-browsing", "storage-unavailable", "unknown"]>; stage: Literal<"warning">; }, "Type">

Returns

void

---

params?

optional params: object

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

Options provided to the Store constructor.

eventQueryBatchSize?

optional eventQueryBatchSize: number

Chunk size used when the stream replays confirmed events.

leaderPushBatchSize?

optional leaderPushBatchSize: number

Max events pushed to the leader per write batch.

---

schema

schema: TSchema

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

The LiveStore schema defining tables, events, and materializers.

---

shutdownDeferred?

optional shutdownDeferred: ShutdownDeferred

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

---

storeId

storeId: string

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

Unique identifier for the Store instance, stable for its lifetime.

• Valid characters: Only alphanumeric characters, underscores (_), and hyphens (-) are allowed. Must match /^[a-zA-Z0-9_-]+$/.
• Globally unique: Use globally unique IDs (e.g., nanoid) to prevent collisions across stores.
• Use namespaces: Prefix to avoid collisions and for easier identification when debugging (e.g., app-root, workspace-abc123, issue-456)

---

syncPayload?

optional syncPayload: TSyncPayloadSchema["Type"]

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

Payload that is sent to the sync backend when connecting

• 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:206

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

• If omitted, Schema.Json 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.