Class PayloadTooLargeError

A publish that exceeds the gateway's advertised event payload ceiling.

Hierarchy (View Summary)

QualithmDeviceError
- PayloadTooLargeError

Index

Constructors

Properties

actualBytes maxBytes tag

Methods

Constructors

constructor

new PayloadTooLargeError(
message: string,
options?: ErrorOptions & { actualBytes: number; maxBytes: number },
): PayloadTooLargeError
Parameters
- message: string
- Optionaloptions: ErrorOptions & { actualBytes: number; maxBytes: number }
Returns PayloadTooLargeError
Overrides QualithmDeviceError.constructor
- Defined in errors.ts:156

Properties

`Readonly`actualBytes

actualBytes: number

The payload size that was refused, in bytes.

`Readonly`maxBytes

maxBytes: number

The ceiling the gateway advertised in CONNACK, in bytes.

`Readonly`tag

tag: "PayloadTooLargeError" = PAYLOAD_TOO_LARGE_ERROR_TAG

Discriminant tag — always "PayloadTooLargeError".

Methods

`Static`isError

isError(value: unknown): value is PayloadTooLargeError
Type-narrowing check for PayloadTooLargeError.
Parameters
- value: unknown
Returns value is PayloadTooLargeError
Overrides QualithmDeviceError.isError
- Defined in errors.ts:164