Skip to main content

Interface: Configuration

Indexable

[key: string]: any

Methods

get()

get(section)

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.

Source

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

get(section, defaultValue)

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.

Source

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


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.

Source

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


update()

update(section, value): Promise<void>

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

Parameters

section: string

value: any

Returns

Promise<void>

Source

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