Class representing the model of a "City" response *

Hierarchy

Constructors

  • Instantiates a "City" using fields from the response

    Parameters

    • response: CityResponse

      The GeoIP2 response

    • Optional ipAddress: string
    • Optional network: string

    Returns City

Properties

city?: CityRecord

The city for the requested IP address.

continent?: ContinentRecord

The continent for the requested IP address.

country?: CountryRecord

The country for the requested IP address. This object represents the country where MaxMind believes the end user is located.

location?: LocationRecord

The location for the requested IP address.

maxmind?: MaxMindRecord

The MaxMind record containing data related to your account.

postal?: PostalRecord

The postal object for the requested IP address.

registeredCountry?: RegisteredCountryRecord

The registered country record for the requested IP address. This record represents the country where the ISP has registered a given IP block and may differ from the user's country.

representedCountry?: RepresentedCountryRecord

The represented country record for the requested IP address. The represented country is used for things like military bases or embassies. It is only present when the represented country differs from the country.

subdivisions?: SubdivisionsRecord[]

An array of SubdivisionsRecord objects representing the country subdivisions for the requested IP address. The number and type of subdivisions varies by country, but a subdivision is typically a state, province, county, etc. Subdivisions are ordered from most general (largest) to most specific (smallest). If the response did not contain any subdivisions, this method returns an empty array.

traits: TraitsRecord

The traits for the requested IP address.

Generated using TypeDoc