Store

Defined in: packages/@livestore/livestore/src/store/store.ts:72

Extends

• Class

Type Parameters

TSchema

TSchema extends LiveStoreSchema = Any

TContext

TContext = { }

Constructors

Constructor

new Store<TSchema, TContext>(__namedParameters): Store<TSchema, TContext>

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

Parameters

__namedParameters

StoreOptions<TSchema, TContext>

Returns

Store<TSchema, TContext>

Overrides

Inspectable.Class.constructor

Properties

__eventSchema

readonly __eventSchema: ForEventDefRecord<TSchema["_EventDefMapType"]>

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

---

activeQueries

activeQueries: ReferenceCountedSet<LiveQuery<any>>

Defined in: packages/@livestore/livestore/src/store/store.ts:113

RC-based set to see which queries are currently subscribed to

---

boot

readonly boot: Effect<void, UnexpectedError, Scope>

Defined in: packages/@livestore/livestore/src/store/store.ts:119

---

clientSession

clientSession: ClientSession

Defined in: packages/@livestore/livestore/src/store/store.ts:76

---

commit()

commit: {<TCommitArg>(…list): void; (txn): void; <TCommitArg>(options, …list): void; (options, txn): void; }

Defined in: packages/@livestore/livestore/src/store/store.ts:644

Commit a list of events to the store which will immediately update the local database and sync the events across other clients (similar to a git commit).

Call Signature

<TCommitArg>(…list): void

Type Parameters

TCommitArg

TCommitArg extends readonly PartialForSchema<TSchema>[]

Parameters

list

…TCommitArg

Returns

void

Call Signature

(txn): void

Parameters

txn

<TCommitArg>(…list) => void

Returns

void

Call Signature

<TCommitArg>(options, …list): void

Type Parameters

TCommitArg

TCommitArg extends readonly PartialForSchema<TSchema>[]

Parameters

options

StoreCommitOptions

list

…TCommitArg

Returns

void

Call Signature

(options, txn): void

Parameters

options

StoreCommitOptions

txn

<TCommitArg>(…list) => void

Returns

void

Examples

store.commit(events.todoCreated({ id: nanoid(), text: 'Make coffee' }))

You can call commit with multiple events to apply them in a single database transaction.

const todoId = nanoid()
store.commit(
  events.todoCreated({ id: todoId, text: 'Make coffee' }),
  events.todoCompleted({ id: todoId }))

For more advanced transaction scenarios, you can pass a synchronous function to commit which will receive a callback to which you can pass multiple events to be committed in the same database transaction. Under the hood this will simply collect all events and apply them in a single database transaction.

store.commit((commit) => {
  const todoId = nanoid()
  if (Math.random() > 0.5) {
    commit(events.todoCreated({ id: todoId, text: 'Make coffee' }))
  } else {
    commit(events.todoCompleted({ id: todoId }))
  }
})

When committing a large batch of events, you can also skip the database refresh to improve performance and call store.manualRefresh() after all events have been committed.

const todos = [
  { id: nanoid(), text: 'Make coffee' },
  { id: nanoid(), text: 'Buy groceries' },
  // ... 1000 more todos
]
for (const todo of todos) {
  store.commit({ skipRefresh: true }, events.todoCreated({ id: todo.id, text: todo.text }))
}
store.manualRefresh()

---

context

context: TContext

Defined in: packages/@livestore/livestore/src/store/store.ts:78

---

networkStatus

readonly networkStatus: Subscribable<{ devtools: { latchClosed: boolean; }; isConnected: boolean; timestampMs: number; }, never, never>

Defined in: packages/@livestore/livestore/src/store/store.ts:97

Reactive connectivity updates emitted by the backing sync backend.

Example

import { Effect, Stream } from 'effect'

const status = await store.networkStatus.pipe(Effect.runPromise)

await store.networkStatus.changes.pipe(
  Stream.tap((next) => console.log('network status update', next)),
  Stream.runDrain,
  Effect.scoped,
  Effect.runPromise,
)

---

otel

otel: StoreOtel

Defined in: packages/@livestore/livestore/src/store/store.ts:79

---

reactivityGraph

reactivityGraph: ReactivityGraph

Defined in: packages/@livestore/livestore/src/store/store.ts:74

---

schema

schema: LiveStoreSchema

Defined in: packages/@livestore/livestore/src/store/store.ts:77

---

sqliteDbWrapper

sqliteDbWrapper: SqliteDbWrapper

Defined in: packages/@livestore/livestore/src/store/store.ts:75

---

storeId

readonly storeId: string

Defined in: packages/@livestore/livestore/src/store/store.ts:73

---

subscribe

subscribe: SubscribeFn

Defined in: packages/@livestore/livestore/src/store/store.ts:372

Subscribe to the results of a query.

• When providing an onUpdate callback it returns an Unsubscribe function.
• Without a callback it returns an AsyncIterable that yields query results.

Examples

const unsubscribe = store.subscribe(query$, (result) => console.log(result))

for await (const result of store.subscribe(query$)) {
  console.log(result)
}

---

syncProcessor

readonly syncProcessor: ClientSessionSyncProcessor

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

---

tableRefs

tableRefs: object

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

Note we’re using Ref<null> here as we don’t care about the value but only about that something has changed. This only works in combination with equal: () => false which will always trigger a refresh.

Index Signature

[key: string]: Ref<null, ReactivityGraphContext, RefreshReason>

Accessors

clientId

Get Signature

get clientId(): string

Defined in: packages/@livestore/livestore/src/store/store.ts:341

Returns

string

---

sessionId

Get Signature

get sessionId(): string

Defined in: packages/@livestore/livestore/src/store/store.ts:337

Returns

string

Methods

events()

events(_options?): AsyncIterable<ForSchema<TSchema>>

Defined in: packages/@livestore/livestore/src/store/store.ts:758

Returns an async iterable of events.

Parameters

_options?

StoreEventsOptions<TSchema>

Returns

AsyncIterable<ForSchema<TSchema>>

Examples

for await (const event of store.events()) {
  console.log(event)
}

// Get all events from the beginning of time
for await (const event of store.events({ cursor: EventSequenceNumber.ROOT })) {
  console.log(event)
}

---

eventsStream()

eventsStream(_options?): Stream<ForSchema<TSchema>>

Defined in: packages/@livestore/livestore/src/store/store.ts:764

Parameters

_options?

StoreEventsOptions<TSchema>

Returns

Stream<ForSchema<TSchema>>

---

manualRefresh()

manualRefresh(options?): void

Defined in: packages/@livestore/livestore/src/store/store.ts:774

This can be used in combination with skipRefresh when committing events. We might need a better solution for this. Let’s see.

Parameters

options?

label?

string

Returns

void

---

query()

query<TResult>(query, options?): TResult

Defined in: packages/@livestore/livestore/src/store/store.ts:494

Synchronously queries the database without creating a LiveQuery. This is useful for queries that don’t need to be reactive.

Example: Query builder

const completedTodos = store.query(tables.todo.where({ complete: true }))

Example: Raw SQL query

const completedTodos = store.query({ query: 'SELECT * FROM todo WHERE complete = 1', bindValues: {} })

Type Parameters

TResult

TResult

Parameters

query

Queryable<TResult> | { bindValues: Bindable; query: string; schema?: Schema<TResult, TResult, never>; }

options?

debugRefreshReason?

RefreshReason

otelContext?

Context

Returns

TResult

---

setSignal()

setSignal<T>(signalDef, value): void

Defined in: packages/@livestore/livestore/src/store/store.ts:575

Set the value of a signal

Type Parameters

T

T

Parameters

signalDef

SignalDef<T>

value

T | (prev) => T

Returns

void

Examples

const count$ = signal(0, { label: 'count$' })
store.setSignal(count$, 2)

const count$ = signal(0, { label: 'count$' })
store.setSignal(count$, (prev) => prev + 1)

---

shutdown()

shutdown(cause?): Effect<void>

Defined in: packages/@livestore/livestore/src/store/store.ts:807

Shuts down the store and closes the client session.

This is called automatically when the store was created using the React or Effect API.

Parameters

cause?

Cause<UnexpectedError | MaterializeError>

Returns

Effect<void>

---

shutdownPromise()

shutdownPromise(cause?): Promise<void>

Defined in: packages/@livestore/livestore/src/store/store.ts:795

Shuts down the store and closes the client session.

This is called automatically when the store was created using the React or Effect API.

Parameters

cause?

UnexpectedError

Returns

Promise<void>

---

subscribeStream()

subscribeStream<TResult>(query, options?): Stream<TResult>

Defined in: packages/@livestore/livestore/src/store/store.ts:460

Type Parameters

TResult

TResult

Parameters

query

Queryable<TResult>

options?

SubscribeOptions<TResult>

Returns

Stream<TResult>

---

toJSON()

toJSON(): object

Defined in: packages/@livestore/livestore/src/store/store.ts:884

Returns

object

_tag

_tag: string = 'livestore.Store'

reactivityGraph

reactivityGraph: ReactiveGraphSnapshot

Overrides

Inspectable.Class.toJSON