Class: WorkerCommand
A command sent from the server to a worker.
Properties
cancelActivity
• Optional cancelActivity: null | $Properties
WorkerCommand cancelActivity.
type
• Optional type: "cancelActivity"
WorkerCommand type.
Methods
toJSON
▸ toJSON(): Object
Converts this WorkerCommand to JSON.
Returns
Object
JSON object
create
▸ create(properties?): WorkerCommand & $Shape
Creates a new WorkerCommand instance using the specified properties.
Parameters
| Name | Type | Description |
|---|---|---|
properties? | $Shape | Properties to set |
Returns
WorkerCommand instance
▸ create(properties?): WorkerCommand
Parameters
| Name | Type |
|---|---|
properties? | $Properties |
Returns
decode
▸ decode(reader, length?): WorkerCommand & $Shape
Decodes a WorkerCommand 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
WorkerCommand
Throws
If the payload is not a reader or valid buffer
Throws
If required fields are missing
decodeDelimited
▸ decodeDelimited(reader): WorkerCommand & $Shape
Decodes a WorkerCommand message from the specified reader or buffer, length delimited.
Parameters
| Name | Type | Description |
|---|---|---|
reader | Uint8Array | Reader | Reader or buffer to decode from |
Returns
WorkerCommand
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 WorkerCommand message. Does not implicitly temporal.api.worker.v1.WorkerCommand.verify|verify messages.
Parameters
| Name | Type | Description |
|---|---|---|
message | $Properties | WorkerCommand message or plain object to encode |
writer? | Writer | Writer to encode to |
Returns
Writer
Writer
encodeDelimited
▸ encodeDelimited(message, writer?): Writer
Encodes the specified WorkerCommand message, length delimited. Does not implicitly temporal.api.worker.v1.WorkerCommand.verify|verify messages.
Parameters
| Name | Type | Description |
|---|---|---|
message | $Properties | WorkerCommand message or plain object to encode |
writer? | Writer | Writer to encode to |
Returns
Writer
Writer
fromObject
▸ fromObject(object): WorkerCommand
Creates a WorkerCommand message from a plain object. Also converts values to their respective internal types.
Parameters
| Name | Type | Description |
|---|---|---|
object | Object | Plain object |
Returns
WorkerCommand
toObject
▸ toObject(message, options?): Object
Creates a plain object from a WorkerCommand message. Also converts values to other types if specified.
Parameters
| Name | Type | Description |
|---|---|---|
message | WorkerCommand | WorkerCommand |
options? | IConversionOptions | Conversion options |
Returns
Object
Plain object