Skip to main content

Class: Platform

Represents a Platform.

Properties​

linux?​

optional linux?: $Properties | null

Platform linux.

macos?​

optional macos?: $Properties | null

Platform macos.

variant?​

optional variant?: "linux" | "macos" | "windows"

Platform variant.

windows?​

optional windows?: $Properties | null

Platform windows.

Methods​

toJSON()​

toJSON(): object

Converts this Platform to JSON.

Returns​

object

JSON object

create()​

Call Signature​

static create(properties?): Platform & $Shape

Creates a new Platform instance using the specified properties.

Parameters​
properties?​

$Shape

Properties to set

Returns​

Platform & $Shape

Platform instance

Call Signature​

static create(properties?): Platform

Creates a new Platform instance using the specified properties.

Parameters​
properties?​

$Properties

Properties to set

Returns​

Platform

Platform instance

decode()​

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

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

Platform & $Shape

Platform

Throws​

If the payload is not a reader or valid buffer

Throws​

If required fields are missing

decodeDelimited()​

static decodeDelimited(reader): Platform & $Shape

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

Parameters​

reader​

Uint8Array<ArrayBufferLike> | Reader

Reader or buffer to decode from

Returns​

Platform & $Shape

Platform

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

Parameters​

message​

$Properties

Platform message or plain object to encode

writer?​

Writer

Writer to encode to

Returns​

Writer

Writer

encodeDelimited()​

static encodeDelimited(message, writer?): Writer

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

Parameters​

message​

$Properties

Platform message or plain object to encode

writer?​

Writer

Writer to encode to

Returns​

Writer

Writer

fromObject()​

static fromObject(object): Platform

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

Parameters​

object​

Plain object

Returns​

Platform

Platform

toObject()​

static toObject(message, options?): object

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

Parameters​

message​

Platform

Platform

options?​

IConversionOptions

Conversion options

Returns​

object

Plain object