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

    Interface AddressSearcherOptions

    An AddressSearcherOptions stores a set of parameters that will be sent to searchAddresses API.

    interface AddressSearcherOptions {
        facet?: string;
        limit?: number;
        offset?: number;
        q?: string;
        t?: string;
        version?: string;
    }
    Index

    Properties

    facet? limit? offset? q? t? version?

    Properties

    facet?: string

    The facet representation at which level the resulting facets will be shapen.

    Example: "/東京都"

    limit?: number

    The maximum number of items that you want to retrieve.

    Defaults to 100 unless specified.

    offset?: number

    The offset from which you want to retrieve the result.

    q?: string

    The query to search against the address database.

    Either q or t must be present.

    Example: "東京都 AND 渋谷区"

    t?: string

    The unprocessed portions of the address string to search against the address database.

    Either q or t must be present.

    Example: "東京都渋谷区初台"

    version?: string

    The version of which the database is searched against.

    Defaults to the latest available version.

    Example: "2021-04-30"

    Settings

    Member Visibility

    On This Page

    Properties