Skip to main content

Class: NexusHandlerFailureInfo

Represents a NexusHandlerFailureInfo.

Properties​

retryBehavior​

retryBehavior: NexusHandlerErrorRetryBehavior

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

type​

type: string

The Nexus error type as defined in the spec: https://github.com/nexus-rpc/api/blob/main/SPEC.md#predefined-handler-errors.

Methods​

toJSON()​

toJSON(): object

Converts this NexusHandlerFailureInfo to JSON.

Returns​

object

JSON object

create()​

Call Signature​

static create(properties?): NexusHandlerFailureInfo & $Properties

Creates a new NexusHandlerFailureInfo instance using the specified properties.

Parameters​
properties?​

$Properties

Properties to set

Returns​

NexusHandlerFailureInfo & $Properties

NexusHandlerFailureInfo instance

Call Signature​

static create(properties?): NexusHandlerFailureInfo

Creates a new NexusHandlerFailureInfo instance using the specified properties.

Parameters​
properties?​

$Properties

Properties to set

Returns​

NexusHandlerFailureInfo

NexusHandlerFailureInfo instance

decode()​

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

Decodes a NexusHandlerFailureInfo 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​

NexusHandlerFailureInfo & $Properties

NexusHandlerFailureInfo

Throws​

If the payload is not a reader or valid buffer

Throws​

If required fields are missing

decodeDelimited()​

static decodeDelimited(reader): NexusHandlerFailureInfo & $Properties

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

Parameters​

reader​

Uint8Array<ArrayBufferLike> | Reader

Reader or buffer to decode from

Returns​

NexusHandlerFailureInfo & $Properties

NexusHandlerFailureInfo

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 NexusHandlerFailureInfo message. Does not implicitly temporal.api.failure.v1.NexusHandlerFailureInfo.verify|verify messages.

Parameters​

message​

$Properties

NexusHandlerFailureInfo message or plain object to encode

writer?​

Writer

Writer to encode to

Returns​

Writer

Writer

encodeDelimited()​

static encodeDelimited(message, writer?): Writer

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

Parameters​

message​

$Properties

NexusHandlerFailureInfo message or plain object to encode

writer?​

Writer

Writer to encode to

Returns​

Writer

Writer

fromObject()​

static fromObject(object): NexusHandlerFailureInfo

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

Parameters​

object​

Plain object

Returns​

NexusHandlerFailureInfo

NexusHandlerFailureInfo

toObject()​

static toObject(message, options?): object

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

Parameters​

message​

NexusHandlerFailureInfo

NexusHandlerFailureInfo

options?​

IConversionOptions

Conversion options

Returns​

object

Plain object