@maschinenlesbar.org/deutsche-digitale-bibliothek-cli
    Preparing search index...

    Interface SearchParams

    Options for a v2 search request. These map onto native Solr query parameters (q, rows, start, sort, fq, fl, facet*) — the endpoint is a Solr passthrough, so the values use Solr syntax.

    interface SearchParams {
        collection?: string;
        facetFields?: string[];
        facetLimit?: number;
        fields?: string;
        filters?: string[];
        query: string;
        requestHandler?: string;
        rows?: number;
        sort?: string;
        start?: number;
    }
    Index
    collection? facetFields? facetLimit? fields? filters? query requestHandler? rows? sort? start?
    collection?: string

    Solr collection to query. Defaults to search.

    facetFields?: string[]

    Facet fields to compute counts for (facet.field; enables facet=true).

    facetLimit?: number

    Cap the number of values returned per facet (facet.limit); -1 = every value, still sorted by count (the client sends facet.sort=count for it).

    fields?: string

    Field list to return, e.g. id,title (fl).

    filters?: string[]

    Filter queries in Solr syntax, e.g. type_fct:mediatype_002 (fq, repeatable).

    query: string

    The Solr query (q). Use *:* to match everything.

    requestHandler?: string

    Solr request handler. Defaults to select. Only handlers that return Solr's standard response envelope (numFound and docs) are supported; any other answer makes search() reject with a DdbParseError naming the handler.

    rows?: number

    Number of documents to return (rows). Defaults to DEFAULT_SEARCH_ROWS (10).

    sort?: string

    Sort spec in Solr syntax, e.g. score desc, id asc (sort).

    start?: number

    Offset of the first returned document (start), for paging.

    Settings
    Member Visibility

    On This Page
    Properties