Skip to main content

Class: WorkerCommand

A command sent from the server to a worker.

Properties​

cancelActivity?​

optional cancelActivity?: $Properties | null

WorkerCommand cancelActivity.

type?​

optional type?: "cancelActivity"

WorkerCommand type.

Methods​

toJSON()​

toJSON(): object

Converts this WorkerCommand to JSON.

Returns​

object

JSON object

create()​

Call Signature​

static create(properties?): WorkerCommand & $Shape

Creates a new WorkerCommand instance using the specified properties.

Parameters​
properties?​

$Shape

Properties to set

Returns​

WorkerCommand & $Shape

WorkerCommand instance

Call Signature​

static create(properties?): WorkerCommand

Creates a new WorkerCommand instance using the specified properties.

Parameters​
properties?​

$Properties

Properties to set

Returns​

WorkerCommand

WorkerCommand instance

decode()​

static decode(reader, length?): WorkerCommand & $Shape

Decodes a WorkerCommand message from the specified reader or buffer.

Parameters​

reader​

Uint8Array<ArrayBufferLike> | Reader

Reader or buffer to decode from

length?​

number

Message length if known beforehand

Returns​

WorkerCommand & $Shape

WorkerCommand

Throws​

If the payload is not a reader or valid buffer

Throws​

If required fields are missing

decodeDelimited()​

static decodeDelimited(reader): WorkerCommand & $Shape

Decodes a WorkerCommand message from the specified reader or buffer, length delimited.

Parameters​

reader​

Uint8Array<ArrayBufferLike> | Reader

Reader or buffer to decode from

Returns​

WorkerCommand & $Shape

WorkerCommand

Throws​

If the payload is not a reader or valid buffer

Throws​

If required fields are missing

encode()​

static encode(message, writer?): Writer

Encodes the specified WorkerCommand message. Does not implicitly temporal.api.worker.v1.WorkerCommand.verify|verify messages.

Parameters​

message​

$Properties

WorkerCommand message or plain object to encode

writer?​

Writer

Writer to encode to

Returns​

Writer

Writer

encodeDelimited()​

static encodeDelimited(message, writer?): Writer

Encodes the specified WorkerCommand message, length delimited. Does not implicitly temporal.api.worker.v1.WorkerCommand.verify|verify messages.

Parameters​

message​

$Properties

WorkerCommand message or plain object to encode

writer?​

Writer

Writer to encode to

Returns​

Writer

Writer

fromObject()​

static fromObject(object): WorkerCommand

Creates a WorkerCommand message from a plain object. Also converts values to their respective internal types.

Parameters​

object​

Plain object

Returns​

WorkerCommand

WorkerCommand

toObject()​

static toObject(message, options?): object

Creates a plain object from a WorkerCommand message. Also converts values to other types if specified.

Parameters​

message​

WorkerCommand

WorkerCommand

options?​

IConversionOptions

Conversion options

Returns​

object

Plain object