ChemPare Documentation - v0.0.0
    Preparing search index...

    Interface ChemsaversSearchResponse

    Represents the response structure from the Typesense search API.

    Contains search results along with pagination information and request parameters. The response is structured as an array of result objects, each containing:

    • Facet counts for filtering
    • Total number of matching records
    • Paginated product hits
    • Search metadata and parameters
    interface ChemsaversSearchResponse {
        results: {
            fascet_counts: unknown[];
            found: number;
            hits: [{ document: ChemsaversProductObject }][];
            out_of: number;
            page: number;
            request_params: {
                collection_name: string;
                first_q: string;
                per_page: number;
                q: string;
            };
        }[];
    }
    Index

    Properties

    results

    Properties

    results: {
        fascet_counts: unknown[];
        found: number;
        hits: [{ document: ChemsaversProductObject }][];
        out_of: number;
        page: number;
        request_params: {
            collection_name: string;
            first_q: string;
            per_page: number;
            q: string;
        };
    }[]

    Array of search result objects

    Type declaration

    • fascet_counts: unknown[]

      Facet groupings for result filtering

    • found: number

      Total number of matching records

    • hits: [{ document: ChemsaversProductObject }][]

      Array of product hits, each containing a ProductObject

    • out_of: number

      Total number of records searched

    • page: number

      Current page number

    • request_params: { collection_name: string; first_q: string; per_page: number; q: string }

      Original search request parameters

      • collection_name: string

        Name of the Typesense collection searched

      • first_q: string

        Initial search query

      • per_page: number

        Number of results per page

      • q: string

        Actual search query used

    Settings

    Member Visibility

    On This Page

    Properties