prorm API Reference
    Preparing search index...

    Interface SearchParams

    Parameters accepted by search().

    interface SearchParams {
        query?: QueryDslQueryContainer;
        from?: number;
        size?: number;
        sort?: Sort;
        aggs?: Record<string, AggregationsAggregationContainer>;
        source?: string | boolean | string[];
        trackTotalHits?: number | boolean;
    }
    Index
    query?: QueryDslQueryContainer

    Query DSL query (match/term/bool/range/etc.). Omit to match all documents.

    from?: number

    Zero-based offset into the result set, for pagination.

    size?: number

    Max number of hits to return.

    sort?: Sort

    Sort order - a field name, { field: 'asc' | 'desc' }, or the driver's raw Sort shape.

    aggs?: Record<string, AggregationsAggregationContainer>

    Named aggregations to compute alongside the search.

    source?: string | boolean | string[]

    Restrict/exclude which _source fields are returned.

    trackTotalHits?: number | boolean

    Track the exact total hit count (rather than capping at 10,000).