matrix-js-sdk

    Interface IRequestOpts

    Options object for FetchHttpApi.requestOtherUrl.

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

    Hierarchy (View Summary)

    Index

    Properties

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

    Properties

    abortSignal?: AbortSignal
    baseUrl?: string

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

    headers?: Record<string, string>

    map of additional request headers

    inhibitLogoutEmit?: boolean
    json?: boolean

    By default, we will:

    • If the body is an object, JSON-encode it and set Content-Type: application/json in the request headers (unless overridden by headers).

    • Set Accept: application/json in the request headers (again, unless overridden by headers).

    • Parse the response as JSON and return the parsed response.

    Setting this to false inhibits all three behaviors, and the response is instead parsed as a UTF-8 string. It defaults to true, unless rawResponseBody is set.

    Instead of setting this to false, set rawResponseBody to true.

    keepAlive?: boolean
    localTimeoutMs?: number

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

    prefix?: string

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

    rawResponseBody?: boolean

    Setting this to true does two things:

    Settings

    Member Visibility

    On This Page

    Properties
    MMNEPVFCICPMFPCPTTAAATR