Class: Nexus
Nexus callbacks are used to delivery Nexus operation completions, as defined in the Nexus RPC spec: https://github.com/nexus-rpc/api/blob/main/SPEC.md#callback-urls
Properties
header
• header: Object
Header to attach to callback request.
Index signature
▪ [k: string]: string
url
• url: string
Callback URL.
Methods
toJSON
▸ toJSON(): Object
Converts this Nexus to JSON.
Returns
Object
JSON object
create
▸ create(properties?): Nexus & $Properties
Creates a new Nexus instance using the specified properties.
Parameters
| Name | Type | Description |
|---|---|---|
properties? | $Properties | Properties to set |
Returns
Nexus instance
▸ create(properties?): Nexus
Parameters
| Name | Type |
|---|---|
properties? | $Properties |
Returns
decode
▸ decode(reader, length?): Nexus & $Properties
Decodes a Nexus 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
Nexus
Throws
If the payload is not a reader or valid buffer
Throws
If required fields are missing
decodeDelimited
▸ decodeDelimited(reader): Nexus & $Properties
Decodes a Nexus message from the specified reader or buffer, length delimited.
Parameters
| Name | Type | Description |
|---|---|---|
reader | Uint8Array | Reader | Reader or buffer to decode from |
Returns
Nexus
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 Nexus message. Does not implicitly temporal.api.common.v1.Callback.Nexus.verify|verify messages.
Parameters
| Name | Type | Description |
|---|---|---|
message | $Properties | Nexus message or plain object to encode |
writer? | Writer | Writer to encode to |
Returns
Writer
Writer
encodeDelimited
▸ encodeDelimited(message, writer?): Writer
Encodes the specified Nexus message, length delimited. Does not implicitly temporal.api.common.v1.Callback.Nexus.verify|verify messages.
Parameters
| Name | Type | Description |
|---|---|---|
message | $Properties | Nexus message or plain object to encode |
writer? | Writer | Writer to encode to |
Returns
Writer
Writer
fromObject
▸ fromObject(object): Nexus
Creates a Nexus message from a plain object. Also converts values to their respective internal types.
Parameters
| Name | Type | Description |
|---|---|---|
object | Object | Plain object |
Returns
Nexus
toObject
▸ toObject(message, options?): Object
Creates a plain object from a Nexus message. Also converts values to other types if specified.
Parameters
| Name | Type | Description |
|---|---|---|
message | Nexus | Nexus |
options? | IConversionOptions | Conversion options |
Returns
Object
Plain object