Class MatrixError

Construct a generic HTTP error. This is a JavaScript Error with additional information specific to HTTP responses.

Param: msg

The error message to include.

Param: httpStatus

The HTTP response status code.

Hierarchy (view full)

Constructors

constructor

Properties

data errcode? event? httpStatus? url?

Constructors

constructor

  • new MatrixError(errorJson?, httpStatus?, url?, event?): 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.

    • Optional httpStatus: number

      The numeric HTTP status code given

    • Optional url: string
    • Optional event: MatrixEvent

    Returns MatrixError

Properties

data

data: IErrorJson

Optional Readonly errcode

errcode?: string

Optional event

event?: MatrixEvent

Optional Readonly httpStatus

httpStatus?: number

The numeric HTTP status code given

Optional url

url?: string

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc