Skip to main content

Class: WorkflowQuery

See https://docs.temporal.io/docs/concepts/queries/

Properties​

optional header?: $Properties | null

Headers that were passed by the caller of the query and copied by temporal server into the workflow task.

queryArgs?​

optional queryArgs?: $Properties | null

Serialized arguments that will be provided to the query handler.

queryType​

queryType: string

The workflow-author-defined identifier of the query. Typically a function name.

Methods​

toJSON()​

toJSON(): object

Converts this WorkflowQuery to JSON.

Returns​

object

JSON object

create()​

Call Signature​

static create(properties?): WorkflowQuery & $Properties

Creates a new WorkflowQuery instance using the specified properties.

Parameters​
properties?​

$Properties

Properties to set

Returns​

WorkflowQuery & $Properties

WorkflowQuery instance

Call Signature​

static create(properties?): WorkflowQuery

Creates a new WorkflowQuery instance using the specified properties.

Parameters​
properties?​

$Properties

Properties to set

Returns​

WorkflowQuery

WorkflowQuery instance

decode()​

static decode(reader, length?): WorkflowQuery & $Properties

Decodes a WorkflowQuery 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​

WorkflowQuery & $Properties

WorkflowQuery

Throws​

If the payload is not a reader or valid buffer

Throws​

If required fields are missing

decodeDelimited()​

static decodeDelimited(reader): WorkflowQuery & $Properties

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

Parameters​

reader​

Uint8Array<ArrayBufferLike> | Reader

Reader or buffer to decode from

Returns​

WorkflowQuery & $Properties

WorkflowQuery

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 WorkflowQuery message. Does not implicitly temporal.api.query.v1.WorkflowQuery.verify|verify messages.

Parameters​

message​

$Properties

WorkflowQuery message or plain object to encode

writer?​

Writer

Writer to encode to

Returns​

Writer

Writer

encodeDelimited()​

static encodeDelimited(message, writer?): Writer

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

Parameters​

message​

$Properties

WorkflowQuery message or plain object to encode

writer?​

Writer

Writer to encode to

Returns​

Writer

Writer

fromObject()​

static fromObject(object): WorkflowQuery

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

Parameters​

object​

Plain object

Returns​

WorkflowQuery

WorkflowQuery

toObject()​

static toObject(message, options?): object

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

Parameters​

message​

WorkflowQuery

WorkflowQuery

options?​

IConversionOptions

Conversion options

Returns​

object

Plain object