ClientSession
Defined in: packages/@livestore/common/dist/adapter-types.d.ts:17
Runtime handle to an active LiveStore client session within the current process. Provides direct access to the embedded SQLite database, leader thread bridge, and lifecycle controls useful for application-level coordination.
Properties
Section titled “Properties”clientId
Section titled “clientId”clientId:
string
Defined in: packages/@livestore/common/dist/adapter-types.d.ts:27
debugInstanceId
Section titled “debugInstanceId”debugInstanceId:
string
Defined in: packages/@livestore/common/dist/adapter-types.d.ts:35
A unique identifier for the current instance of the client session. Used for debugging purposes.
devtools
Section titled “devtools”devtools: {
enabled:false; } | {enabled:true;pullLatch:Latch;pushLatch:Latch; }
Defined in: packages/@livestore/common/dist/adapter-types.d.ts:20
leaderThread
Section titled “leaderThread”leaderThread:
ClientSessionLeaderThreadProxy
Defined in: packages/@livestore/common/dist/adapter-types.d.ts:33
A proxy API to communicate with the leader thread
lockStatus
Section titled “lockStatus”lockStatus:
SubscriptionRef<LockStatus>
Defined in: packages/@livestore/common/dist/adapter-types.d.ts:30
Status info whether current session is leader or not
sessionId
Section titled “sessionId”sessionId:
string
Defined in: packages/@livestore/common/dist/adapter-types.d.ts:28
shutdown()
Section titled “shutdown()”shutdown: (
cause) =>Effect<void>
Defined in: packages/@livestore/common/dist/adapter-types.d.ts:31
Parameters
Section titled “Parameters”Exit<IntentionalShutdownCause, UnexpectedError | InvalidPushError | InvalidPullError | MaterializeError>
Returns
Section titled “Returns”Effect<void>
sqliteDb
Section titled “sqliteDb”sqliteDb:
SqliteDb
Defined in: packages/@livestore/common/dist/adapter-types.d.ts:19
SQLite database with synchronous API running in the same thread (usually in-memory)