Skip to main content

Interface: Configuration

Indexable

[key: string]: any

Methods

get()

Call Signature

get<T>(section): undefined | T

Return a value from this configuration.

Type Parameters

T

Parameters
section

string

Configuration name, supports dotted names.

Returns

undefined | T

The value section denotes or undefined.

Defined in

packages/extension-api/src/extension-api.d.ts:1165

Call Signature

get<T>(section, defaultValue): T

Return a value from this configuration.

Type Parameters

T

Parameters
section

string

Configuration name, supports dotted names.

defaultValue

T

A value should be returned when no value could be found, is undefined.

Returns

T

The value section denotes or the default.

Defined in

packages/extension-api/src/extension-api.d.ts:1174


has()

has(section): boolean

Check if this configuration has a certain value.

Parameters

section

string

Configuration name, supports dotted names.

Returns

boolean

true if the section doesn't resolve to undefined.

Defined in

packages/extension-api/src/extension-api.d.ts:1182


update()

update(section, value): Promise<void>

Update a configuration value. The updated configuration values are persisted.

Parameters

section

string

value

any

Returns

Promise<void>

Defined in

packages/extension-api/src/extension-api.d.ts:1188