@kubator/sdk v0.0.1
    Preparing search index...

    Type Alias IndexOptions<T>

    Optional settings for an expression-based collection index.

    type IndexOptions<T extends object> = {
        concurrently?: boolean;
        include?: (item: T) => unknown;
        snapshot?: boolean;
        type?: IndexType;
        where?: (item: T) => boolean;
    }

    Type Parameters

    • T extends object
    Index
    concurrently? include? snapshot? type? where?
    concurrently?: boolean

    Creates the index without blocking concurrent writers when supported.

    include?: (item: T) => unknown

    Additional document values to store in the index.

    snapshot?: boolean

    Includes the generated index definition in test snapshots.

    type?: IndexType

    Index implementation to use.

    where?: (item: T) => boolean

    Restricts the index to documents matching this predicate.

    Settings
    Member Visibility

    On This Page
    Properties