Interface: Configuration
Defined in: packages/extension-api/src/extension-api.d.ts:1258
Indexable
[
key:string]:any
Readable dictionary that backs this configuration.
Methods
get()
Call Signature
get<
T>(section):T|undefined
Defined in: packages/extension-api/src/extension-api.d.ts:1265
Return a value from this configuration.
Type Parameters
T
T
Parameters
section
string
Configuration name, supports dotted names.
Returns
T | undefined
The value section denotes or undefined.
Call Signature
get<
T>(section,defaultValue):T
Defined in: packages/extension-api/src/extension-api.d.ts:1274
Return a value from this configuration.
Type Parameters
T
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.
has()
has(
section):boolean
Defined in: packages/extension-api/src/extension-api.d.ts:1282
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.
update()
update(
section,value):Promise<void>
Defined in: packages/extension-api/src/extension-api.d.ts:1288
Update a configuration value. The updated configuration values are persisted.
Parameters
section
string
value
any
Returns
Promise<void>