Skip to main content

Class: Capabilities

Represents a Capabilities.

Properties​

temporalFailureResponses​

temporalFailureResponses: boolean

If set, handlers may use temporal.api.failure.v1.Failure instances to return failures to the server. This also allows handler and operation errors to have their own messages and stack traces.

Methods​

toJSON()​

toJSON(): object

Converts this Capabilities to JSON.

Returns​

object

JSON object

create()​

Call Signature​

static create(properties?): Capabilities & $Properties

Creates a new Capabilities instance using the specified properties.

Parameters​
properties?​

$Properties

Properties to set

Returns​

Capabilities & $Properties

Capabilities instance

Call Signature​

static create(properties?): Capabilities

Creates a new Capabilities instance using the specified properties.

Parameters​
properties?​

$Properties

Properties to set

Returns​

Capabilities

Capabilities instance

decode()​

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

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

Capabilities & $Properties

Capabilities

Throws​

If the payload is not a reader or valid buffer

Throws​

If required fields are missing

decodeDelimited()​

static decodeDelimited(reader): Capabilities & $Properties

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

Parameters​

reader​

Uint8Array<ArrayBufferLike> | Reader

Reader or buffer to decode from

Returns​

Capabilities & $Properties

Capabilities

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 Capabilities message. Does not implicitly temporal.api.nexus.v1.Request.Capabilities.verify|verify messages.

Parameters​

message​

$Properties

Capabilities message or plain object to encode

writer?​

Writer

Writer to encode to

Returns​

Writer

Writer

encodeDelimited()​

static encodeDelimited(message, writer?): Writer

Encodes the specified Capabilities message, length delimited. Does not implicitly temporal.api.nexus.v1.Request.Capabilities.verify|verify messages.

Parameters​

message​

$Properties

Capabilities message or plain object to encode

writer?​

Writer

Writer to encode to

Returns​

Writer

Writer

fromObject()​

static fromObject(object): Capabilities

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

Parameters​

object​

Plain object

Returns​

Capabilities

Capabilities

toObject()​

static toObject(message, options?): object

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

Parameters​

message​

Capabilities

Capabilities

options?​

IConversionOptions

Conversion options

Returns​

object

Plain object