Skip to content
LiveStore (0.3.0-dev.33)
Search
Ctrl
K
Cancel
Docs
Examples
Version: latest
Version: 0.3.0-dev.33
GitHub
Discord
X
Select theme
Dark
Light
Auto
Getting Started
React Web
Expo
Node
Solid
Evaluating LiveStore
Design Decisions
How LiveStore works
State of the project
When to use LiveStore
Technology comparison
Performance benchmarks
Reference
Concepts
Platform Adapters
Web Adapter
Expo Adapter
Node Adapter
Electron Adapter
Tauri Adapter
Events
Events Schema
Events
State
SQLite State Schema
SQL Queries
Reactivity system
SQLite in LiveStore
Event Sourcing
Data Modeling
Devtools
Syncing
Syncing
Limitations
Server-side clients
Sync Backends
Cloudflare Workers
ElectricSQL
OpenTelemetry
Framework Integrations
Custom Elements
React
Solid
Patterns
Encryption
Auth
Effect
AI
Anonymous user transition
File Management
File Structure
ORM
Presence
State Machines
Undo/Redo
Miscellaneous
FAQ
Community
Troubleshooting
Credits
Code of Conduct
Note on Package Management
Sponsoring
Changelog
API Reference (generated)
adapter-expo
functions
makePersistedAdapter
@livestore/adapter-expo
type-aliases
MakeDbOptions
adapter-node
functions
makeInMemoryAdapter
makePersistedAdapter
@livestore/adapter-node
adapter-web
functions
makeInMemoryAdapter
makePersistedAdapter
namespaces
WorkerSchema
namespaces
LeaderWorkerInner
classes
BootStatusStream
Export
ExportEventlog
ExtraDevtoolsMessage
GetLeaderHead
GetLeaderSyncState
GetRecreateSnapshot
InitialMessage
PullStream
PushToLeader
Shutdown
type-aliases
Request
variables
Request
LeaderWorkerOuter
classes
InitialMessage
Request
SharedWorker
classes
InitialMessage
InitialMessagePayloadFromClientSession
Request
UpdateMessagePort
type-aliases
StorageType
StorageTypeEncoded
StorageTypeOpfs
SyncBackendOptions
variables
StorageType
StorageTypeOpfs
SyncBackendOptions
@livestore/adapter-web
type-aliases
WebAdapterOptions
livestore
classes
IntentionalShutdownCause
SqliteDbWrapper
Store
StoreInterrupted
functions
computed
createStore
createStorePromise
deepEqual
emptyDebugInfo
extractStackInfoFromStackTrace
getDefaultValuesDecoded
getDefaultValuesEncoded
getEventDef
makeRef
makeSchema
nanoid
prepareBindValues
provideOtel
queryDb
sql
stackInfoToString
interfaces
ClientSession
CreateStoreOptions
LiveQuery
LiveQueryDef
PreparedStatement
SqliteDb
namespaces
EventId
functions
compare
diff
fromString
globalEventId
isEqual
isGreaterThan
isGreaterThanOrEqual
localEventId
make
max
nextPair
toString
type-aliases
ClientEventId
EventId
EventIdPair
GlobalEventId
variables
clientDefault
ClientEventId
EventId
GlobalEventId
ROOT
FromInputSchema
type-aliases
DeriveSchema
LiveQuery
type-aliases
Any
LiveQueryDef
type-aliases
Any
LiveStoreEvent
classes
EncodedWithMeta
functions
isEqualEncoded
isPartialEventDef
makeEventDefPartialSchema
makeEventDefSchema
makeEventDefSchemaMemo
type-aliases
AnyDecoded
AnyEncoded
AnyEncodedGlobal
EventDefEncoded
EventDefPartial
EventDefPartialSchema
ForEventDef
ForEventDefRecord
ForSchema
PartialAnyDecoded
PartialAnyEncoded
PartialEncoded
PartialForSchema
variables
AnyDecoded
AnyEncoded
AnyEncodedGlobal
PartialAnyEncoded
QueryBuilder
namespaces
WhereOps
type-aliases
Equality
In
Like
MultiValue
Order
SingleValue
type-aliases
Any
ApiFeature
ApiFull
OrderByParams
WhereOps
WhereParams
QueryBuilderAst
interfaces
CountQuery
DeleteQuery
InsertQuery
OnConflict
OrderBy
RowQuery
SelectQuery
UpdateQuery
Where
type-aliases
WriteQuery
RowQuery
type-aliases
DocumentResult
GetIdColumnType
GetOrCreateOptions
RequiredColumnsOptions
Result
ResultEncoded
Schema
classes
Any
ArrayFormatterIssue
BigDecimal
BigDecimalFromNumber
BigDecimalFromSelf
BigIntFromNumber
BigIntFromSelf
BooleanFromString
BooleanFromUnknown
Capitalize
Capitalized
Char
DateFromNumber
DateFromSelf
DateFromString
DateTimeUtc
DateTimeUtcFromDate
DateTimeUtcFromNumber
DateTimeUtcFromSelf
DateTimeZoned
DateTimeZonedFromSelf
Defect
Duration
DurationFromMillis
DurationFromNanos
DurationFromSelf
FiberId
FiberIdFromSelf
Finite
FromPropertySignature
Int
JsonNumber
Lowercase
Lowercased
Negative
Never
NonEmptyString
NonEmptyTrimmedString
NonNaN
NonNegative
NonPositive
Not
Null
NumberFromString
OptionFromNonEmptyTrimmedString
Positive
PropertySignatureDeclaration
PropertySignatureTransformation
SymbolFromSelf
TimeZone
TimeZoneFromSelf
TimeZoneNamed
TimeZoneNamedFromSelf
TimeZoneOffset
TimeZoneOffsetFromSelf
ToPropertySignature
Trim
Trimmed
Uint8
Uint8ArrayFromSelf
ULID
Uncapitalize
Uncapitalized
Undefined
Unknown
Uppercase
Uppercased
URLFromSelf
UUID
ValidDateFromSelf
Void
functions
annotations
ArrayEnsure
asSchema
asSerializable
asSerializableWithResult
asserts
asWithResult
attachPropertySignature
between
betweenBigDecimal
betweenBigInt
betweenDate
betweenDuration
brand
capitalized
Cause
CauseFromSelf
Chunk
ChunkFromSelf
clamp
clampBigDecimal
clampBigInt
clampDuration
Class
compose
Config
Data
DataFromSelf
debugDiff
declare
decode
decodeEither
decodeOption
decodePromise
decodeSync
decodeSyncDebug
decodeUnknown
decodeUnknownEither
decodeUnknownOption
decodeUnknownPromise
decodeUnknownSync
deserialize
deserializeExit
deserializeFailure
deserializeSuccess
Either
EitherFromSelf
EitherFromUnion
element
encode
encodedBoundSchema
encodedSchema
encodeEither
encodeOption
encodePromise
encodeSync
encodeSyncDebug
encodeUnknown
encodeUnknownEither
encodeUnknownOption
encodeUnknownPromise
encodeUnknownSync
encodeWithTransferables
endsWith
Enums
equivalence
Exit
ExitFromSelf
exitSchema
extend
failureSchema
filter
filterEffect
finite
format
fromBrand
fromKey
getNumberIndexedAccess
greaterThan
greaterThanBigDecimal
greaterThanBigInt
greaterThanDate
greaterThanDuration
greaterThanOrEqualTo
greaterThanOrEqualToBigDecimal
greaterThanOrEqualToBigInt
greaterThanOrEqualToDate
greaterThanOrEqualToDuration
hash
HashMap
HashMapFromSelf
HashSet
HashSetFromSelf
head
headNonEmpty
headOrElse
includes
instanceOf
int
is
isPropertySignature
isSchema
itemsCount
keyof
length
lessThan
lessThanBigDecimal
lessThanBigInt
lessThanDate
lessThanDuration
lessThanOrEqualTo
lessThanOrEqualToBigDecimal
lessThanOrEqualToBigInt
lessThanOrEqualToDate
lessThanOrEqualToDuration
List
ListFromSelf
Literal
lowercased
make
makePropertySignature
MapFromRecord
MapFromSelf
maxItems
maxLength
minItems
minLength
MsgPack
multipleOf
mutable
negative
negativeBigDecimal
negativeBigInt
NonEmptyArray
NonEmptyArrayEnsure
NonEmptyChunk
NonEmptyChunkFromSelf
nonEmptyString
nonNaN
nonNegative
nonNegativeBigDecimal
nonNegativeBigInt
nonPositive
nonPositiveBigDecimal
nonPositiveBigInt
NullishOr
NullOr
omit
Option
optional
optionalElement
optionalToOptional
optionalToRequired
optionalWith
OptionFromNullishOr
OptionFromNullOr
OptionFromSelf
OptionFromUndefinedOr
parseJson
parseNumber
partial
partialWith
pattern
pick
pickLiteral
pluck
positive
positiveBigDecimal
positiveBigInt
propertySignature
ReadonlyMap
ReadonlyMapFromRecord
ReadonlyMapFromSelf
ReadonlySet
ReadonlySetFromSelf
Record
Redacted
RedactedFromSelf
rename
required
requiredToOptional
serializableSchema
serialize
serializeExit
serializeFailure
serializeSuccess
SetFromSelf
SortedSet
SortedSetFromSelf
split
standardSchemaV1
startsWith
Struct
successSchema
suspend
swap
tag
TaggedClass
TaggedError
TaggedRequest
TaggedStruct
TemplateLiteral
TemplateLiteralParser
transform
transformLiteral
transformLiterals
transformOrFail
trimmed
Tuple
typeSchema
uncapitalized
UndefinedOr
Union
UniqueSymbolFromSelf
uppercased
validate
validateEither
validateOption
validatePromise
validateSync
validDate
withConstructorDefault
withDecodingDefault
withDefaults
interfaces
Annotable
AnnotableClass
AnnotableDeclare
Array$
ArrayEnsure
brand
BrandSchema
Cause
CauseFromSelf
Chunk
ChunkFromSelf
Class
Data
DataFromSelf
declare
Either
EitherFromSelf
EitherFromUnion
Element
Enums
Exit
ExitFromSelf
extend
filter
filterEffect
FilterIssue
HashMap
HashMapFromSelf
HashSet
HashSetFromSelf
instanceOf
JsonArray
JsonObject
List
ListFromSelf
Literal
Map$
MapFromSelf
mutable
NonEmptyArray
NonEmptyArrayEnsure
NonEmptyChunk
NonEmptyChunkFromSelf
NullishOr
NullOr
Option
optional
optionalWith
OptionFromNullishOr
OptionFromNullOr
OptionFromSelf
OptionFromUndefinedOr
propertySignature
PropertySignature
ReadonlyMap$
ReadonlyMapFromSelf
ReadonlySet$
ReadonlySetFromSelf
Record$
Redacted
RedactedFromSelf
refine
Schema
SchemaClass
Serializable
SerializableWithResult
Set$
SetFromSelf
SortedSet
SortedSetFromSelf
Struct
suspend
tag
TaggedClass
TaggedErrorClass
TaggedRequest
TaggedRequestClass
TemplateLiteral
TemplateLiteralParser
transform
transformLiteral
transformOrFail
Tuple
Tuple2
TupleType
TypeLiteral
UndefinedOr
Union
WithResult
namespaces
Annotable
type-aliases
All
Any
Self
Annotations
interfaces
Doc
Filter
GenericSchema
Schema
Element
interfaces
Annotations
type-aliases
Token
IndexSignature
type-aliases
Context
Encoded
MergeTuple
NonEmptyRecords
Record
Records
Type
PropertySignature
interfaces
Annotations
type-aliases
All
Any
AST
Token
Schema
interfaces
Variance
type-aliases
All
Any
AnyNoContext
AsSchema
Context
Encoded
ToAsserts
Type
Serializable
type-aliases
All
Any
Context
Encoded
Type
SerializableWithResult
type-aliases
All
Any
Context
Struct
type-aliases
Constructor
Context
Encoded
EncodedOptionalKeys
Field
Fields
Key
OptionalEncodedPropertySignature
OptionalTypePropertySignature
PropertySignatureWithDefault
Type
TaggedRequest
type-aliases
All
Any
TupleType
type-aliases
Elements
ElementsEncoded
ElementsType
Encoded
Rest
Type
TypeLiteral
type-aliases
Constructor
Encoded
Type
WithResult
type-aliases
All
Any
Context
Failure
FailureEncoded
Success
SuccessEncoded
type-aliases
BetweenBigIntSchemaId
BetweenSchemaId
CauseEncoded
DateFromSelfSchemaId
DiffItem
DurationEncoded
EitherEncoded
EnumsDefinition
ExitEncoded
FiberIdEncoded
FilterOutput
FiniteSchemaId
GreaterThanBigIntSchemaId
GreaterThanOrEqualToBigIntSchemaId
GreaterThanOrEqualToSchemaId
GreaterThanSchemaId
IntSchemaId
ItemsCountSchemaId
JsonNumberSchemaId
JsonValue
LeftEncoded
LengthSchemaId
LessThanBigIntSchemaId
LessThanOrEqualToBigIntSchemaId
LessThanOrEqualToSchemaId
LessThanSchemaId
MakeOptions
MaxItemsSchemaId
MaxLengthSchemaId
MinItemsSchemaId
MinLengthSchemaId
NonNaNSchemaId
OptionalOptions
OptionEncoded
ParseJsonOptions
PropertySignatureTypeId
RefineSchemaId
RightEncoded
Simplify
SimplifyMutable
TaggedStruct
TypeId
variables
Base64FromUint8Array
BetweenBigDecimalSchemaId
BetweenBigIntSchemaId
BetweenDateSchemaId
BetweenDurationSchemaId
BetweenSchemaId
BrandSchemaId
CapitalizedSchemaId
DateFromSelfSchemaId
EndsWithSchemaId
FiniteSchemaId
GreaterThanBigDecimalSchemaId
GreaterThanBigIntSchemaId
GreaterThanDateSchemaId
GreaterThanDurationSchemaId
GreaterThanOrEqualToBigDecimalSchemaId
GreaterThanOrEqualToBigIntSchemaId
GreaterThanOrEqualToDateSchemaId
GreaterThanOrEqualToDurationSchemaId
GreaterThanOrEqualToSchemaId
GreaterThanSchemaId
IncludesSchemaId
InstanceOfSchemaId
IntSchemaId
ItemsCountSchemaId
JsonNumberSchemaId
JsonValue
LengthSchemaId
LessThanBigDecimalSchemaId
LessThanBigIntSchemaId
LessThanDateSchemaId
LessThanDurationSchemaId
LessThanOrEqualToBigDecimalSchemaId
LessThanOrEqualToBigIntSchemaId
LessThanOrEqualToDateSchemaId
LessThanOrEqualToDurationSchemaId
LessThanOrEqualToSchemaId
LessThanSchemaId
LowercasedSchemaId
MaxItemsSchemaId
MaxLengthSchemaId
MinItemsSchemaId
MinLengthSchemaId
MultipleOfSchemaId
NegativeBigDecimalFromSelf
NegativeBigDecimalSchemaId
NegativeBigInt
NegativeBigIntFromSelf
NonNaNSchemaId
NonNegativeBigDecimalFromSelf
NonNegativeBigDecimalSchemaId
NonNegativeBigInt
NonNegativeBigIntFromSelf
NonNegativeInt
NonPositiveBigDecimalFromSelf
NonPositiveBigDecimalSchemaId
NonPositiveBigInt
NonPositiveBigIntFromSelf
PatternSchemaId
PositiveBigDecimalFromSelf
PositiveBigDecimalSchemaId
PositiveBigInt
PositiveBigIntFromSelf
PropertySignatureTypeId
RefineSchemaId
StartsWithSchemaId
StringFromBase64
StringFromBase64Url
StringFromHex
StringFromUriComponent
symbolSerializable
symbolWithResult
TrimmedSchemaId
TypeId
Uint8ArrayFromBase64
Uint8ArrayFromBase64Url
Uint8ArrayFromHex
ULIDSchemaId
UncapitalizedSchemaId
UppercasedSchemaId
UUIDSchemaId
ValidDateSchemaId
SqliteAst
functions
index
column
dbSchema
hash
structSchemaForTable
table
namespaces
ColumnType
type-aliases
Blob
ColumnType
Integer
Null
Real
Text
type-aliases
Index
Column
DbSchema
ForeignKey
Table
SqliteDsl
functions
blob
boolean
column
datetime
datetimeInteger
defaultSchemaForColumnType
insertStructSchemaForTable
integer
isColumnDefinition
isSqlDefaultValue
json
makeDbSchema
real
structSchemaForTable
table
text
namespaces
FromColumns
type-aliases
InsertRowDecoded
InsertRowEncoded
NullableColumnNames
RequiredInsertColumnNames
RequiredInsertColumns
RequiresInsertValues
RowDecoded
RowDecodedAll
RowEncoded
RowEncodedAll
RowEncodeNonNullable
FromTable
type-aliases
Columns
NullableColumnNames
RowDecoded
RowDecodedAll
RowEncoded
RowEncodeNonNullable
type-aliases
Index
AnyIfConstained
ColDefFn
ColumnDefinition
ColumnDefinitionInput
Columns
ConstraintColumns
DbSchema
DbSchemaFromInputSchema
DbSchemaInput
DefaultEncodedForColumnType
EmptyObjIfConstained
FieldColumnType
InsertStructSchemaForColumns
IsSingleColumn
NoDefault
SpecializedColDefFn
SqlDefaultValue
StructSchemaForColumns
TableDefinition
variables
NoDefault
State
namespaces
SQLite
functions
blob
boolean
clientDocument
clientOnly
column
datetime
defineEvent
defineFacts
defineMaterializer
integer
isColumnDefinition
json
makeState
materializers
rawSqlEvent
rawSqlMaterializer
real
synced
table
tableIsClientDocumentTable
text
namespaces
ClientDocumentTableDef
interfaces
Trait
type-aliases
Any
DefaultIdType
GetOptions
MakeGetQueryBuilder
SetEventDef
SetEventDefLike
SqliteDef
TableDefBase_
TraitAny
ClientDocumentTableOptions
type-aliases
Input
WithDefaults
EventDef
type-aliases
Any
AnyWithoutFn
FromColumns
type-aliases
InsertRowDecoded
NullableColumnNames
RequiredInsertColumnNames
RowDecoded
RowDecodedAll
RowEncoded
RowEncodeNonNullable
FromTable
type-aliases
Columns
NullableColumnNames
RowDecoded
RowDecodedAll
RowEncoded
RowEncodeNonNullable
TableDef
type-aliases
Any
type-aliases
ClientDocumentTableDef
ClientDocumentTableDefSymbol
ClientDocumentTableOptions
DefaultSqliteTableDef
DefaultSqliteTableDefConstrained
DefineEventOptions
EventDef
EventDefFact
EventDefFactInput
EventDefFacts
EventDefFactsGroup
EventDefFactsSnapshot
EventDefKey
EventDefMap
EventDefRecord
FactsCallback
InputState
Materializer
MaterializerResult
PrettifyFlat
RawSqlEvent
StateType
TableDef
TableDefBase
TableDefInternalsSymbol
TableOptions
TableOptionsInput
variables
ClientDocumentTableDefSymbol
TableDefInternalsSymbol
type-aliases
QueryBuilderAstSymbol
QueryBuilderTypeId
variables
QueryBuilderAstSymbol
QueryBuilderTypeId
SystemTables
functions
isStateSystemTable
type-aliases
EventlogMetaRow
LeaderMergeCounterRow
SchemaEventDefsMetaRow
SchemaMetaRow
SessionChangesetMetaRow
SyncStatusRow
variables
EVENTLOG_META_TABLE
eventlogMetaTable
eventlogSystemTables
LEADER_MERGE_COUNTER_TABLE
leaderMergeCounterTable
SCHEMA_EVENT_DEFS_META_TABLE
SCHEMA_META_TABLE
schemaEventDefsMetaTable
schemaMetaTable
SESSION_CHANGESET_META_TABLE
sessionChangesetMetaTable
stateSystemTables
SYNC_STATUS_TABLE
syncStatusTable
@livestore/livestore
type-aliases
Adapter
Bindable
BootStatus
DebugInfo
InputSchema
LiveStoreContext
LiveStoreContextRunning
LiveStoreSchema
LiveStoreSchemaSymbol
MutableDebugInfo
OtelOptions
PreparedBindValues
QueryBuilder
QueryBuilderAst
QueryDebugInfo
RefreshReason
SessionIdSymbol
ShutdownDeferred
StackFrame
StackInfo
variables
BootStatus
DebugInfo
LiveStoreSchemaSymbol
makeShutdownDeferred
MutableDebugInfo
PreparedBindValues
SessionIdSymbol
react
functions
LiveStoreContext
LiveStoreProvider
useClientDocument
useQuery
useQueryRef
useStackInfo
useStore
withReactApi
@livestore/react
type-aliases
Dispatch
ReactApi
SetStateAction
StateSetters
UseStateResult
sync-cf
cf-worker
mod
functions
makeDurableObject
makeWorker
interfaces
Env
type-aliases
CFWorker
MakeDurableObjectClass
MakeDurableObjectClassOptions
MakeWorkerOptions
variables
eventlogTable
PERSISTENCE_FORMAT_VERSION
PULL_CHUNK_SIZE
@livestore/sync-cf
sync-impl
mod
functions
makeCfSync
interfaces
WsSyncOptions
sync-electric
functions
makeElectricUrl
makeSyncBackend
syncBackendOptions
toTableName
interfaces
SyncBackendOptions
namespaces
ApiSchema
variables
ApiPayload
PullPayload
PushPayload
@livestore/sync-electric
variables
PERSISTENCE_FORMAT_VERSION
syncBackend
SyncMetadata
Contributing
Contributing
Docs
Monorepo
Docs
Examples
Version: latest
Version: 0.3.0-dev.33
GitHub
Discord
X
Select theme
Dark
Light
Auto
Electron Adapter
LiveStore doesn’t yet support Electron (see
this issue
for more details).
