Skip to main content

Class: TimeSkippingFastForwardInfo

TimeSkippingFastForwardInfo describes the current time-skipping fast-forward on an execution.

Properties​

fastForwardDuration?​

optional fastForwardDuration?: $Properties | null

The client-supplied fast_forward duration.

fastForwardId​

fastForwardId: string

The client-supplied ID set alongside fast_forward duration.

hasCompleted​

hasCompleted: boolean

True once target_time has been reached.

targetTime?​

optional targetTime?: $Properties | null

The target virtual time at which the fast-forward completes.

Methods​

toJSON()​

toJSON(): object

Converts this TimeSkippingFastForwardInfo to JSON.

Returns​

object

JSON object

create()​

Call Signature​

static create(properties?): TimeSkippingFastForwardInfo & $Properties

Creates a new TimeSkippingFastForwardInfo instance using the specified properties.

Parameters​
properties?​

$Properties

Properties to set

Returns​

TimeSkippingFastForwardInfo & $Properties

TimeSkippingFastForwardInfo instance

Call Signature​

static create(properties?): TimeSkippingFastForwardInfo

Creates a new TimeSkippingFastForwardInfo instance using the specified properties.

Parameters​
properties?​

$Properties

Properties to set

Returns​

TimeSkippingFastForwardInfo

TimeSkippingFastForwardInfo instance

decode()​

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

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

TimeSkippingFastForwardInfo & $Properties

TimeSkippingFastForwardInfo

Throws​

If the payload is not a reader or valid buffer

Throws​

If required fields are missing

decodeDelimited()​

static decodeDelimited(reader): TimeSkippingFastForwardInfo & $Properties

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

Parameters​

reader​

Uint8Array<ArrayBufferLike> | Reader

Reader or buffer to decode from

Returns​

TimeSkippingFastForwardInfo & $Properties

TimeSkippingFastForwardInfo

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

Parameters​

message​

$Properties

TimeSkippingFastForwardInfo message or plain object to encode

writer?​

Writer

Writer to encode to

Returns​

Writer

Writer

encodeDelimited()​

static encodeDelimited(message, writer?): Writer

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

Parameters​

message​

$Properties

TimeSkippingFastForwardInfo message or plain object to encode

writer?​

Writer

Writer to encode to

Returns​

Writer

Writer

fromObject()​

static fromObject(object): TimeSkippingFastForwardInfo

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

Parameters​

object​

{[k: string]: any; }

Plain object

Returns​

TimeSkippingFastForwardInfo

TimeSkippingFastForwardInfo

toObject()​

static toObject(message, options?): object

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

Parameters​

message​

TimeSkippingFastForwardInfo

TimeSkippingFastForwardInfo

options?​

IConversionOptions

Conversion options

Returns​

object

Plain object