@grepvine/sdk
    Preparing search index...

    Interface GrepvineClientOptions

    Options of GrepvineClient. Every one is optional.

    interface GrepvineClientOptions {
        apiKey?: string;
        endpoint?: string;
        fetch?: {
            (input: RequestInfo | URL, init?: RequestInit): Promise<Response>;
            (input: string | Request | URL, init?: RequestInit): Promise<Response>;
        };
        retry?: RetryPolicy;
        timeout?: number;
    }
    Index
    apiKey? endpoint? fetch? retry? timeout?
    apiKey?: string

    The API key, sent as a bearer token.

    endpoint?: string

    The API endpoint, with or without /v1. Default https://api.grepvine.ai.

    fetch?: {
        (input: RequestInfo | URL, init?: RequestInit): Promise<Response>;
        (input: string | Request | URL, init?: RequestInit): Promise<Response>;
    }

    The fetch to send requests with. Default globalThis.fetch.

    Type Declaration

      • (input: RequestInfo | URL, init?: RequestInit): Promise<Response>

      • MDN Reference

        Parameters

        • input: RequestInfo | URL
        • Optionalinit: RequestInit

        Returns Promise<Response>

      • (input: string | Request | URL, init?: RequestInit): Promise<Response>

      • MDN Reference

        Parameters

        • input: string | Request | URL
        • Optionalinit: RequestInit

        Returns Promise<Response>

    retry?: RetryPolicy

    How failed requests are retried.

    timeout?: number

    The time limit of each attempt of a request, in milliseconds. Default 60,000.

    Settings
    Member Visibility

    On This Page
    Properties