@ipregistry/client
    Preparing search index...

    Interface IpregistryClientOptions

    Configuration options for constructing an IpregistryClient.

    interface IpregistryClientOptions {
        apiKey: string;
        baseUrl?: string;
        batchConcurrency?: number;
        cache?: IpregistryCache<IpregistryCacheValue>;
        fetch?: FetchImplementation;
        maxBatchSize?: number;
        maxRetries?: number;
        requestHandler?: IpregistryRequestHandler;
        retryInterval?: number;
        retryOnServerError?: boolean;
        retryOnTooManyRequests?: boolean;
        timeout?: number;
    }
    Index
    apiKey baseUrl? batchConcurrency? cache? fetch? maxBatchSize? maxRetries? requestHandler? retryInterval? retryOnServerError? retryOnTooManyRequests? timeout?
    apiKey: string

    The API key used for authenticating requests to Ipregistry.

    baseUrl?: string

    The base URL of the Ipregistry API, or the shorthand 'eu' for the European Union endpoint. Defaults to 'https://api.ipregistry.co'.

    batchConcurrency?: number

    How many batch sub-requests are dispatched concurrently when a batch is split into chunks. Defaults to 4.

    cache?: IpregistryCache<IpregistryCacheValue>

    The cache used to memoize lookups. Defaults to NoCache.

    fetch?: FetchImplementation

    The fetch implementation used to perform HTTP requests. Defaults to the global fetch. Useful for proxies, instrumentation or testing. The implementation is invoked without a receiver, so pass a bound function when the source requires one (e.g. window.fetch.bind(window)).

    maxBatchSize?: number

    The maximum number of values sent in a single batch request. Capped at DEFAULT_MAX_BATCH_SIZE (the API limit).

    maxRetries?: number

    The maximum number of automatic retries performed in addition to the initial attempt. Defaults to 3. Use 0 to disable retries.

    requestHandler?: IpregistryRequestHandler

    A custom handler for API requests.

    retryInterval?: number

    The base backoff (in milliseconds) between retries. Defaults to 1000.

    retryOnServerError?: boolean

    Whether 5xx responses (and transient network errors) are retried. Defaults to true.

    retryOnTooManyRequests?: boolean

    Whether 429 Too Many Requests responses are retried, honoring the Retry-After header when present. Defaults to false.

    timeout?: number

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

    Settings
    Member Visibility

    On This Page
    Properties