Skip to content

LiveStore (0.4.0-dev.22)

GitHub Discord X Bluesky

Select theme

Docs
API
Examples

API reference
@livestore/livestore
- @livestore
  - namespaces
    
    EventDef
    
    type-aliases
    
    Any
    AnyWithoutFn
    
    EventSequenceNumber
    
    namespaces
    
    Client
    
    type-aliases
    
    Composite
    CompositeInput
    CompositePair
    Type
    
    variables
    
    compare
    Composite
    DEFAULT
    diff
    fromGlobal
    fromString
    isEqual
    isGreaterThan
    isGreaterThanOrEqual
    make
    max
    nextPair
    REBASE_GENERATION_DEFAULT
    ROOT
    Schema
    toString
    
    Global
    
    type-aliases
    
    Type
    
    variables
    
    make
    Schema
    
    FromInputSchema
    
    type-aliases
    
    DeriveSchema
    
    LiveQuery
    
    type-aliases
    
    Any
    
    LiveQueryDef
    
    type-aliases
    
    Any
    
    LiveStoreEvent
    
    namespaces
    
    Client
    
    classes
    
    EncodedWithMeta
    
    type-aliases
    
    Decoded
    Encoded
    ForSchema
    
    variables
    
    Decoded
    Encoded
    isEqualEncoded
    makeSchema
    makeSchemaMemo
    
    ForEventDef
    
    type-aliases
    
    Decoded
    Encoded
    ForRecord
    InputDecoded
    InputEncoded
    
    Global
    
    type-aliases
    
    Encoded
    
    variables
    
    Encoded
    toClientEncoded
    
    Input
    
    type-aliases
    
    Decoded
    Encoded
    ForRecord
    ForSchema
    
    variables
    
    Encoded
    makeSchema
    
    LiveStoreSchema
    
    type-aliases
    
    Any
    
    Queryable
    
    type-aliases
    
    Result
    
    QueryBuilder
    
    namespaces
    
    WhereOps
    
    type-aliases
    
    Equality
    In
    JsonArray
    Like
    MultiValue
    Order
    SingleValue
    
    type-aliases
    
    Any
    ApiFeature
    ApiFull
    FirstQueryBehaviour
    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
    
    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
    
    ColumnDefinition
    
    type-aliases
    
    Any
    
    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
    ColumnDefaultThunk
    ColumnDefaultValue
    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
    isDefaultThunk
    isSqlDefaultValue
    json
    makeDbSchema
    NoDefault
    real
    resolveColumnDefault
    structSchemaForTable
    table
    text
    
    State
    
    namespaces
    
    SQLite
    
    functions
    
    table
    
    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
    
    SchemaToColumns
    
    type-aliases
    
    ColumnDefForType
    FromTypes
    
    TableDef
    
    type-aliases
    
    Any
    
    TableDefInput
    
    type-aliases
    
    ForColumns
    ForSchema
    
    type-aliases
    
    ClientDocumentTableDef
    ClientDocumentTableDefSymbol
    ClientDocumentTableOptions
    DefaultSqliteTableDef
    DefaultSqliteTableDefConstrained
    InputState
    PrettifyFlat
    SqliteTableDefForInput
    SqliteTableDefForSchemaInput
    StateType
    TableDef
    TableDefBase
    TableDefInternalsSymbol
    TableOptions
    TableOptionsInput
    ToColumns
    WithDefaults
    
    variables
    
    AutoIncrement
    blob
    boolean
    clientDocument
    ClientDocumentTableDefSymbol
    column
    ColumnType
    createOptimisticEventSchema
    datetime
    Default
    getColumnDefForSchema
    integer
    isColumnDefinition
    json
    makeColumnSpec
    makeState
    PrimaryKeyId
    real
    TableDefInternalsSymbol
    tableIsClientDocumentTable
    text
    Unique
    withAutoIncrement
    withColumnType
    withDefault
    withPrimaryKey
    withUnique
    
    type-aliases
    
    QueryBuilderAstSymbol
    QueryBuilderTypeId
    
    variables
    
    QueryBuilderAstSymbol
    QueryBuilderTypeId
    
    SyncState
    
    classes
    
    MergeContext
    MergeResult
    MergeResultAdvance
    MergeResultRebase
    MergeResultReject
    Payload
    PayloadLocalPush
    PayloadUpstream
    PayloadUpstreamAdvance
    PayloadUpstreamRebase
    SyncState
    
    variables
    
    findDivergencePoint
    merge
    payloadFromMergeResult
    
    SystemTables
    
    type-aliases
    
    EventlogMetaRow
    SchemaEventDefsMetaRow
    SchemaMetaRow
    SessionChangesetMetaRow
    SyncStatusRow
    
    variables
    
    EVENTLOG_META_TABLE
    eventlogMetaTable
    eventlogSystemTables
    isStateSystemTable
    SCHEMA_EVENT_DEFS_META_TABLE
    SCHEMA_META_TABLE
    schemaEventDefsMetaTable
    schemaMetaTable
    SESSION_CHANGESET_META_TABLE
    sessionChangesetMetaTable
    stateSystemTables
    SYNC_STATUS_TABLE
    syncStatusTable
    
    UnknownEvents
    
    type-aliases
    
    Callback
    HandlingConfig
    HandlingStrategy
    Reason
    ResolveContext
    Resolved
- classes
- functions
- interfaces
- @livestore/livestore
- type-aliases
- variables
@livestore/react
- classes
  - StoreRegistry
- functions
- @livestore/react
- type-aliases
- variables
Adapters
- @livestore/adapter-web
- @livestore/adapter-node
  - functions
    
    makeAdapter
    makeWorkerAdapter
  - @livestore/adapter-node
- @livestore/adapter-expo
  - functions
    
    makePersistedAdapter
  - @livestore/adapter-expo
  - type-aliases
    
    MakeDbOptions
Syncing
- @livestore/sync-cf
- @livestore/sync-electric
  - @livestore
    
    namespaces
    
    ApiSchema
    
    variables
    
    ApiPayload
    ArgsSchema
    PullPayload
    PushPayload
  - classes
    
    InvalidOperationError
  - functions
    
    makeElectricUrl
    makeSyncBackend
    syncBackendOptions
    toTableName
  - interfaces
    
    SyncBackendOptions
  - @livestore/sync-electric
  - type-aliases
    
    SyncMetadata
  - variables
    
    PERSISTENCE_FORMAT_VERSION
    SyncMetadata

GitHub Discord X Bluesky

Select theme

On this page

Overview

On this page

Overview

StorageTypeEncoded

StorageTypeEncoded = typeof StorageType.Encoded

Defined in: packages/@livestore/adapter-web/src/web-worker/common/worker-schema.ts:42