Class: NexusHandlerFailureInfo
failure.v1.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
▸ create(properties?): NexusHandlerFailureInfo & $Properties
Creates a new NexusHandlerFailureInfo instance using the specified properties.
Parameters
| Name | Type | Description |
|---|---|---|
properties? | $Properties | Properties to set |
Returns
NexusHandlerFailureInfo & $Properties
NexusHandlerFailureInfo instance
▸ create(properties?): NexusHandlerFailureInfo
Parameters
| Name | Type |
|---|---|
properties? | $Properties |
Returns
decode
▸ decode(reader, length?): NexusHandlerFailureInfo & $Properties
Decodes a NexusHandlerFailureInfo message from the specified reader or buffer.
Parameters
| Name | Type | Description |
|---|---|---|
reader | Uint8Array | 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
▸ decodeDelimited(reader): NexusHandlerFailureInfo & $Properties
Decodes a NexusHandlerFailureInfo message from the specified reader or buffer, length delimited.
Parameters
| Name | Type | Description |
|---|---|---|
reader | Uint8Array | 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
▸ encode(message, writer?): Writer
Encodes the specified NexusHandlerFailureInfo message. Does not implicitly temporal.api.failure.v1.NexusHandlerFailureInfo.verify|verify messages.
Parameters
| Name | Type | Description |
|---|---|---|
message | $Properties | NexusHandlerFailureInfo message or plain object to encode |
writer? | Writer | Writer to encode to |
Returns
Writer
Writer
encodeDelimited
▸ encodeDelimited(message, writer?): Writer
Encodes the specified NexusHandlerFailureInfo message, length delimited. Does not implicitly temporal.api.failure.v1.NexusHandlerFailureInfo.verify|verify messages.
Parameters
| Name | Type | Description |
|---|---|---|
message | $Properties | NexusHandlerFailureInfo message or plain object to encode |
writer? | Writer | Writer to encode to |
Returns
Writer
Writer
fromObject
▸ fromObject(object): NexusHandlerFailureInfo
Creates a NexusHandlerFailureInfo message from a plain object. Also converts values to their respective internal types.
Parameters
| Name | Type | Description |
|---|---|---|
object | Object | Plain object |
Returns
NexusHandlerFailureInfo
toObject
▸ toObject(message, options?): Object
Creates a plain object from a NexusHandlerFailureInfo message. Also converts values to other types if specified.
Parameters
| Name | Type | Description |
|---|---|---|
message | NexusHandlerFailureInfo | NexusHandlerFailureInfo |
options? | IConversionOptions | Conversion options |
Returns
Object
Plain object