@maschinenlesbar.org/pegel-online-cli
    Preparing search index...

    Interface HttpRequest

    interface HttpRequest {
        body?: string | Buffer<ArrayBufferLike>;
        headers?: Record<string, string>;
        maxResponseBytes?: number;
        method: string;
        redirect?: "manual";
        signal?: AbortSignal;
        timeoutMs?: number;
        url: string;
    }
    Index
    body?: string | Buffer<ArrayBufferLike>

    Optional request body (already serialised).

    headers?: Record<string, string>
    maxResponseBytes?: number

    Hard cap on the response body size in bytes; the request aborts if exceeded.

    method: string
    redirect?: "manual"

    Always "manual": a transport must not follow redirects itself (fetch does by default — pass redirect: request.redirect). The engine follows them, keeping the base URL's credentials on the same origin and dropping them, and credential headers, on another. A response whose url (the final URL a fetch transport may report) lies on another origin than the request is rejected as a PegelNetworkError.

    signal?: AbortSignal

    Aborted when the engine's overall deadline (timeoutMs) passes. A transport should stop the request then (fetch(url, { signal })); the engine rejects at the deadline either way, and enforces maxResponseBytes on the body it gets back, so neither limit depends on it.

    timeoutMs?: number

    Timeout for the whole request, response body included, in milliseconds.

    url: string

    Fully-qualified absolute URL.