prorm API Reference
    Preparing search index...

    Interface SearchResult<T>

    Result of a search() call.

    interface SearchResult<T = Record<string, unknown>> {
        hits: SearchHit<T>[];
        total: { value: number; relation: "eq" | "gte" };
        maxScore: number | null;
        tookMs: number;
        aggregations?: Record<string, unknown>;
    }

    Type Parameters

    • T = Record<string, unknown>
    Index
    hits total maxScore tookMs aggregations?
    hits: SearchHit<T>[]
    total: { value: number; relation: "eq" | "gte" }

    Total number of matching documents. relation is 'gte' when the exact count wasn't tracked.

    maxScore: number | null
    tookMs: number
    aggregations?: Record<string, unknown>

    Raw aggregation results, keyed by aggregation name, when aggs was requested.

    Settings
    Member Visibility

    On This Page
    Properties