Class Country

Class representing the model of a "Country" response *

Hierarchy

Constructors

constructor

Properties

continent? country? maxmind? registeredCountry? representedCountry? traits

Methods

setBooleanRegisteredCountry setBooleanTraits

Constructors

constructor

  • new Country(response, ipAddress?, network?): Country

  • Instantiates a "Country" using fields from the response

    Parameters

    • response: CountryResponse

      The GeoIP2 response

    • Optional ipAddress: string
    • Optional network: string

    Returns Country

Properties

Optional Readonly continent

continent?: ContinentRecord

The continent for the requested IP address.

Optional Readonly country

country?: CountryRecord

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

Optional Readonly maxmind

maxmind?: MaxMindRecord

The MaxMind record containing data related to your account.

Optional Readonly registeredCountry

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.

Optional Readonly representedCountry

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.

Readonly traits

traits: TraitsRecord

The traits for the requested IP address.

Methods

Private setBooleanRegisteredCountry

Private setBooleanTraits

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc