Class HunterClient

Hierarchy

HunterClient

Index

Constructors

constructor

Properties

Methods

run

Constructors

constructor

new HunterClient(args: IHunterClientOptions): HunterClient

- Defined in client.ts:24
Parameters
- args: IHunterClientOptions
Returns HunterClient

Properties

Protected apiKey

apiKey: string

endpoint

endpoint: string = "https://api.hunter.io/v2"

Protected instance

instance: AxiosInstance

Methods

Protected run

run(__namedParameters: object): Promise<any>

- Defined in client.ts:44
Call the Hunter.io api internally with specified options. This method is not supposed to use directly.

Parameters
- __namedParameters: object
  - action: string
  - callback: any
  - id: undefined | string | number
  - options: any
  - type: string
Returns Promise<any>

Generated using TypeDoc