@backblaze-labs/b2-sdk - v0.4.0
    Preparing search index...

    Interface HttpRequest

    Describes an outgoing HTTP request to the B2 API.

    interface HttpRequest {
        body?: BodyInit | null;
        headers?: Record<string, string>;
        idempotent?: false;
        method: "GET" | "HEAD" | "POST";
        retry?: Partial<RetryOptions>;
        signal?: AbortSignal;
        url: string;
    }
    Index
    body? headers? idempotent? method retry? signal? url

    Optional Readonlybody

    body?: BodyInit | null

    Request body. Used for POST requests (JSON payloads or file uploads).

    headers?: Record<string, string>

    Request headers. Authorization and content-type are typically included.

    idempotent?: false

    Set false to disable automatic retry and expired-token reauth replay. This is not a general idempotency override.

    method: "GET" | "HEAD" | "POST"

    HTTP method. B2 uses GET for downloads (HEAD to fetch only headers) and POST for all other operations.

    retry?: Partial<RetryOptions>

    Optional per-request retry override.

    signal?: AbortSignal

    Optional abort signal for request cancellation.

    url: string

    Fully qualified URL to send the request to.

    Settings
    Member Visibility

    On This Page
    Properties