Skip to main content

Class: HostingEnvironment

Represents a HostingEnvironment.

Properties​

type​

type: HostingEnvironmentType

The type of hosting environment.

version​

version: string

The version of the hosting environment, if obtainable.

Methods​

toJSON()​

toJSON(): object

Converts this HostingEnvironment to JSON.

Returns​

object

JSON object

create()​

Call Signature​

static create(properties?): HostingEnvironment & $Properties

Creates a new HostingEnvironment instance using the specified properties.

Parameters​
properties?​

$Properties

Properties to set

Returns​

HostingEnvironment & $Properties

HostingEnvironment instance

Call Signature​

static create(properties?): HostingEnvironment

Creates a new HostingEnvironment instance using the specified properties.

Parameters​
properties?​

$Properties

Properties to set

Returns​

HostingEnvironment

HostingEnvironment instance

decode()​

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

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

HostingEnvironment & $Properties

HostingEnvironment

Throws​

If the payload is not a reader or valid buffer

Throws​

If required fields are missing

decodeDelimited()​

static decodeDelimited(reader): HostingEnvironment & $Properties

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

Parameters​

reader​

Uint8Array<ArrayBufferLike> | Reader

Reader or buffer to decode from

Returns​

HostingEnvironment & $Properties

HostingEnvironment

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

Parameters​

message​

$Properties

HostingEnvironment message or plain object to encode

writer?​

Writer

Writer to encode to

Returns​

Writer

Writer

encodeDelimited()​

static encodeDelimited(message, writer?): Writer

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

Parameters​

message​

$Properties

HostingEnvironment message or plain object to encode

writer?​

Writer

Writer to encode to

Returns​

Writer

Writer

fromObject()​

static fromObject(object): HostingEnvironment

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

Parameters​

object​

Plain object

Returns​

HostingEnvironment

HostingEnvironment

toObject()​

static toObject(message, options?): object

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

Parameters​

message​

HostingEnvironment

HostingEnvironment

options?​

IConversionOptions

Conversion options

Returns​

object

Plain object