Skip to main content

Class: Runtime

Represents a Runtime.

Properties​

type​

type: RuntimeType

The type of the runtime.

version​

version: string

The version of the runtime, if obtainable.

Methods​

toJSON()​

toJSON(): object

Converts this Runtime to JSON.

Returns​

object

JSON object

create()​

Call Signature​

static create(properties?): Runtime & $Properties

Creates a new Runtime instance using the specified properties.

Parameters​
properties?​

$Properties

Properties to set

Returns​

Runtime & $Properties

Runtime instance

Call Signature​

static create(properties?): Runtime

Creates a new Runtime instance using the specified properties.

Parameters​
properties?​

$Properties

Properties to set

Returns​

Runtime

Runtime instance

decode()​

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

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

Runtime & $Properties

Runtime

Throws​

If the payload is not a reader or valid buffer

Throws​

If required fields are missing

decodeDelimited()​

static decodeDelimited(reader): Runtime & $Properties

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

Parameters​

reader​

Uint8Array<ArrayBufferLike> | Reader

Reader or buffer to decode from

Returns​

Runtime & $Properties

Runtime

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 Runtime message. Does not implicitly temporal.api.worker.v1.EnvironmentInfo.Runtime.verify|verify messages.

Parameters​

message​

$Properties

Runtime message or plain object to encode

writer?​

Writer

Writer to encode to

Returns​

Writer

Writer

encodeDelimited()​

static encodeDelimited(message, writer?): Writer

Encodes the specified Runtime message, length delimited. Does not implicitly temporal.api.worker.v1.EnvironmentInfo.Runtime.verify|verify messages.

Parameters​

message​

$Properties

Runtime message or plain object to encode

writer?​

Writer

Writer to encode to

Returns​

Writer

Writer

fromObject()​

static fromObject(object): Runtime

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

Parameters​

object​

Plain object

Returns​

Runtime

Runtime

toObject()​

static toObject(message, options?): object

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

Parameters​

message​

Runtime

Runtime

options?​

IConversionOptions

Conversion options

Returns​

object

Plain object