Class WebServiceClient

Class representing the WebServiceClient *

Index

Constructors

Methods

city country insights

Constructors

constructor

new WebServiceClient(
    accountID: string,
    licenseKey: string,
    options?: number | Options,
): WebServiceClient
Instantiates a WebServiceClient
Parameters
- accountID: string
  The account ID
- licenseKey: string
  The license key
- Optionaloptions: 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:51

Methods

city

city(ipAddress: string): 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:84

country

country(ipAddress: string): 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:93

insights

insights(ipAddress: string): 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:109