Cuttlefish SDK Reference - v0.1.0
    Preparing search index...

    Module @cuttlefish-sync/core

    @cuttlefish-sync/core

    Core Cuttlefish client functionality - live queries, row cache, and query evaluator.

    npm install @cuttlefish-sync/core
    
    import { version } from '@cuttlefish-sync/core'

    console.log(version)

    The core package ships with a fixture-based suite that mirrors the Elixir query-plan tests.

    # from the repository root
    npm test

    Export the fixtures from the Elixir app before running the suite:

    mix cf.query_plan.export_test_cases
    

    Classes

    LiveQuery
    RowCache

    Interfaces

    AggregateFunctionNode
    AliasNode
    AndNode
    BinaryOperationNode
    ColumnNode
    ColumnSchema
    FunctionNode
    IdentifierNode
    JoinNode
    LiveQueryOptions
    NormalizedListResult
    OperatorNode
    OrderByItemNode
    OrNode
    ParameterRef
    ParensNode
    PrimitiveValueListNode
    RawNode
    ReferenceNode
    Row
    SelectionNode
    SelectModifierNode
    SelectQueryNode
    TableNode
    TableSchema
    ValidationError
    ValidationResult
    ValueListNode
    ValueNode
    WhereNode
    WindowDef

    Type Aliases

    AggregateFilterNode
    AggregateFunctionNode
    AggregateOrderNode
    AggregateWithinGroupNode
    AggregateWithOptionsNode
    AliasNode
    AndNode
    BinaryOperationNode
    CapabilityFlag
    ColumnAliasNode
    ColumnNode
    DeleteChange
    DistinctAggregateNode
    FunctionNode
    IdentifierNode
    InsertChange
    JoinNode
    JSType
    LateralFunctionNode
    LateralJoinNode
    LiveQueryState
    NullifNode
    OperationNode
    OperatorNode
    OrderByItemNode
    OrdinalityNode
    OrNode
    ParensNode
    PatternOperator
    PrimitiveValueListNode
    RawNode
    ReferenceNode
    RowsFromNode
    RowsPatch
    RuntimeColumnSchema
    RuntimeTableSchema
    SelectionNode
    SelectModifierNode
    SelectQueryNode
    SnapshotMessage
    TableNode
    UpdateChange
    ValueListNode
    ValueNode
    WhereNode
    WindowFunctionNode

    Variables

    CAPABILITIES
    CAPABILITY_ERRORS
    PATTERN_OPERATOR_UNSUPPORTED_MESSAGE

    Functions

    coerceParams
    convertRowTypes
    convertValue
    createLiveQuery
    createParameterRef
    describeRuntimeType
    evaluateQuery
    evaluateTruth
    getParameterIndex
    isParameterRef
    isSupported
    normalizeList
    normalizePatternOperator
    patternOperatorFromSql
    patternOperatorToSql
    resolveParameter
    resolveParameterByIndex
    resolveValueOrParameter
    toRuntimeColumnSchema
    toRuntimeTableSchema
    validateAST