Skip to main content

Class: WorkspaceModuleSetting

A constructor-backed module setting.

Extends​

  • BaseClient

Constructors​

Constructor​

new WorkspaceModuleSetting(ctx?, _id?, _description?, _key?, _value?): WorkspaceModuleSetting

Constructor is used for internal usage only, do not create object from it.

Parameters​

ctx?​

Context

_id?​

ID

_description?​

string

_key?​

string

_value?​

string

Returns​

WorkspaceModuleSetting

Overrides​

BaseClient.constructor

Methods​

description()​

description(): Promise<string>

The constructor argument description.

Returns​

Promise<string>

id()​

id(): Promise<ID>

A unique identifier for this WorkspaceModuleSetting.

Returns​

Promise<ID>

key()​

key(): Promise<string>

The setting key.

Returns​

Promise<string>

value()​

value(): Promise<string>

The configured value after applying the selected workspace environment, or empty when unset.

Returns​

Promise<string>