Class: Failure
A general purpose failure message. See: https://github.com/nexus-rpc/api/blob/main/SPEC.md#failure
Implements
Constructors
constructor
• new Failure(properties?): Failure
Constructs a new Failure.
Parameters
| Name | Type | Description |
|---|---|---|
properties? | IFailure | Properties to set |
Returns
Properties
details
• details: Uint8Array
Failure details.
Implementation of
message
• message: string
Failure message.
Implementation of
metadata
• metadata: Object
Failure metadata.
Index signature
▪ [k: string]: string
Implementation of
Methods
toJSON
▸ toJSON(): Object
Converts this Failure to JSON.
Returns
Object
JSON object
create
▸ create(properties?): Failure
Creates a new Failure instance using the specified properties.
Parameters
| Name | Type | Description |
|---|---|---|
properties? | IFailure | Properties to set |
Returns
Failure instance
decode
▸ decode(reader, length?): Failure
Decodes a Failure 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
Failure
Throws
If the payload is not a reader or valid buffer
Throws
If required fields are missing
decodeDelimited
▸ decodeDelimited(reader): Failure
Decodes a Failure message from the specified reader or buffer, length delimited.
Parameters
| Name | Type | Description |
|---|---|---|
reader | Uint8Array | Reader | Reader or buffer to decode from |
Returns
Failure
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 Failure message. Does not implicitly temporal.api.nexus.v1.Failure.verify|verify messages.
Parameters
| Name | Type | Description |
|---|---|---|
message | IFailure | Failure message or plain object to encode |
writer? | Writer | Writer to encode to |
Returns
Writer
Writer
encodeDelimited
▸ encodeDelimited(message, writer?): Writer
Encodes the specified Failure message, length delimited. Does not implicitly temporal.api.nexus.v1.Failure.verify|verify messages.
Parameters
| Name | Type | Description |
|---|---|---|
message | IFailure | Failure message or plain object to encode |
writer? | Writer | Writer to encode to |
Returns
Writer
Writer
fromObject
▸ fromObject(object): Failure
Creates a Failure message from a plain object. Also converts values to their respective internal types.
Parameters
| Name | Type | Description |
|---|---|---|
object | Object | Plain object |
Returns
Failure
getTypeUrl
▸ getTypeUrl(typeUrlPrefix?): string
Gets the default type url for Failure
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 Failure message. Also converts values to other types if specified.
Parameters
| Name | Type | Description |
|---|---|---|
message | Failure | Failure |
options? | IConversionOptions | Conversion options |
Returns
Object
Plain object