Class IpLocateRepository

Repository which fetches ip locations from iplocate.

Hierarchy

IpLocateRepository

Implements

IpLocationsRepository

Constructors

constructor

Accessors

Methods

lookup

Constructors

constructor

new IpLocateRepository(options: IpLocateRepositoryOptions): IpLocateRepository

Parameters
- options: IpLocateRepositoryOptions
Returns IpLocateRepository

Accessors

available

get available(): boolean

Implementation of IpLocationsRepository.available

Whether repository is available to serve lookup requests.

Returns boolean

id

get id(): string

Implementation of IpLocationsRepository.id

Repository id.

Returns string

weight

get weight(): number

Implementation of IpLocationsRepository.weight

Repository weight.
Used by weighted round robin algorithm.

Returns number

Methods

lookup

lookup(ip: string): Promise<null | IpLocation>

Implementation of IpLocationsRepository.lookup

Lookup location of the ip address.

Parameters
- ip: string
  
  IP address.
Returns Promise<null | IpLocation>

Location of ip address.