TESSA Web API
    Preparing search index...

    Interface ApiClientOptions

    interface ApiClientOptions {
        baseURL?: string;
        body?: null | BodyInit;
        cache?: RequestCache;
        credentials?: RequestCredentials;
        fetch?: (input: RequestInfo, init?: RequestInit) => Promise<Response>;
        headers: Headers;
        hooks?: Partial<
            Omit<HttpInterceptor<HttpOptions>, keyof Extension<ExtensionContext>>,
        >[];
        ignoreSessionTokenHeader?: boolean;
        info?: IStorage;
        integrity?: string;
        json?: unknown;
        keepalive?: boolean;
        method?: string;
        mode?: RequestMode;
        parseJson?: (text: string) => unknown;
        parseTypedJson?: (text: string, useTypedField?: boolean) => unknown;
        priority?: RequestPriority;
        redirect?: RequestRedirect;
        referrer?: string;
        referrerPolicy?: ReferrerPolicy;
        removeEmptySearchParamsValue?: boolean;
        searchParams?: HttpSearchParams;
        sessionToken?: string;
        sessionTokenHeaderName?: string;
        signal?: null | AbortSignal;
        stringifyJson?: (obj: unknown) => string;
        stringifyTypedJson?: (obj: unknown) => string;
        throwHttpErrors?: boolean;
        throwOnEmptyJson?: boolean;
        timeout?: number;
        treat404As204?: boolean;
        typedJson?: unknown;
        window?: null;
    }

    Hierarchy (View Summary)

    Index

    Properties

    baseURL? body? cache? credentials? fetch? headers hooks? ignoreSessionTokenHeader? info? integrity? json? keepalive? method? mode? parseJson? parseTypedJson? priority? redirect? referrer? referrerPolicy? removeEmptySearchParamsValue? searchParams? sessionToken? sessionTokenHeaderName? signal? stringifyJson? stringifyTypedJson? throwHttpErrors? throwOnEmptyJson? timeout? treat404As204? typedJson? window?

    Properties

    baseURL?: string

    Optionalbody

    body?: null | BodyInit

    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.

    fetch?: (input: RequestInfo, init?: RequestInit) => Promise<Response>
    headers: Headers

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

    hooks?: Partial<
        Omit<HttpInterceptor<HttpOptions>, keyof Extension<ExtensionContext>>,
    >[]
    ignoreSessionTokenHeader?: boolean
    info?: IStorage
    integrity?: string

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

    json?: unknown
    keepalive?: boolean

    A boolean to set request's keepalive.

    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.

    parseJson?: (text: string) => unknown
    parseTypedJson?: (text: string, useTypedField?: boolean) => unknown
    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.

    removeEmptySearchParamsValue?: boolean
    searchParams?: HttpSearchParams
    sessionToken?: string
    sessionTokenHeaderName?: string
    signal?: null | AbortSignal

    An AbortSignal to set request's signal.

    stringifyJson?: (obj: unknown) => string
    stringifyTypedJson?: (obj: unknown) => string
    throwHttpErrors?: boolean
    throwOnEmptyJson?: boolean
    timeout?: number
    treat404As204?: boolean
    typedJson?: unknown
    window?: null

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

    Settings

    Member Visibility

    On This Page

    Properties