Interface IRequestOpts

interface IRequestOpts {
    abortSignal?: AbortSignal;
    baseUrl?: string;
    headers?: Record<string, string>;
    inhibitLogoutEmit?: boolean;
    json?: boolean;
    keepAlive?: boolean;
    localTimeoutMs?: number;
    prefix?: string;
}

Hierarchy

  • Pick<RequestInit, "priority">
    • IRequestOpts

Properties

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

Properties

OptionalabortSignal

abortSignal?: AbortSignal

OptionalbaseUrl

baseUrl?: string

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

Optionalheaders

headers?: Record<string, string>

map of additional request headers

OptionalinhibitLogoutEmit

inhibitLogoutEmit?: boolean

Optionaljson

json?: boolean

OptionalkeepAlive

keepAlive?: boolean

OptionallocalTimeoutMs

localTimeoutMs?: number

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

Optionalprefix

prefix?: string

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

Settings

Member Visibility

On This Page

Properties