Class MatrixError

constructor

• new MatrixError(
      errorJson?: IErrorJson,
      httpStatus?: number,
      url?: string,
      event?: MatrixEvent,
      httpHeaders?: Headers,
  ): MatrixError

  Construct a Matrix error. This is a JavaScript Error with additional information specific to the standard Matrix error response.

  Parameters

  • errorJson: IErrorJson = {}

    The Matrix error JSON returned from the homeserver.
  • OptionalhttpStatus: number

    The numeric HTTP status code given
  • Optionalurl: string
  • Optionalevent: MatrixEvent
  • OptionalhttpHeaders: Headers

    The HTTP response headers given

  Returns MatrixError

data

Optional Readonlyerrcode

Optionalevent

Optionalurl

asWidgetApiErrorData

• asWidgetApiErrorData(): IMatrixApiError

  Returns IMatrixApiError

  this error expressed as a JSON payload for use by Widget API error responses.

getRetryAfterMs

• getRetryAfterMs(): null | number

  Returns null | number

  The recommended delay in milliseconds to wait before retrying the request that triggered this error, or null if no delay is recommended.

  Throws

  Error if the recommended delay is an invalid value.

  See

  safeGetRetryAfterMs for a version of this check that doesn't throw.

isRateLimitError

• isRateLimitError(): boolean

  Check if this error was due to rate-limiting on the server side (and should therefore be retried after a delay).

  If this returns true, getRetryAfterMs can be called to retrieve the server-side recommendation for the retry period.

  Returns boolean

  Whether this error is due to rate-limiting.

StaticfromWidgetApiErrorData

• fromWidgetApiErrorData(data: IMatrixApiError): MatrixError

  Parameters

  • data: IMatrixApiError

  Returns MatrixError

  a new MatrixError from a JSON payload received from Widget API error responses.