@getalby/sdk
    Preparing search index...

    Interface RequestOptions

    interface RequestOptions {
        auth?: AuthClient;
        base_url?: string;
        cache?: RequestCache;
        credentials?: RequestCredentials;
        endpoint: string;
        headers?: HeadersInit;
        integrity?: string;
        keepalive?: boolean;
        max_retries?: number;
        method?: string;
        mode?: RequestMode;
        params?: Record<string, any>;
        priority?: RequestPriority;
        redirect?: RequestRedirect;
        referrer?: string;
        referrerPolicy?: ReferrerPolicy;
        request_body?: Record<string, any>;
        signal?: null | AbortSignal;
        user_agent?: string;
        window?: null;
    }

    Hierarchy

    • Omit<RequestInit, "body">
      • RequestOptions
    Index

    Properties

    auth? base_url? cache? credentials? endpoint headers? integrity? keepalive? max_retries? method? mode? params? priority? redirect? referrer? referrerPolicy? request_body? signal? user_agent? window?

    Properties

    auth?: AuthClient
    base_url?: string
    cache?: RequestCache

    A string indicating how the request will interact with the browser's cache to set request's cache.

    credentials?: RequestCredentials

    A string indicating whether credentials will be sent with the request always, never, or only when sent to a same-origin URL. Sets request's credentials.

    endpoint: string
    headers?: HeadersInit

    A Headers object, an object literal, or an array of two-item arrays to set request's headers.

    integrity?: string

    A cryptographic hash of the resource to be fetched by request. Sets request's integrity.

    keepalive?: boolean

    A boolean to set request's keepalive.

    max_retries?: number
    method?: string

    A string to set request's method.

    mode?: RequestMode

    A string to indicate whether the request will use CORS, or will be restricted to same-origin URLs. Sets request's mode.

    params?: Record<string, any>
    priority?: RequestPriority
    redirect?: RequestRedirect

    A string indicating whether request follows redirects, results in an error upon encountering a redirect, or returns the redirect (in an opaque fashion). Sets request's redirect.

    referrer?: string

    A string whose value is a same-origin URL, "about:client", or the empty string, to set request's referrer.

    referrerPolicy?: ReferrerPolicy

    A referrer policy to set request's referrerPolicy.

    Optionalrequest_body

    request_body?: Record<string, any>
    signal?: null | AbortSignal

    An AbortSignal to set request's signal.

    user_agent?: string
    window?: null

    Can only be null. Used to disassociate request from any Window.

    Settings

    Member Visibility

    On This Page

    Properties