Skip to content

LiveStore (0.3.0)

Docs API Examples

GitHub Discord X Bluesky

Select theme

Docs
API
Examples

API Reference
@livestore/livestore
- @livestore
  - namespaces
    
    EventDef
    
    type-aliases
    
    Any
    AnyWithoutFn
    
    EventSequenceNumber
    
    type-aliases
    
    ClientEventSequenceNumber
    EventSequenceNumber
    EventSequenceNumberPair
    GlobalEventSequenceNumber
    
    variables
    
    clientDefault
    ClientEventSequenceNumber
    compare
    diff
    EventSequenceNumber
    fromString
    globalEventSequenceNumber
    GlobalEventSequenceNumber
    isEqual
    isGreaterThan
    isGreaterThanOrEqual
    localEventSequenceNumber
    make
    max
    nextPair
    ROOT
    toString
    
    FromInputSchema
    
    type-aliases
    
    DeriveSchema
    
    LiveQuery
    
    type-aliases
    
    Any
    
    LiveQueryDef
    
    type-aliases
    
    Any
    
    LiveStoreEvent
    
    classes
    
    EncodedWithMeta
    
    namespaces
    
    ForEventDef
    
    type-aliases
    
    Decoded
    Encoded
    PartialDecoded
    PartialEncoded
    
    type-aliases
    
    AnyDecoded
    AnyEncoded
    AnyEncodedGlobal
    EventDefPartialSchema
    ForEventDefRecord
    ForSchema
    PartialAnyDecoded
    PartialAnyEncoded
    PartialForSchema
    
    variables
    
    AnyDecoded
    AnyEncoded
    AnyEncodedGlobal
    isEqualEncoded
    isPartialEventDef
    makeEventDefPartialSchema
    makeEventDefSchema
    makeEventDefSchemaMemo
    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
    
    ArrayEnsure
    asSchema
    Chunk
    filter
    HashSet
    head
    headNonEmpty
    List
    Literal
    make
    NonEmptyArrayEnsure
    NonEmptyChunk
    Option
    OptionFromNullishOr
    OptionFromNullOr
    OptionFromUndefinedOr
    parseNumber
    ReadonlyMap
    ReadonlySet
    Redacted
    SortedSet
    Struct
    transformLiteral
    transformLiterals
    Tuple
    Union
    
    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
    
    annotations
    asSerializable
    asSerializableWithResult
    asserts
    asWithResult
    attachPropertySignature
    Base64FromUint8Array
    between
    betweenBigDecimal
    BetweenBigDecimalSchemaId
    betweenBigInt
    BetweenBigIntSchemaId
    betweenDate
    BetweenDateSchemaId
    betweenDuration
    BetweenDurationSchemaId
    BetweenSchemaId
    brand
    BrandSchemaId
    capitalized
    CapitalizedSchemaId
    Cause
    CauseFromSelf
    ChunkFromSelf
    clamp
    clampBigDecimal
    clampBigInt
    clampDuration
    Class
    compose
    Config
    Data
    DataFromSelf
    DateFromSelfSchemaId
    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
    EndsWithSchemaId
    Enums
    equivalence
    Exit
    ExitFromSelf
    exitSchema
    extend
    failureSchema
    filterEffect
    finite
    FiniteSchemaId
    format
    fromBrand
    fromKey
    getNumberIndexedAccess
    greaterThan
    greaterThanBigDecimal
    GreaterThanBigDecimalSchemaId
    greaterThanBigInt
    GreaterThanBigIntSchemaId
    greaterThanDate
    GreaterThanDateSchemaId
    greaterThanDuration
    GreaterThanDurationSchemaId
    greaterThanOrEqualTo
    greaterThanOrEqualToBigDecimal
    GreaterThanOrEqualToBigDecimalSchemaId
    greaterThanOrEqualToBigInt
    GreaterThanOrEqualToBigIntSchemaId
    greaterThanOrEqualToDate
    GreaterThanOrEqualToDateSchemaId
    greaterThanOrEqualToDuration
    GreaterThanOrEqualToDurationSchemaId
    GreaterThanOrEqualToSchemaId
    GreaterThanSchemaId
    hash
    HashMap
    HashMapFromSelf
    HashSetFromSelf
    headOrElse
    includes
    IncludesSchemaId
    instanceOf
    InstanceOfSchemaId
    int
    IntSchemaId
    is
    isPropertySignature
    isSchema
    itemsCount
    ItemsCountSchemaId
    JsonNumberSchemaId
    JsonValue
    keyof
    length
    LengthSchemaId
    lessThan
    lessThanBigDecimal
    LessThanBigDecimalSchemaId
    lessThanBigInt
    LessThanBigIntSchemaId
    lessThanDate
    LessThanDateSchemaId
    lessThanDuration
    LessThanDurationSchemaId
    lessThanOrEqualTo
    lessThanOrEqualToBigDecimal
    LessThanOrEqualToBigDecimalSchemaId
    lessThanOrEqualToBigInt
    LessThanOrEqualToBigIntSchemaId
    lessThanOrEqualToDate
    LessThanOrEqualToDateSchemaId
    lessThanOrEqualToDuration
    LessThanOrEqualToDurationSchemaId
    LessThanOrEqualToSchemaId
    LessThanSchemaId
    ListFromSelf
    lowercased
    LowercasedSchemaId
    makePropertySignature
    MapFromRecord
    MapFromSelf
    maxItems
    MaxItemsSchemaId
    maxLength
    MaxLengthSchemaId
    minItems
    MinItemsSchemaId
    minLength
    MinLengthSchemaId
    MsgPack
    multipleOf
    MultipleOfSchemaId
    mutable
    negative
    negativeBigDecimal
    NegativeBigDecimalFromSelf
    NegativeBigDecimalSchemaId
    negativeBigInt
    NegativeBigInt
    NegativeBigIntFromSelf
    NonEmptyArray
    NonEmptyChunkFromSelf
    nonEmptyString
    nonNaN
    NonNaNSchemaId
    nonNegative
    nonNegativeBigDecimal
    NonNegativeBigDecimalFromSelf
    NonNegativeBigDecimalSchemaId
    nonNegativeBigInt
    NonNegativeBigInt
    NonNegativeBigIntFromSelf
    NonNegativeInt
    nonPositive
    nonPositiveBigDecimal
    NonPositiveBigDecimalFromSelf
    NonPositiveBigDecimalSchemaId
    nonPositiveBigInt
    NonPositiveBigInt
    NonPositiveBigIntFromSelf
    NullishOr
    NullOr
    omit
    optional
    optionalElement
    optionalToOptional
    optionalToRequired
    optionalWith
    OptionFromSelf
    parseJson
    partial
    partialWith
    pattern
    PatternSchemaId
    pick
    pickLiteral
    pluck
    positive
    positiveBigDecimal
    PositiveBigDecimalFromSelf
    PositiveBigDecimalSchemaId
    positiveBigInt
    PositiveBigInt
    PositiveBigIntFromSelf
    propertySignature
    PropertySignatureTypeId
    ReadonlyMapFromRecord
    ReadonlyMapFromSelf
    ReadonlySetFromSelf
    Record
    RedactedFromSelf
    RefineSchemaId
    rename
    required
    requiredToOptional
    serializableSchema
    serialize
    serializeExit
    serializeFailure
    serializeSuccess
    SetFromSelf
    SortedSetFromSelf
    split
    standardSchemaV1
    startsWith
    StartsWithSchemaId
    StringFromBase64
    StringFromBase64Url
    StringFromHex
    StringFromUriComponent
    successSchema
    suspend
    swap
    symbolSerializable
    symbolWithResult
    tag
    TaggedClass
    TaggedError
    TaggedRequest
    TaggedStruct
    TemplateLiteral
    TemplateLiteralParser
    transform
    transformOrFail
    trimmed
    TrimmedSchemaId
    TypeId
    typeSchema
    Uint8ArrayFromBase64
    Uint8ArrayFromBase64Url
    Uint8ArrayFromHex
    ULIDSchemaId
    uncapitalized
    UncapitalizedSchemaId
    UndefinedOr
    UniqueSymbolFromSelf
    uppercased
    UppercasedSchemaId
    UUIDSchemaId
    validate
    validateEither
    validateOption
    validatePromise
    validateSync
    validDate
    ValidDateSchemaId
    withConstructorDefault
    withDecodingDefault
    withDefaults
    
    SqliteAst
    
    namespaces
    
    ColumnType
    
    type-aliases
    
    Blob
    ColumnType
    Integer
    Null
    Real
    Text
    
    type-aliases
    
    Index
    Column
    DbSchema
    ForeignKey
    Table
    
    variables
    
    index
    column
    dbSchema
    hash
    structSchemaForTable
    table
    
    SqliteDsl
    
    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
    
    blob
    boolean
    column
    datetime
    datetimeInteger
    defaultSchemaForColumnType
    insertStructSchemaForTable
    integer
    isColumnDefinition
    isSqlDefaultValue
    json
    makeDbSchema
    NoDefault
    real
    structSchemaForTable
    table
    text
    
    State
    
    namespaces
    
    SQLite
    
    namespaces
    
    ClientDocumentTableDef
    
    interfaces
    
    Trait
    
    type-aliases
    
    Any
    DefaultIdType
    GetOptions
    MakeGetQueryBuilder
    SetEventDef
    SetEventDefLike
    SqliteDef
    TableDefBase_
    TraitAny
    
    ClientDocumentTableOptions
    
    type-aliases
    
    Input
    WithDefaults
    
    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
    InputState
    PrettifyFlat
    StateType
    TableDef
    TableDefBase
    TableDefInternalsSymbol
    TableOptions
    TableOptionsInput
    
    variables
    
    blob
    boolean
    clientDocument
    ClientDocumentTableDefSymbol
    column
    datetime
    integer
    isColumnDefinition
    json
    makeState
    real
    table
    TableDefInternalsSymbol
    tableIsClientDocumentTable
    text
    
    type-aliases
    
    QueryBuilderAstSymbol
    QueryBuilderTypeId
    
    variables
    
    QueryBuilderAstSymbol
    QueryBuilderTypeId
    
    SystemTables
    
    type-aliases
    
    EventlogMetaRow
    LeaderMergeCounterRow
    SchemaEventDefsMetaRow
    SchemaMetaRow
    SessionChangesetMetaRow
    SyncStatusRow
    
    variables
    
    EVENTLOG_META_TABLE
    eventlogMetaTable
    eventlogSystemTables
    isStateSystemTable
    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
- classes
- functions
- interfaces
- @livestore/livestore
- type-aliases
- variables
@livestore/react
- functions
- @livestore/react
- type-aliases
- variables
  - LiveStoreContext
  - useClientDocument
Adapters
- @livestore/adapter-web
  - @livestore
    
    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
  - functions
    
    makeInMemoryAdapter
    makePersistedAdapter
  - @livestore/adapter-web
  - type-aliases
    
    WebAdapterOptions
- @livestore/adapter-node
  - functions
    
    makeAdapter
    makeWorkerAdapter
  - @livestore/adapter-node
- @livestore/adapter-expo
  - functions
    
    makePersistedAdapter
  - @livestore/adapter-expo
  - type-aliases
    
    MakeDbOptions
Syncing
- @livestore/sync-cf
  - cf-worker
    
    mod
    
    functions
    
    handleWebSocket
    makeWorker
    
    interfaces
    
    Env
    
    type-aliases
    
    CFWorker
    MakeDurableObjectClass
    MakeDurableObjectClassOptions
    MakeWorkerOptions
    
    variables
    
    eventlogTable
    makeDurableObject
    PERSISTENCE_FORMAT_VERSION
    PULL_CHUNK_SIZE
  - @livestore/sync-cf
  - sync-impl
    
    mod
    
    functions
    
    makeCfSync
    
    interfaces
    
    WsSyncOptions
- @livestore/sync-electric
  - @livestore
    
    namespaces
    
    ApiSchema
    
    variables
    
    ApiPayload
    PullPayload
    PushPayload
  - functions
    
    makeElectricUrl
    makeSyncBackend
    syncBackendOptions
    toTableName
  - interfaces
    
    SyncBackendOptions
  - @livestore/sync-electric
  - variables
    
    PERSISTENCE_FORMAT_VERSION
    syncBackend
    SyncMetadata

Docs API Examples

GitHub Discord X Bluesky

Select theme

On this page

Overview
Returns

On this page

Overview
Returns

useStackInfo

useStackInfo(): StackInfo

Defined in: utils/stack-info.ts:6

Returns

Section titled “Returns”

StackInfo