Class WebServiceClient

Class representing the WebServiceClient *

Index

Constructors

Properties

accountID host licenseKey timeout

Methods

city country handleError insights responseFor

Constructors

constructor

new WebServiceClient(accountID, licenseKey, options?): WebServiceClient
Instantiates a WebServiceClient
Parameters
- accountID: string
  The account ID
- licenseKey: string
  The license key
- Optional options: number | Options
  Additional option to use when connecting to the web service. If you pass a number as the third parameter, it will be treated as the timeout; however, passing in a number should be considered deprecated and may be removed in a future major version.
Returns WebServiceClient
- Defined in src/webServiceClient.ts:48

Properties

`Private` accountID

accountID: string

`Private` host

host: string = 'geoip.maxmind.com'

`Private` licenseKey

licenseKey: string

`Private` timeout

timeout: number = 3000

Methods

city

city(ipAddress): Promise<City>
Returns a Promise with the City Plus data for an IP address.
Parameters
- ipAddress: string
  The IP Address you want to query the City Plus web service with
Returns Promise<City>
- Defined in src/webServiceClient.ts:81

country

country(ipAddress): Promise<Country>
Returns a Promise with the Country data for an IP address.
Parameters
- ipAddress: string
  The IP Address you want to query the Country web service with
Returns Promise<Country>
- Defined in src/webServiceClient.ts:90

`Private` handleError

handleError(data, response, url): WebServiceClientError
Parameters
- data: ResponseError
- response: IncomingMessage
- url: string
Returns WebServiceClientError
- Defined in src/webServiceClient.ts:179

insights

insights(ipAddress): Promise<Insights>
Returns a Promise with the Insights data for an IP address.

Insights is only supported by the GeoIP2 web service. It is not supported by the GeoLite2 web service.
Parameters
- ipAddress: string
  The IP Address you want to query the Insights web service with
Returns Promise<Insights>
- Defined in src/webServiceClient.ts:106

`Private` responseFor

responseFor<T>(path, ipAddress, modelClass): Promise<T>
Type Parameters
- T
Parameters
- path: servicePath
- ipAddress: string
- modelClass: any
Returns Promise<T>
- Defined in src/webServiceClient.ts:114

Generated using TypeDoc