Class IpregistryConfig

Represents the configuration for the Ipregistry API client. This class holds the API key, base URL, and timeout setting used for API requests.

Index

Constructors

Properties

apiKey baseUrl timeout

Constructors

constructor

new IpregistryConfig(apiKey, baseUrl, timeout): IpregistryConfig
Constructs a new IpregistryConfig instance.
Parameters
- apiKey: string
  The API key for authenticating requests.
- baseUrl: string
  Optional. The base URL of the Ipregistry API.
- timeout: number
  Optional. The timeout for API requests in milliseconds.
Returns IpregistryConfig
- Defined in src/index.ts:61

Properties

`Readonly`apiKey

apiKey: string

The API key used for authenticating requests to Ipregistry.

`Readonly`baseUrl

baseUrl: string = 'https://api.ipregistry.co'

The base URL of the Ipregistry API. Defaults to 'https://api.ipregistry.co'.

`Readonly`timeout

timeout: number = 5000

The timeout (in milliseconds) for API requests. Defaults to 5000.