Type Alias SearchIndexType

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

Index representing the type of place data to search.

Specifies which category of place data to include in search results. Different index types return different kinds of location information.

Remarks

Index Types:

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)

Use with extendedPostalCodesFor: By default, extended postal codes are included for all indexes except Geo. Use this type to explicitly request extended postal codes for specific indexes.

Example

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

Type Alias SearchIndexType

Remarks

Example

Settings