This is the documentation of version 1.0.0-rc.4. Go to the latest version, 1.0.0-rc.5.
TomTom Maps for JavaScript
    Preparing search index...

    Type Alias SearchIndexType

    SearchIndexType: "Geo" | "PAD" | "Addr" | "Str" | "XStr" | "POI"

    An index, which is the category of place data to include in search results.

    Each index type returns a different kind of location information.

    The index types are:

    • Geo: Geographic entities (countries, states, cities, neighborhoods)
    • PAD: Point Address - Specific street addresses with building numbers
    • Addr: Address Range - Street segments with address ranges
    • Str: Street names without specific addresses
    • XStr: Cross Streets - Intersections of two streets
    • POI: Points of Interest (businesses, landmarks, facilities)

    By default, extendedPostalCodesFor includes extended postal codes for all indexes except Geo. Use this type to request them explicitly for specific indexes.

    // Request extended postal codes for addresses and POIs
    const indexes: SearchIndexType[] = ['PAD', 'Addr', 'POI'];