@flowscripter/dynamic-cli-framework
    Preparing search index...

    Interface FetchOptions

    Options for FetchService.fetch. Extends the standard RequestInit so any request method, headers, body, or credentials supported by native fetch() can be used.

    interface FetchOptions {
        body?: BodyInit | null;
        cache?: RequestCache;
        credentials?: RequestCredentials;
        headers?: HeadersInit;
        integrity?: string;
        keepalive?: boolean;
        longRunning?: boolean;
        method?: string;
        mode?: RequestMode;
        priority?: RequestPriority;
        redirect?: RequestRedirect;
        referrer?: string;
        referrerPolicy?: ReferrerPolicy;
        signal?: AbortSignal | null;
        timeoutMs?: number;
        window?: null;
    }

    Hierarchy

    • RequestInit
      • FetchOptions
    Index
    body? cache? credentials? headers? integrity? keepalive? longRunning? method? mode? priority? redirect? referrer? referrerPolicy? signal? timeoutMs? window?

    Optionalbody

    body?: BodyInit | null

    A BodyInit object or null to set request's body.

    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.

    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.

    longRunning?: boolean

    Whether to enter long-running shutdown mode for the duration of the fetch, so a single Ctrl-C gracefully aborts the request rather than immediately exiting the CLI. Defaults to false.

    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.

    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.

    signal?: AbortSignal | null

    An AbortSignal to set request's signal.

    timeoutMs?: number

    If specified, the fetch is aborted if it has not settled within this many milliseconds. Defaults to unbounded.

    window?: null

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

    Settings
    Member Visibility

    On This Page
    Properties