Interface IpLocateRepositoryOptions

Hierarchy

IpLocateRepositoryOptions

Properties

Properties

Optional Readonly apiKey

apiKey: string

API key provided for registered application.

Readonly hooks

hooks: object

Hooks.

Type declaration

onIpRetrievalError: function

Hook called when ip retrieval fails with an error.

param

Error that was thrown.
- - (err: Error): void
  - Parameters
    - err: Error
    Returns void
onRateLimitExceeded: function

Hook called when rate limit was reached.

param

Date-time when rate limit will be reset.
- - (rateLimitReset: Date): void
  - Parameters
    - rateLimitReset: Date
    Returns void

Readonly weight

weight: number

Weight of the repo.