Interface IRequestOpts

interface IRequestOpts {
    abortSignal?: AbortSignal;
    baseUrl?: string;
    headers?: Record<string, string>;
    inhibitLogoutEmit?: boolean;
    json?: boolean;
    keepAlive?: boolean;
    localTimeoutMs?: number;
    prefix?: string;
    priority?: "auto" | "high" | "low";
}

Hierarchy

  • Pick<RequestInit, "priority">
    • IRequestOpts

Properties

abortSignal? baseUrl? headers? inhibitLogoutEmit? json? keepAlive? localTimeoutMs? prefix? priority?

Properties

Optional abortSignal

abortSignal?: AbortSignal

Optional baseUrl

baseUrl?: string

The alternative base url to use. If not specified, uses this.opts.baseUrl

Optional headers

headers?: Record<string, string>

map of additional request headers

Optional inhibitLogoutEmit

inhibitLogoutEmit?: boolean

Optional json

json?: boolean

Optional keepAlive

keepAlive?: boolean

Optional localTimeoutMs

localTimeoutMs?: number

The maximum amount of time to wait before timing out the request. If not specified, there is no timeout.

Optional prefix

prefix?: string

The full prefix to use e.g. "/_matrix/client/v2_alpha". If not specified, uses this.opts.prefix.

Optional priority

priority?: "auto" | "high" | "low"

Specifies the priority of the fetch request relative to other requests of the same type. Must be one of the following strings: high: A high priority fetch request relative to other requests of the same type. low: A low priority fetch request relative to other requests of the same type. auto: Automatically determine the priority of the fetch request relative to other requests of the same type (default).

See

Settings

Member Visibility

Theme

On This Page

abortSignalbaseUrlheadersinhibitLogoutEmitjsonkeepAlivelocalTimeoutMsprefixpriority

Generated using TypeDoc