Class MessageBusError

An error raised by the message bus protocol.

Hierarchy

Error
- MessageBusError

Index

Constructors

Properties

code docsUrl? fix?

Constructors

constructor

new MessageBusError(
    code: MessageBusErrorCode,
    message?: string,
    options?: { cause?: unknown } & MessageBusErrorDetails,
): MessageBusError
Creates a message bus protocol error.
Parameters
- code: MessageBusErrorCode
- Optionalmessage: string
- Optionaloptions: { cause?: unknown } & MessageBusErrorDetails
Returns MessageBusError
Overrides Error.constructor
- Defined in dashboard/messageBus/bus.ts:75

Properties

`Readonly`code

code: MessageBusErrorCode

The machine-readable protocol error code.

`Optional` `Readonly`docsUrl

docsUrl?: string

A page that explains the refusal, when the host sent it.

`Optional` `Readonly`fix

fix?: string

What to do about the refusal, when the host sent it.