lsync API
    Preparing search index...

    Type Alias CollectionOptions<T, TKey, TSchema>

    CollectionOptions: {
        autoIndex?: BaseCollectionConfig<T, TKey, TSchema>["autoIndex"];
        collection: string;
        defaultIndexType?: BaseCollectionConfig<T, TKey, TSchema>["defaultIndexType"];
        gcTime?: BaseCollectionConfig<T, TKey, TSchema>["gcTime"];
        getKey: (item: T) => TKey;
        id?: string;
        ignoreOwnUpdates?: boolean;
        maxSyncRows?: number | false;
        offline?: boolean | IndexedDBOfflineOptions;
        read?: false | Omit<ReadQuery, "collection">;
        schema?: TSchema;
        startSync?: BaseCollectionConfig<T, TKey, TSchema>["startSync"];
        syncMode?: BaseCollectionConfig<T, TKey, TSchema>["syncMode"];
    } & CollectionConnectionOptions

    Type Parameters

    • T extends object
    • TKey extends string | number
    • TSchema extends StandardSchemaV1 = never

    Type Declaration

    • OptionalautoIndex?: BaseCollectionConfig<T, TKey, TSchema>["autoIndex"]
    • collection: string
    • OptionaldefaultIndexType?: BaseCollectionConfig<T, TKey, TSchema>["defaultIndexType"]
    • OptionalgcTime?: BaseCollectionConfig<T, TKey, TSchema>["gcTime"]
    • getKey: (item: T) => TKey
    • Optionalid?: string
    • OptionalignoreOwnUpdates?: boolean
    • OptionalmaxSyncRows?: number | false
    • Optionaloffline?: boolean | IndexedDBOfflineOptions

      Hydrate this eager collection from IndexedDB before connecting to the server.

    • Optionalread?: false | Omit<ReadQuery, "collection">
    • Optionalschema?: TSchema
    • OptionalstartSync?: BaseCollectionConfig<T, TKey, TSchema>["startSync"]
    • OptionalsyncMode?: BaseCollectionConfig<T, TKey, TSchema>["syncMode"]

    Settings
    Member Visibility