@edgible-team/sdk
    Preparing search index...

    Interface HttpRequest

    A single API request as it flows through the middleware pipeline to the transport. Resource methods build these; middlewares may transform them.

    interface HttpRequest {
        body?: unknown;
        headers?: Record<string, string>;
        method: HttpMethod;
        noRetry?: boolean;
        path: string;
        query?: Record<string, string | number | boolean | undefined>;
        signal?: AbortSignal;
        timeoutMs?: number;
    }
    Index

    Properties

    body? headers? method noRetry? path query? signal? timeoutMs?

    Properties

    Optionalbody

    body?: unknown

    JSON-serialisable request body; sent as application/json.

    headers?: Record<string, string>

    Request headers; auth/telemetry middlewares add theirs on top.

    method: HttpMethod

    HTTP method; writes (POST/PUT/PATCH/DELETE) get idempotency keys.

    noRetry?: boolean

    Opt this request out of the retry middleware. For non-idempotent single-use exchanges (e.g. POST /auth/cli/token, which consumes the device code) a retry can never succeed and replaces the real error with whatever the second attempt sees.

    path: string

    Already-versioned path, e.g. '/applications/{id}' (D12).

    query?: Record<string, string | number | boolean | undefined>

    Query string parameters; undefined values are omitted.

    signal?: AbortSignal

    Caller-supplied abort signal for cancellation.

    timeoutMs?: number

    Per-request timeout; overrides the transport default.

    Settings

    Member Visibility

    On This Page

    Properties