gespenst API - v0.1.0
    Preparing search index...

    Interface SearchResult

    Search summary and active match without an unbounded public result array.

    interface SearchResult {
        activeIndex: number;
        activeMatch: SearchMatch | null;
        error: string | null;
        matchCount: number | null;
        options: Readonly<Required<SearchOptions>>;
        query: string;
        status: SearchStatus;
    }
    Index
    activeIndex activeMatch error matchCount options query status
    activeIndex: number

    Zero-based active match index, or -1.

    activeMatch: SearchMatch | null

    Materialized active match, or null.

    error: string | null

    Validation or buffer-read failure, or null.

    matchCount: number | null

    Total matches after completion, or null while searching.

    options: Readonly<Required<SearchOptions>>

    Fully normalized options represented by this result.

    query: string

    Query represented by this result.

    status: SearchStatus

    Current search lifecycle.

    Settings
    Member Visibility

    On This Page
    Properties