@shortcut/client
    Preparing search index...

    Interface ShortcutV4ClientOptions

    interface ShortcutV4ClientOptions {
        baseApiParams?: Omit<
            RequestParams,
            "cancelToken"
            | "signal"
            | "baseUrl",
        >;
        baseUrl?: string;
        fetch?: (
            input: string | URL | Request,
            init?: RequestInit,
        ) => Promise<Response>;
        refresh?: ShortcutV4RefreshOptions;
        timeoutMs?: number;
        token: string;
    }
    Index

    Properties

    baseApiParams? baseUrl? fetch? refresh? timeoutMs? token

    Properties

    baseApiParams?: Omit<RequestParams, "cancelToken" | "signal" | "baseUrl">

    Extra defaults applied to every request (headers, credentials, ...).

    baseUrl?: string

    API origin. Defaults to production.

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

    Replacement for the global fetch, e.g. for tests or instrumentation.

    refresh?: ShortcutV4RefreshOptions

    Refreshes the bearer token proactively before it expires and once more when a request comes back 401, then retries that request.

    timeoutMs?: number

    Milliseconds each request, including refresh waits, retries, and reading its body, may take before it is aborted with a TimeoutError. Defaults to 30 000; pass Infinity to disable.

    token: string

    Bearer token: an OAuth access token for an agent, or a workspace API token.

    Settings

    Member Visibility

    On This Page

    Properties