This is the documentation of version 1.0.0-rc.0. Go to the latest version, 1.0.0-rc.5.

Type Alias GeographyType

GeographyType: typeof geographyTypes[number]

The hierarchical level of an administrative area or postal region.

Remarks

The levels, from largest to smallest:

Country: Sovereign nation
CountrySubdivision: State, province, or first-level admin division
CountrySecondarySubdivision: County or second-level admin division
CountryTertiarySubdivision: Third-level admin division
Municipality: City or town
MunicipalitySubdivision: District within a city
Neighbourhood: Named neighborhood or area within a city
PostalCodeArea: Area defined by postal/ZIP code

Example

const geographyType: GeographyType = 'Municipality';  // City level