Class MatrixHostResolver

Class to lookup the hostname, port and host headers of a given Matrix servername according to the server discovery section of the spec.

Index

Constructors

Accessors

Methods

resolveMatrixServer resolveMatrixServerName

Constructors

constructor

new MatrixHostResolver(opts?): MatrixHostResolver
Parameters
- opts: {
      currentTimeMs?: number;
      dns?: DnsInterface;
      fetch?: ((input, init?) => Promise<Response>);
  } = {}
  - Optional currentTimeMs?: number
  - Optional dns?: DnsInterface
  - Optional fetch?: ((input, init?) => Promise<Response>)
    - (input, init?): Promise<Response>
      Parameters
      input: string | URL | Request
      Optional init: RequestInit
      Returns Promise<Response>
Returns MatrixHostResolver
- Defined in src/utils/matrix-host-resolver.ts:46

Accessors

currentTime

get currentTime(): number
Returns number
- Defined in src/utils/matrix-host-resolver.ts:52

Methods

resolveMatrixServer

resolveMatrixServer(hostname, skipCache?): Promise<{
hostHeader: string;
url: URL;
}>
Resolves a Matrix serverName into the baseURL for federated requests, and the Host header to use when serving requests.

Results are cached by default. Please note that failures are cached, determined by the constant CacheFailureForMS.
Parameters
- hostname: string
  The Matrix hostname to resolve. e.g. matrix.org
- skipCache: boolean = false
  Should the request be executed regardless of the cached value? Existing cached values will be overwritten.
Returns Promise<{
hostHeader: string;
url: URL;
}>
The baseurl of the Matrix server (excluding /_matrix/federation suffix), and the hostHeader to be used.
- Defined in src/utils/matrix-host-resolver.ts:262

resolveMatrixServerName

resolveMatrixServerName(hostname): Promise<HostResolveResult>
Resolves a Matrix serverName, fetching any delegated information. This request is NOT cached. For general use, please use resolveMatrixServer.
Parameters
- hostname: string
  The Matrix hostname to resolve. e.g. matrix.org
Returns Promise<HostResolveResult>
An object describing the delegated details for the host.
- Defined in src/utils/matrix-host-resolver.ts:164

Generated using TypeDoc