Class MatrixHttpApi<O>

constructor

• new MatrixHttpApi<O>(eventEmitter, opts): MatrixHttpApi<O>

• Type Parameters

  • O extends IHttpOpts

  Parameters

  • eventEmitter: TypedEventEmitter<HttpApiEvent, HttpApiEventHandlerMap, HttpApiEventHandlerMap>

  • opts: O

  Returns MatrixHttpApi<O>

Readonly opts

abort

• abort(): void

• Returns void

authedRequest

• authedRequest<T>(method, path, queryParams?, body?, opts?): Promise<ResponseType<T, O>>

• Perform an authorised request to the homeserver.

  Type Parameters

  • T

  Parameters

  • method: Method

    The HTTP method e.g. "GET".

  • path: string

    The HTTP path after the supplied prefix e.g. "/createRoom".

  • Optional queryParams: QueryDict

    A dict of query params (these will NOT be urlencoded). If unspecified, there will be no query params.

  • Optional body: Body

    The HTTP JSON body.

  • opts: IRequestOpts = {}

    additional options. If a number is specified, this is treated as opts.localTimeoutMs.

  Returns Promise<ResponseType<T, O>>

  Promise which resolves to

  {
      data: {Object},
      headers: {Object},
      code: {Number},
  }
  Copy

  If onlyData is set, this will resolve to the data object only.

fetch

• fetch(resource, options?): Promise<Response>

• Parameters

  • resource: string | URL

  • Optional options: RequestInit

  Returns Promise<Response>

getUrl

• getUrl(path, queryParams?, prefix?, baseUrl?): URL

• Form and return a homeserver request URL based on the given path params and prefix.

  Parameters

  • path: string

    The HTTP path after the supplied prefix e.g. "/createRoom".

  • Optional queryParams: QueryDict

    A dict of query params (these will NOT be urlencoded).

  • Optional prefix: string

    The full prefix to use e.g. "/_matrix/client/v2_alpha", defaulting to this.opts.prefix.

  • Optional baseUrl: string

    The baseUrl to use e.g. "https://matrix.org", defaulting to this.opts.baseUrl.

  Returns URL

  URL

idServerRequest

• idServerRequest<T>(method, path, params, prefix, accessToken?): Promise<ResponseType<T, O>>

• Type Parameters

  • T extends {} = Record<string, unknown>

  Parameters

  • method: Method

  • path: string

  • params: undefined | Record<string, string | string[]>

  • prefix: string

  • Optional accessToken: string

  Returns Promise<ResponseType<T, O>>

request

• request<T>(method, path, queryParams?, body?, opts?): Promise<ResponseType<T, O>>

• Perform a request to the homeserver without any credentials.

  Type Parameters

  • T

  Parameters

  • method: Method

    The HTTP method e.g. "GET".

  • path: string

    The HTTP path after the supplied prefix e.g. "/createRoom".

  • Optional queryParams: QueryDict

    A dict of query params (these will NOT be urlencoded). If unspecified, there will be no query params.

  • Optional body: Body

    The HTTP JSON body.

  • Optional opts: IRequestOpts

    additional options

  Returns Promise<ResponseType<T, O>>

  Promise which resolves to

  {
   data: {Object},
   headers: {Object},
   code: {Number},
  }
  Copy

  If onlyData</code> is set, this will resolve to the <code>data object only.

requestOtherUrl

• requestOtherUrl<T>(method, url, body?, opts?): Promise<ResponseType<T, O>>

• Perform a request to an arbitrary URL.

  Type Parameters

  • T

  Parameters

  • method: Method

    The HTTP method e.g. "GET".

  • url: string | URL

    The HTTP URL object.

  • Optional body: Body

    The HTTP JSON body.

  • opts: Pick<IRequestOpts, "json" | "keepAlive" | "headers" | "localTimeoutMs" | "abortSignal"> = {}

    additional options

  Returns Promise<ResponseType<T, O>>

  Promise which resolves to data unless onlyData is specified as false, where the resolved value will be a fetch Response object.

setIdBaseUrl

• setIdBaseUrl(url?): void

• Sets the base URL for the identity server

  Parameters

  • Optional url: string

    The new base url

  Returns void