Skip to main content

Class: TimeSkippingStatePropagation

The time-skipping state that needs to be propagated from one execution to another, or through a chain of runs within the same execution.

Properties​

fastForwardTargetTime?​

optional fastForwardTargetTime?: $Properties | null

The fast-forward target time. It only propagates across a chain of runs within the same execution.

initialSkipCount​

initialSkipCount: number

The initial skip count. It only propagates across a chain of runs within the same execution.

initialSkippedDuration?​

optional initialSkippedDuration?: $Properties | null

The time skipped by the previous run. It is propagated both to executions started by the current execution and through a chain of runs (CaN, cron, retry).

Methods​

toJSON()​

toJSON(): object

Converts this TimeSkippingStatePropagation to JSON.

Returns​

object

JSON object

create()​

Call Signature​

static create(properties?): TimeSkippingStatePropagation & $Properties

Creates a new TimeSkippingStatePropagation instance using the specified properties.

Parameters​
properties?​

$Properties

Properties to set

Returns​

TimeSkippingStatePropagation & $Properties

TimeSkippingStatePropagation instance

Call Signature​

static create(properties?): TimeSkippingStatePropagation

Creates a new TimeSkippingStatePropagation instance using the specified properties.

Parameters​
properties?​

$Properties

Properties to set

Returns​

TimeSkippingStatePropagation

TimeSkippingStatePropagation instance

decode()​

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

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

TimeSkippingStatePropagation & $Properties

TimeSkippingStatePropagation

Throws​

If the payload is not a reader or valid buffer

Throws​

If required fields are missing

decodeDelimited()​

static decodeDelimited(reader): TimeSkippingStatePropagation & $Properties

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

Parameters​

reader​

Uint8Array<ArrayBufferLike> | Reader

Reader or buffer to decode from

Returns​

TimeSkippingStatePropagation & $Properties

TimeSkippingStatePropagation

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

Parameters​

message​

$Properties

TimeSkippingStatePropagation message or plain object to encode

writer?​

Writer

Writer to encode to

Returns​

Writer

Writer

encodeDelimited()​

static encodeDelimited(message, writer?): Writer

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

Parameters​

message​

$Properties

TimeSkippingStatePropagation message or plain object to encode

writer?​

Writer

Writer to encode to

Returns​

Writer

Writer

fromObject()​

static fromObject(object): TimeSkippingStatePropagation

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

Parameters​

object​

{[k: string]: any; }

Plain object

Returns​

TimeSkippingStatePropagation

TimeSkippingStatePropagation

toObject()​

static toObject(message, options?): object

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

Parameters​

message​

TimeSkippingStatePropagation

TimeSkippingStatePropagation

options?​

IConversionOptions

Conversion options

Returns​

object

Plain object