@ipregistry/client
    Preparing search index...

    Interface LookupOptions

    Options accepted by lookup methods.

    interface LookupOptions {
        fields?: string;
        hostname?: boolean;
        params?: Record<string, string | number | boolean>;
        signal?: AbortSignal;
    }
    Index

    Properties

    fields? hostname? params? signal?

    Properties

    fields?: string

    Selects the fields to include in the response, as a comma-separated list of field paths (e.g. 'location.country,security').

    hostname?: boolean

    Whether to resolve and include the hostname the IP address points to.

    params?: Record<string, string | number | boolean>

    Additional query parameters to send with the request.

    signal?: AbortSignal

    Cancels the request (including retries and, for batch lookups, pending chunks) when aborted.

    Settings

    Member Visibility

    On This Page

    Properties