@ken-all/kenall
    Preparing search index...

    Interface AddressSearcherResponse

    An AddressSearcherResponse describes a response to searchAddresses API call.

    interface AddressSearcherResponse {
        count: number;
        data: v20221101.Address[];
        facets: v20221101.Facet[] | null;
        limit: number;
        offset: number;
        query: v20221101.AddressSearcherQuery;
        version: string;
    }

    Hierarchy (View Summary)

    Index

    Properties

    count: number

    The number of the resulting items in total.

    The set of the data that match to the query.

    facets: v20221101.Facet[] | null

    The facets of the result that form with the query.

    If no facet is given, those will be unavailable and this stores null.

    limit: number

    The number of items that have been intended, at most, to retrieve from the result.

    offset: number

    The offset from which the result has been retrieved.

    The query that the search has been performed for.

    version: string

    The version of the data, in the form of "YYYY-MM-DD" where Y, M, and D represent digits of the year, month, and day the source data became available.