Skip to main content

Class: HandlerError

Represents a HandlerError.

Properties​

errorType​

errorType: string

See https://github.com/nexus-rpc/api/blob/main/SPEC.md#predefined-handler-errors.

failure?​

optional failure?: $Properties | null

HandlerError failure.

retryBehavior​

retryBehavior: NexusHandlerErrorRetryBehavior

Retry behavior, defaults to the retry behavior of the error type as defined in the spec.

Methods​

toJSON()​

toJSON(): object

Converts this HandlerError to JSON.

Returns​

object

JSON object

create()​

Call Signature​

static create(properties?): HandlerError & $Properties

Creates a new HandlerError instance using the specified properties.

Parameters​
properties?​

$Properties

Properties to set

Returns​

HandlerError & $Properties

HandlerError instance

Call Signature​

static create(properties?): HandlerError

Creates a new HandlerError instance using the specified properties.

Parameters​
properties?​

$Properties

Properties to set

Returns​

HandlerError

HandlerError instance

decode()​

static decode(reader, length?): HandlerError & $Properties

Decodes a HandlerError message from the specified reader or buffer.

Parameters​

reader​

Uint8Array<ArrayBufferLike> | Reader

Reader or buffer to decode from

length?​

number

Message length if known beforehand

Returns​

HandlerError & $Properties

HandlerError

Throws​

If the payload is not a reader or valid buffer

Throws​

If required fields are missing

decodeDelimited()​

static decodeDelimited(reader): HandlerError & $Properties

Decodes a HandlerError message from the specified reader or buffer, length delimited.

Parameters​

reader​

Uint8Array<ArrayBufferLike> | Reader

Reader or buffer to decode from

Returns​

HandlerError & $Properties

HandlerError

Throws​

If the payload is not a reader or valid buffer

Throws​

If required fields are missing

encode()​

static encode(message, writer?): Writer

Encodes the specified HandlerError message. Does not implicitly temporal.api.nexus.v1.HandlerError.verify|verify messages.

Parameters​

message​

$Properties

HandlerError message or plain object to encode

writer?​

Writer

Writer to encode to

Returns​

Writer

Writer

encodeDelimited()​

static encodeDelimited(message, writer?): Writer

Encodes the specified HandlerError message, length delimited. Does not implicitly temporal.api.nexus.v1.HandlerError.verify|verify messages.

Parameters​

message​

$Properties

HandlerError message or plain object to encode

writer?​

Writer

Writer to encode to

Returns​

Writer

Writer

fromObject()​

static fromObject(object): HandlerError

Creates a HandlerError message from a plain object. Also converts values to their respective internal types.

Parameters​

object​

{[k: string]: any; }

Plain object

Returns​

HandlerError

HandlerError

toObject()​

static toObject(message, options?): object

Creates a plain object from a HandlerError message. Also converts values to other types if specified.

Parameters​

message​

HandlerError

HandlerError

options?​

IConversionOptions

Conversion options

Returns​

object

Plain object