SettingsService

class

Properties

Name	Type	Description
`id (readonly)`	`"workbench.contrib.settings-service"`	Unique identifier of the contribution.
`onDidChange (readonly)`	`Observable<Record<string, Setting[]>>`

`activate()`

Signature

activate(): Promise<void>

Returns

Promise<void>

`deactivate()`

Signature

deactivate(): void

Returns

void

`extract()`

Signature

extract(groupName: string): object

Parameters

groupName (string)

Returns

object

`get()`

Signature

get(groupName: string, settingName: string): Setting | undefined

Parameters

groupName (string)
settingName (string)

Returns

Setting | undefined

`getAll()`

Signature

getAll(): Record<string, Settings.Setting[]>

Returns

Record<string, Settings.Setting[]>

`ofGroup()`

Signature

ofGroup(groupName: string): Setting[]

Parameters

groupName (string)

Returns

Setting[]

`register()`

Signature

register(value: Setting): void

Parameters

value (Setting)

Returns

void

`save()`

Signature

save(): void

Returns

void

`set()`

Signature

set(groupName: string, settingName: string, value: any): void

Parameters

groupName (string)
settingName (string)
value (any)

Returns

void

`update()`

Signature

update(groups: Group[]): void

Parameters

groups (Group[])

Returns

void

Edit this page