Class: HandlerError
Represents a HandlerError.
Implements
Constructors
constructor
• new HandlerError(properties?): HandlerError
Constructs a new HandlerError.
Parameters
| Name | Type | Description |
|---|---|---|
properties? | IHandlerError | Properties to set |
Returns
Properties
errorType
• errorType: string
See https://github.com/nexus-rpc/api/blob/main/SPEC.md#predefined-handler-errors.
Implementation of
failure
• Optional failure: null | IFailure
HandlerError failure.
Implementation of
retryBehavior
• retryBehavior: NexusHandlerErrorRetryBehavior
Retry behavior, defaults to the retry behavior of the error type as defined in the spec.
Implementation of
Methods
toJSON
▸ toJSON(): Object
Converts this HandlerError to JSON.
Returns
Object
JSON object
create
▸ create(properties?): HandlerError
Creates a new HandlerError instance using the specified properties.
Parameters
| Name | Type | Description |
|---|---|---|
properties? | IHandlerError | Properties to set |
Returns
HandlerError instance
decode
▸ decode(reader, length?): HandlerError
Decodes a HandlerError 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
HandlerError
Throws
If the payload is not a reader or valid buffer
Throws
If required fields are missing
decodeDelimited
▸ decodeDelimited(reader): HandlerError
Decodes a HandlerError message from the specified reader or buffer, length delimited.
Parameters
| Name | Type | Description |
|---|---|---|
reader | Uint8Array | Reader | Reader or buffer to decode from |
Returns
HandlerError
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 HandlerError message. Does not implicitly temporal.api.nexus.v1.HandlerError.verify|verify messages.
Parameters
| Name | Type | Description |
|---|---|---|
message | IHandlerError | HandlerError message or plain object to encode |
writer? | Writer | Writer to encode to |
Returns
Writer
Writer
encodeDelimited
▸ encodeDelimited(message, writer?): Writer
Encodes the specified HandlerError message, length delimited. Does not implicitly temporal.api.nexus.v1.HandlerError.verify|verify messages.
Parameters
| Name | Type | Description |
|---|---|---|
message | IHandlerError | HandlerError message or plain object to encode |
writer? | Writer | Writer to encode to |
Returns
Writer
Writer
fromObject
▸ fromObject(object): HandlerError
Creates a HandlerError message from a plain object. Also converts values to their respective internal types.
Parameters
| Name | Type | Description |
|---|---|---|
object | Object | Plain object |
Returns
HandlerError
getTypeUrl
▸ getTypeUrl(typeUrlPrefix?): string
Gets the default type url for HandlerError
Parameters
| Name | Type | Description |
|---|---|---|
typeUrlPrefix? | string | your custom typeUrlPrefix(default "type.googleapis.com") |
Returns
string
The default type url
toObject
▸ toObject(message, options?): Object
Creates a plain object from a HandlerError message. Also converts values to other types if specified.
Parameters
| Name | Type | Description |
|---|---|---|
message | HandlerError | HandlerError |
options? | IConversionOptions | Conversion options |
Returns
Object
Plain object