Skip to main content

Class: Outcome

The outcome of a Workflow Update: success or failure.

Properties​

failure?​

optional failure?: $Properties | null

Outcome failure.

success?​

optional success?: $Properties | null

Outcome success.

value?​

optional value?: "failure" | "success"

Outcome value.

Methods​

toJSON()​

toJSON(): object

Converts this Outcome to JSON.

Returns​

object

JSON object

create()​

Call Signature​

static create(properties?): Outcome & $Shape

Creates a new Outcome instance using the specified properties.

Parameters​
properties?​

$Shape

Properties to set

Returns​

Outcome & $Shape

Outcome instance

Call Signature​

static create(properties?): Outcome

Creates a new Outcome instance using the specified properties.

Parameters​
properties?​

$Properties

Properties to set

Returns​

Outcome

Outcome instance

decode()​

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

Decodes an Outcome 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​

Outcome & $Shape

Outcome

Throws​

If the payload is not a reader or valid buffer

Throws​

If required fields are missing

decodeDelimited()​

static decodeDelimited(reader): Outcome & $Shape

Decodes an Outcome message from the specified reader or buffer, length delimited.

Parameters​

reader​

Uint8Array<ArrayBufferLike> | Reader

Reader or buffer to decode from

Returns​

Outcome & $Shape

Outcome

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

Parameters​

message​

$Properties

Outcome message or plain object to encode

writer?​

Writer

Writer to encode to

Returns​

Writer

Writer

encodeDelimited()​

static encodeDelimited(message, writer?): Writer

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

Parameters​

message​

$Properties

Outcome message or plain object to encode

writer?​

Writer

Writer to encode to

Returns​

Writer

Writer

fromObject()​

static fromObject(object): Outcome

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

Parameters​

object​

Plain object

Returns​

Outcome

Outcome

toObject()​

static toObject(message, options?): object

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

Parameters​

message​

Outcome

Outcome

options?​

IConversionOptions

Conversion options

Returns​

object

Plain object