Readable dictionary that backs this configuration.
Return a value from this configuration.
Configuration name, supports dotted names.
The value section
denotes or undefined
.
Return a value from this configuration.
Configuration name, supports dotted names.
A value should be returned when no value could be found, is undefined
.
The value section
denotes or the default.
Check if this configuration has a certain value.
Configuration name, supports dotted names.
true
if the section doesn't resolve to undefined
.
Retrieve all information about a configuration setting. A configuration value often consists of a default value, a global or installation-wide value, a workspace-specific value, folder-specific value and language-specific values (if WorkspaceConfiguration is scoped to a language).
Also provides all language ids under which the given configuration setting is defined.
Note: The configuration name must denote a leaf in the configuration tree
(editor.fontSize
vs editor
) otherwise no result is returned.
Configuration name, supports dotted names.
Information about a configuration setting or undefined
.
Update a configuration value. The updated configuration values are persisted.
A value can be changed in
Note: To remove a configuration value use undefined
, like so: config.update('somekey', undefined)
Configuration name, supports dotted names.
The new value.
The configuration target or a boolean value.
- If true
updates Global settings.
- If false
updates Workspace settings.
- If undefined
or null
updates to Workspace folder settings if configuration is resource specific,
otherwise to Workspace settings.
Whether to update the value in the scope of requested languageId or not.
- If true
updates the value under the requested languageId.
- If undefined
updates the value under the requested languageId only if the configuration is defined for the language.
Represents the configuration. It is a merged view of
The effective value (returned by
get
) is computed by overriding or merging the values in the following order:defaultValue
(if defined inpackage.json
otherwise derived from the value's type)globalValue
(if defined)workspaceValue
(if defined)workspaceFolderValue
(if defined)defaultLanguageValue
(if defined)globalLanguageValue
(if defined)workspaceLanguageValue
(if defined)workspaceFolderLanguageValue
(if defined)Note: Only
object
value types are merged and all other value types are overridden.Example 1: Overriding
Example 2: Language Values
Example 3: Object Values
Note: Workspace and Workspace Folder configurations contains
launch
andtasks
settings. Their basename will be part of the section identifier. The following snippets shows how to retrieve all configurations fromlaunch.json
:Refer to Settings for more information.