<!doctype html>
< html class = "default no-js" lang = "zh-CN" >
< head >
< meta charset = "utf-8" >
< meta http-equiv = "X-UA-Compatible" content = "IE=edge" >
< title > WorkspaceConfiguration | VS Code API 中文文档< / title >
< meta name = "description" content = "VS Code API 是一系列你可以在 Visual Studio Code 扩展中调用的 JavaScript API， >
< meta name = "author" content = "洛竹" >
< meta name = "copyright" content = "洛竹" >
< meta property = "og:title" content = "Vscode Api 中文文档" / >
< meta property = "og:type" content = "docs" >
< meta property = "og:image" content = "https://code.visualstudio.com/favicon.ico" / >
< meta property = "og:url" content = "https://vscode-api-cn.js.org/index.html" >
< meta property = "og:site_name" content = "Vscode Api 中文文档" >
< meta property = "article:tag" content = "vscode api" >
< meta property = "article:tag" content = "vscode api 中文文档" >
< meta property = "article:tag" content = "vscode 插件" >
< meta property = "article:tag" content = "vscode 插件开发" >
< meta property = "article:tag" content = "vscode VS Code API 中文文档" >
< meta property = "article:tag" content = "vscode WorkspaceConfiguration" >
< meta property = "og:description" content = "VS Code API 是一系列你可以在 Visual Studio Code 扩展中调用的 JavaScript API， >
< meta name = "viewport" content = "width=device-width, initial-scale=1" >
< link rel = "shortcut icon" href = "https://code.visualstudio.com/favicon.ico" sizes = "128x128" >
< link rel = 'canonical' href = 'https://vscode-api-cn.js.org/interfaces/vscode.WorkspaceConfiguration.html' / >
< link rel = "stylesheet" href = "../assets/css/main.css" >
< script async src = "../assets/js/search.js" id = "search-script" > < / script >
< script async src = "https://pagead2.googlesyndication.com/pagead/js/adsbygoogle.js?client=ca-pub-7962287588031867" crossorigin = "anonymous" > < / script >
< script type = "text/javascript" >
(function (c, l, a, r, i, t, y) {
c[a] = c[a] || function () { (c[a].q = c[a].q || []).push(arguments) };
t = l.createElement(r); t.async = 1; t.src = "https://www.clarity.ms/tag/" + i;
y = l.getElementsByTagName(r)[0]; y.parentNode.insertBefore(t, y);
})(window, document, "clarity", "script", "g1cbw4nxoq");
< / script >
<!-- Google tag (gtag.js) -->
< script async src = "https://www.googletagmanager.com/gtag/js?id=G-T4TRRS1LB1" > < / script >
< script >
window.dataLayer = window.dataLayer || [];
function gtag(){dataLayer.push(arguments);}
gtag('js', new Date());
gtag('config', 'G-T4TRRS1LB1');
< / script >
< style >
.container-main {
padding-bottom: 50px;
}
< / style >
< / head >
< body >
< header >
< div class = "tsd-page-toolbar" >
< div class = "container" >
< div class = "table-wrap" >
< div class = "table-cell" id = "tsd-search" data-index = "../assets/js/search.json" data-base = ".." >
< div class = "field" >
< label for = "tsd-search-field" class = "tsd-widget search no-caption" > Search< / label >
< input id = "tsd-search-field" type = "text" / >
< / div >
< ul class = "results" >
< li class = "state loading" > Preparing search index...< / li >
< li class = "state failure" > The search index is not available< / li >
< / ul >
< a href = "../index.html" class = "title" > VS Code API 中文文档< / a >
< / div >
< div class = "table-cell" id = "tsd-widgets" >
< div id = "tsd-filter" >
< a href = "#" class = "tsd-widget options no-caption" data-toggle = "options" > Options< / a >
< div class = "tsd-filter-group" >
< div class = "tsd-select" id = "tsd-filter-visibility" >
< span class = "tsd-select-label" > All< / span >
< ul class = "tsd-select-list" >
< li data-value = "public" > Public< / li >
< li data-value = "protected" > Public/Protected< / li >
< li data-value = "private" class = "selected" > All< / li >
< / ul >
< / div >
< input type = "checkbox" id = "tsd-filter-inherited" checked / >
< label class = "tsd-widget" for = "tsd-filter-inherited" > Inherited< / label >
< input type = "checkbox" id = "tsd-filter-externals" checked / >
< label class = "tsd-widget" for = "tsd-filter-externals" > Externals< / label >
< / div >
< / div >
< a href = "#" class = "tsd-widget menu no-caption" data-toggle = "menu" > Menu< / a >
< / div >
< / div >
< / div >
< / div >
< div class = "tsd-page-title" >
< div class = "container" >
< ul class = "tsd-breadcrumb" >
< li >
< a href = "../modules.html" > VS Code API 中文文档< / a >
< / li >
< li >
< a href = "../modules/vscode.html" > vscode< / a >
< / li >
< li >
< a href = "vscode.WorkspaceConfiguration.html" > WorkspaceConfiguration< / a >
< / li >
< / ul >
< h1 > Interface WorkspaceConfiguration< / h1 >
< / div >
< / div >
< / header >
< div class = "container container-main" >
< div class = "row" >
< div class = "col-8 col-content" >
< section class = "tsd-panel tsd-comment" >
< div class = "tsd-comment tsd-typography" >
< div class = "lead" >
< p > Represents the configuration. It is a merged view of< / p >
< / div >
< ul >
< li > < em > Default Settings< / em > < / li >
< li > < em > Global (User) Settings< / em > < / li >
< li > < em > Workspace settings< / em > < / li >
< li > < em > Workspace Folder settings< / em > - From one of the < a href = "../modules/vscode.workspace.html#workspaceFolders" > Workspace Folders< / a > under which requested resource belongs to.< / li >
< li > < em > Language settings< / em > - Settings defined under requested language.< / li >
< / ul >
< p > The < em > effective< / em > value (returned by < a href = "vscode.WorkspaceConfiguration.html#get" > < code > get< / code > < / a > ) is computed by overriding or merging the values in the following order.< / p >
< pre > < code > < span style = "color: #A31515" > `defaultValue`< / span > < span style = "color: #000000" > (< / span > < span style = "color: #001080" > if< / span > < span style = "color: #000000" > < / span > < span style = "color: #001080" > defined< / span > < span style = "color: #000000" > < / span > < span style = "color: #0000FF" > in< / span > < span style = "color: #000000" > < / span > < span style = "color: #A31515" > `package.json`< / span > < span style = "color: #000000" > < / span > < span style = "color: #001080" > otherwise< / span > < span style = "color: #000000" > < / span > < span style = "color: #001080" > derived< / span > < span style = "color: #000000" > < / span > < span style = "color: #001080" > from< / span > < span style = "color: #000000" > < / span > < span style = "color: #001080" > the< / span > < span style = "color: #000000" > < / span > < span style = "color: #001080" > value< / span > < span style = "color: #A31515" > ' s type< / span > < span style = "color: #CD3131" > )< / span >
< span style = "color: #A31515" > `globalValue`< / span > < span style = "color: #000000" > (< / span > < span style = "color: #001080" > if< / span > < span style = "color: #000000" > < / span > < span style = "color: #001080" > defined< / span > < span style = "color: #000000" > )< / span >
< span style = "color: #A31515" > `workspaceValue`< / span > < span style = "color: #000000" > (< / span > < span style = "color: #001080" > if< / span > < span style = "color: #000000" > < / span > < span style = "color: #001080" > defined< / span > < span style = "color: #000000" > )< / span >
< span style = "color: #A31515" > `workspaceFolderValue`< / span > < span style = "color: #000000" > (< / span > < span style = "color: #001080" > if< / span > < span style = "color: #000000" > < / span > < span style = "color: #001080" > defined< / span > < span style = "color: #000000" > )< / span >
< span style = "color: #A31515" > `defaultLanguageValue`< / span > < span style = "color: #000000" > (< / span > < span style = "color: #001080" > if< / span > < span style = "color: #000000" > < / span > < span style = "color: #001080" > defined< / span > < span style = "color: #000000" > )< / span >
< span style = "color: #A31515" > `globalLanguageValue`< / span > < span style = "color: #000000" > (< / span > < span style = "color: #001080" > if< / span > < span style = "color: #000000" > < / span > < span style = "color: #001080" > defined< / span > < span style = "color: #000000" > )< / span >
< span style = "color: #A31515" > `workspaceLanguageValue`< / span > < span style = "color: #000000" > (< / span > < span style = "color: #001080" > if< / span > < span style = "color: #000000" > < / span > < span style = "color: #001080" > defined< / span > < span style = "color: #000000" > )< / span >
< span style = "color: #A31515" > `workspaceFolderLanguageValue`< / span > < span style = "color: #000000" > (< / span > < span style = "color: #001080" > if< / span > < span style = "color: #000000" > < / span > < span style = "color: #001080" > defined< / span > < span style = "color: #000000" > )< / span >
< / code > < / pre >
< p > < strong > Note:< / strong > Only < code > object< / code > value types are merged and all other value types are overridden.< / p >
< p > Example 1: Overriding< / p >
< pre > < code class = "language-ts" > < span style = "color: #001080" > defaultValue< / span > < span style = "color: #000000" > = < / span > < span style = "color: #A31515" > ' on' < / span > < span style = "color: #000000" > ;< / span >
< span style = "color: #001080" > globalValue< / span > < span style = "color: #000000" > = < / span > < span style = "color: #A31515" > ' relative' < / span >
< span style = "color: #001080" > workspaceFolderValue< / span > < span style = "color: #000000" > = < / span > < span style = "color: #A31515" > ' off' < / span >
< span style = "color: #001080" > value< / span > < span style = "color: #000000" > = < / span > < span style = "color: #A31515" > ' off' < / span >
< / code > < / pre >
< p > Example 2: Language Values< / p >
< pre > < code class = "language-ts" > < span style = "color: #001080" > defaultValue< / span > < span style = "color: #000000" > = < / span > < span style = "color: #A31515" > ' on' < / span > < span style = "color: #000000" > ;< / span >
< span style = "color: #001080" > globalValue< / span > < span style = "color: #000000" > = < / span > < span style = "color: #A31515" > ' relative' < / span >
< span style = "color: #001080" > workspaceFolderValue< / span > < span style = "color: #000000" > = < / span > < span style = "color: #A31515" > ' off' < / span >
< span style = "color: #001080" > globalLanguageValue< / span > < span style = "color: #000000" > = < / span > < span style = "color: #A31515" > ' on' < / span >
< span style = "color: #001080" > value< / span > < span style = "color: #000000" > = < / span > < span style = "color: #A31515" > ' on' < / span >
< / code > < / pre >
< p > Example 3: Object Values< / p >
< pre > < code class = "language-ts" > < span style = "color: #001080" > defaultValue< / span > < span style = "color: #000000" > = { < / span > < span style = "color: #A31515" > " a" < / span > < span style = "color: #001080" > :< / span > < span style = "color: #000000" > < / span > < span style = "color: #098658" > 1< / span > < span style = "color: #000000" > , < / span > < span style = "color: #A31515" > " b" < / span > < span style = "color: #001080" > :< / span > < span style = "color: #000000" > < / span > < span style = "color: #098658" > 2< / span > < span style = "color: #000000" > };< / span >
< span style = "color: #001080" > globalValue< / span > < span style = "color: #000000" > = { < / span > < span style = "color: #A31515" > " b" < / span > < span style = "color: #001080" > :< / span > < span style = "color: #000000" > < / span > < span style = "color: #098658" > 3< / span > < span style = "color: #000000" > , < / span > < span style = "color: #A31515" > " c" < / span > < span style = "color: #001080" > :< / span > < span style = "color: #000000" > < / span > < span style = "color: #098658" > 4< / span > < span style = "color: #000000" > };< / span >
< span style = "color: #001080" > value< / span > < span style = "color: #000000" > = { < / span > < span style = "color: #A31515" > " a" < / span > < span style = "color: #001080" > :< / span > < span style = "color: #000000" > < / span > < span style = "color: #098658" > 1< / span > < span style = "color: #000000" > , < / span > < span style = "color: #A31515" > " b" < / span > < span style = "color: #001080" > :< / span > < span style = "color: #000000" > < / span > < span style = "color: #098658" > 3< / span > < span style = "color: #000000" > , < / span > < span style = "color: #A31515" > " c" < / span > < span style = "color: #001080" > :< / span > < span style = "color: #000000" > < / span > < span style = "color: #098658" > 4< / span > < span style = "color: #000000" > };< / span >
< / code > < / pre >
< p > < em > Note:< / em > Workspace and Workspace Folder configurations contains < code > launch< / code > and < code > tasks< / code > settings. Their basename will be
part of the section identifier. The following snippets shows how to retrieve all configurations
from < code > launch.json< / code > :< / p >
< pre > < code class = "language-ts" > < span style = "color: #008000" > // launch.json configuration< / span >
< span style = "color: #0000FF" > const< / span > < span style = "color: #000000" > < / span > < span style = "color: #0070C1" > config< / span > < span style = "color: #000000" > = < / span > < span style = "color: #001080" > workspace< / span > < span style = "color: #000000" > .< / span > < span style = "color: #795E26" > getConfiguration< / span > < span style = "color: #000000" > (< / span > < span style = "color: #A31515" > ' launch' < / span > < span style = "color: #000000" > , < / span > < span style = "color: #001080" > vscode< / span > < span style = "color: #000000" > .< / span > < span style = "color: #001080" > workspace< / span > < span style = "color: #000000" > .< / span > < span style = "color: #001080" > workspaceFolders< / span > < span style = "color: #000000" > [< / span > < span style = "color: #098658" > 0< / span > < span style = "color: #000000" > ].< / span > < span style = "color: #001080" > uri< / span > < span style = "color: #000000" > );< / span >
< span style = "color: #008000" > // retrieve values< / span >
< span style = "color: #0000FF" > const< / span > < span style = "color: #000000" > < / span > < span style = "color: #0070C1" > values< / span > < span style = "color: #000000" > = < / span > < span style = "color: #001080" > config< / span > < span style = "color: #000000" > .< / span > < span style = "color: #795E26" > get< / span > < span style = "color: #000000" > (< / span > < span style = "color: #A31515" > ' configurations' < / span > < span style = "color: #000000" > );< / span >
< / code > < / pre >
< p > Refer to < a href = "https://code.visualstudio.com/docs/getstarted/settings" > Settings< / a > for more information.< / p >
< / div >
< / section >
< section class = "tsd-panel tsd-hierarchy" >
< h3 > 层级< / h3 >
< ul class = "tsd-hierarchy" >
< li >
< span class = "target" > WorkspaceConfiguration< / span >
< / li >
< / ul >
< / section >
< section class = "tsd-panel tsd-kind-interface tsd-parent-kind-namespace" >
< h3 class = "tsd-before-signature" > Indexable< / h3 >
< div class = "tsd-signature tsd-kind-icon" > < span class = "tsd-signature-symbol" > [< / span > key: < span class = "tsd-signature-type" > string< / span > < span class = "tsd-signature-symbol" > ]: < / span > < span class = "tsd-signature-type" > any< / span > < / div >
< div class = "tsd-comment tsd-typography" >
< div class = "lead" >
< p > Readable dictionary that backs this configuration.< / p >
< / div >
< / div >
< / section >
< section class = "tsd-panel-group tsd-index-group" >
< h2 > 索引< / h2 >
< section class = "tsd-panel tsd-index-panel" >
< div class = "tsd-index-content" >
< section class = "tsd-index-section " >
< h3 > Methods（ ） < / h3 >
< ul class = "tsd-index-list" >
< li class = "tsd-kind-method tsd-parent-kind-interface tsd-has-type-parameter" > < a href = "vscode.WorkspaceConfiguration.html#get" class = "tsd-kind-icon" > get< / a > < / li >
< li class = "tsd-kind-method tsd-parent-kind-interface" > < a href = "vscode.WorkspaceConfiguration.html#has" class = "tsd-kind-icon" > has< / a > < / li >
< li class = "tsd-kind-method tsd-parent-kind-interface tsd-has-type-parameter" > < a href = "vscode.WorkspaceConfiguration.html#inspect" class = "tsd-kind-icon" > inspect< / a > < / li >
< li class = "tsd-kind-method tsd-parent-kind-interface" > < a href = "vscode.WorkspaceConfiguration.html#update" class = "tsd-kind-icon" > update< / a > < / li >
< / ul >
< / section >
< / div >
< / section >
< / section >
< section class = "tsd-panel-group tsd-member-group " >
< h2 > Methods（ ） < / h2 >
< section class = "tsd-panel tsd-member tsd-kind-method tsd-parent-kind-interface tsd-has-type-parameter" >
< a name = "get" class = "tsd-anchor" > < / a >
< h3 > get< / h3 >
< ul class = "tsd-signatures tsd-kind-method tsd-parent-kind-interface tsd-has-type-parameter" >
< li class = "tsd-signature tsd-kind-icon" > get< T> < span class = "tsd-signature-symbol" > (< / span > section< span class = "tsd-signature-symbol" > : < / span > < span class = "tsd-signature-type" > string< / span > < span class = "tsd-signature-symbol" > )< / span > < span class = "tsd-signature-symbol" > : < / span > < span class = "tsd-signature-type" > undefined< / span > < span class = "tsd-signature-symbol" > | < / span > < span class = "tsd-signature-type" > T< / span > < / li >
< li class = "tsd-signature tsd-kind-icon" > get< T> < span class = "tsd-signature-symbol" > (< / span > section< span class = "tsd-signature-symbol" > : < / span > < span class = "tsd-signature-type" > string< / span > , defaultValue< span class = "tsd-signature-symbol" > : < / span > < span class = "tsd-signature-type" > T< / span > < span class = "tsd-signature-symbol" > )< / span > < span class = "tsd-signature-symbol" > : < / span > < span class = "tsd-signature-type" > T< / span > < / li >
< / ul >
< ul class = "tsd-descriptions" >
< li class = "tsd-description" >
< aside class = "tsd-sources" >
< ul >
< li > Defined in < a href = "https://github.com/youngjuning/vscode-api-cn/blob/bb17da2/vscode.d.ts#L5079" > vscode.d.ts:5079< / a > < / li >
< / ul >
< / aside >
< div class = "tsd-comment tsd-typography" >
< div class = "lead" >
< p > Return a value from this configuration.< / p >
< / div >
< / div >
< h4 class = "tsd-type-parameters-title" > Type parameters< / h4 >
< ul class = "tsd-type-parameters" >
< li >
< h4 > T< / h4 >
< / li >
< / ul >
< h4 class = "tsd-parameters-title" > Parameters< / h4 >
< ul class = "tsd-parameters" >
< li >
< h5 > section: < span class = "tsd-signature-type" > string< / span > < / h5 >
< div class = "tsd-comment tsd-typography" >
< p > Configuration name, supports < em > dotted< / em > names.< / p >
< / div >
< / li >
< / ul >
< h4 class = "tsd-returns-title" > Returns < span class = "tsd-signature-type" > undefined< / span > < span class = "tsd-signature-symbol" > | < / span > < span class = "tsd-signature-type" > T< / span > < / h4 >
< p > The value < code > section< / code > denotes or < code > undefined< / code > .< / p >
< / li >
< li class = "tsd-description" >
< aside class = "tsd-sources" >
< ul >
< li > Defined in < a href = "https://github.com/youngjuning/vscode-api-cn/blob/bb17da2/vscode.d.ts#L5088" > vscode.d.ts:5088< / a > < / li >
< / ul >
< / aside >
< div class = "tsd-comment tsd-typography" >
< div class = "lead" >
< p > Return a value from this configuration.< / p >
< / div >
< / div >
< h4 class = "tsd-type-parameters-title" > Type parameters< / h4 >
< ul class = "tsd-type-parameters" >
< li >
< h4 > T< / h4 >
< / li >
< / ul >
< h4 class = "tsd-parameters-title" > Parameters< / h4 >
< ul class = "tsd-parameters" >
< li >
< h5 > section: < span class = "tsd-signature-type" > string< / span > < / h5 >
< div class = "tsd-comment tsd-typography" >
< p > Configuration name, supports < em > dotted< / em > names.< / p >
< / div >
< / li >
< li >
< h5 > defaultValue: < span class = "tsd-signature-type" > T< / span > < / h5 >
< div class = "tsd-comment tsd-typography" >
< p > A value should be returned when no value could be found, is < code > undefined< / code > .< / p >
< / div >
< / li >
< / ul >
< h4 class = "tsd-returns-title" > Returns < span class = "tsd-signature-type" > T< / span > < / h4 >
< p > The value < code > section< / code > denotes or the default.< / p >
< / li >
< / ul >
< / section >
< section class = "tsd-panel tsd-member tsd-kind-method tsd-parent-kind-interface" >
< a name = "has" class = "tsd-anchor" > < / a >
< h3 > has< / h3 >
< ul class = "tsd-signatures tsd-kind-method tsd-parent-kind-interface" >
< li class = "tsd-signature tsd-kind-icon" > has< span class = "tsd-signature-symbol" > (< / span > section< span class = "tsd-signature-symbol" > : < / span > < span class = "tsd-signature-type" > string< / span > < span class = "tsd-signature-symbol" > )< / span > < span class = "tsd-signature-symbol" > : < / span > < span class = "tsd-signature-type" > boolean< / span > < / li >
< / ul >
< ul class = "tsd-descriptions" >
< li class = "tsd-description" >
< aside class = "tsd-sources" >
< ul >
< li > Defined in < a href = "https://github.com/youngjuning/vscode-api-cn/blob/bb17da2/vscode.d.ts#L5096" > vscode.d.ts:5096< / a > < / li >
< / ul >
< / aside >
< div class = "tsd-comment tsd-typography" >
< div class = "lead" >
< p > Check if this configuration has a certain value.< / p >
< / div >
< / div >
< h4 class = "tsd-parameters-title" > Parameters< / h4 >
< ul class = "tsd-parameters" >
< li >
< h5 > section: < span class = "tsd-signature-type" > string< / span > < / h5 >
< div class = "tsd-comment tsd-typography" >
< p > Configuration name, supports < em > dotted< / em > names.< / p >
< / div >
< / li >
< / ul >
< h4 class = "tsd-returns-title" > Returns < span class = "tsd-signature-type" > boolean< / span > < / h4 >
< p > < code > true< / code > if the section doesn' t resolve to < code > undefined< / code > .< / p >
< / li >
< / ul >
< / section >
< section class = "tsd-panel tsd-member tsd-kind-method tsd-parent-kind-interface tsd-has-type-parameter" >
< a name = "inspect" class = "tsd-anchor" > < / a >
< h3 > inspect< / h3 >
< ul class = "tsd-signatures tsd-kind-method tsd-parent-kind-interface tsd-has-type-parameter" >
< li class = "tsd-signature tsd-kind-icon" > inspect< T> < span class = "tsd-signature-symbol" > (< / span > section< span class = "tsd-signature-symbol" > : < / span > < span class = "tsd-signature-type" > string< / span > < span class = "tsd-signature-symbol" > )< / span > < span class = "tsd-signature-symbol" > : < / span > < span class = "tsd-signature-type" > undefined< / span > < span class = "tsd-signature-symbol" > | < / span > < span class = "tsd-signature-symbol" > { < / span > key< span class = "tsd-signature-symbol" > : < / span > < span class = "tsd-signature-type" > string< / span > < span class = "tsd-signature-symbol" > ; < / span > defaultValue< span class = "tsd-signature-symbol" > ?: < / span > < span class = "tsd-signature-type" > T< / span > < span class = "tsd-signature-symbol" > ; < / span > globalValue< span class = "tsd-signature-symbol" > ?: < / span > < span class = "tsd-signature-type" > T< / span > < span class = "tsd-signature-symbol" > ; < / span > workspaceValue< span class = "tsd-signature-symbol" > ?: < / span > < span class = "tsd-signature-type" > T< / span > < span class = "tsd-signature-symbol" > ; < / span > workspaceFolderValue< span class = "tsd-signature-symbol" > ?: < / span > < span class = "tsd-signature-type" > T< / span > < span class = "tsd-signature-symbol" > ; < / span > defaultLanguageValue< span class = "tsd-signature-symbol" > ?: < / span > < span class = "tsd-signature-type" > T< / span > < span class = "tsd-signature-symbol" > ; < / span > globalLanguageValue< span class = "tsd-signature-symbol" > ?: < / span > < span class = "tsd-signature-type" > T< / span > < span class = "tsd-signature-symbol" > ; < / span > workspaceLanguageValue< span class = "tsd-signature-symbol" > ?: < / span > < span class = "tsd-signature-type" > T< / span > < span class = "tsd-signature-symbol" > ; < / span > workspaceFolderLanguageValue< span class = "tsd-signature-symbol" > ?: < / span > < span class = "tsd-signature-type" > T< / span > < span class = "tsd-signature-symbol" > ; < / span > languageIds< span class = "tsd-signature-symbol" > ?: < / span > < span class = "tsd-signature-type" > string< / span > < span class = "tsd-signature-symbol" > []< / span > < span class = "tsd-signature-symbol" > }< / span > < / li >
< / ul >
< ul class = "tsd-descriptions" >
< li class = "tsd-description" >
< aside class = "tsd-sources" >
< ul >
< li > Defined in < a href = "https://github.com/youngjuning/vscode-api-cn/blob/bb17da2/vscode.d.ts#L5112" > vscode.d.ts:5112< / a > < / li >
< / ul >
< / aside >
< div class = "tsd-comment tsd-typography" >
< div class = "lead" >
< p > Retrieve all information about a configuration setting. A configuration value
often consists of a < em > default< / em > value, a global or installation-wide value,
a workspace-specific value, folder-specific value
and language-specific values (if < a href = "vscode.WorkspaceConfiguration.html" > WorkspaceConfiguration< / a > is scoped to a language).< / p >
< / div >
< p > Also provides all language ids under which the given configuration setting is defined.< / p >
< p > < em > Note:< / em > The configuration name must denote a leaf in the configuration tree
(< code > editor.fontSize< / code > vs < code > editor< / code > ) otherwise no result is returned.< / p >
< / div >
< h4 class = "tsd-type-parameters-title" > Type parameters< / h4 >
< ul class = "tsd-type-parameters" >
< li >
< h4 > T< / h4 >
< / li >
< / ul >
< h4 class = "tsd-parameters-title" > Parameters< / h4 >
< ul class = "tsd-parameters" >
< li >
< h5 > section: < span class = "tsd-signature-type" > string< / span > < / h5 >
< div class = "tsd-comment tsd-typography" >
< p > Configuration name, supports < em > dotted< / em > names.< / p >
< / div >
< / li >
< / ul >
< h4 class = "tsd-returns-title" > Returns < span class = "tsd-signature-type" > undefined< / span > < span class = "tsd-signature-symbol" > | < / span > < span class = "tsd-signature-symbol" > { < / span > key< span class = "tsd-signature-symbol" > : < / span > < span class = "tsd-signature-type" > string< / span > < span class = "tsd-signature-symbol" > ; < / span > defaultValue< span class = "tsd-signature-symbol" > ?: < / span > < span class = "tsd-signature-type" > T< / span > < span class = "tsd-signature-symbol" > ; < / span > globalValue< span class = "tsd-signature-symbol" > ?: < / span > < span class = "tsd-signature-type" > T< / span > < span class = "tsd-signature-symbol" > ; < / span > workspaceValue< span class = "tsd-signature-symbol" > ?: < / span > < span class = "tsd-signature-type" > T< / span > < span class = "tsd-signature-symbol" > ; < / span > workspaceFolderValue< span class = "tsd-signature-symbol" > ?: < / span > < span class = "tsd-signature-type" > T< / span > < span class = "tsd-signature-symbol" > ; < / span > defaultLanguageValue< span class = "tsd-signature-symbol" > ?: < / span > < span class = "tsd-signature-type" > T< / span > < span class = "tsd-signature-symbol" > ; < / span > globalLanguageValue< span class = "tsd-signature-symbol" > ?: < / span > < span class = "tsd-signature-type" > T< / span > < span class = "tsd-signature-symbol" > ; < / span > workspaceLanguageValue< span class = "tsd-signature-symbol" > ?: < / span > < span class = "tsd-signature-type" > T< / span > < span class = "tsd-signature-symbol" > ; < / span > workspaceFolderLanguageValue< span class = "tsd-signature-symbol" > ?: < / span > < span class = "tsd-signature-type" > T< / span > < span class = "tsd-signature-symbol" > ; < / span > languageIds< span class = "tsd-signature-symbol" > ?: < / span > < span class = "tsd-signature-type" > string< / span > < span class = "tsd-signature-symbol" > []< / span > < span class = "tsd-signature-symbol" > }< / span > < / h4 >
< p > Information about a configuration setting or < code > undefined< / code > .< / p >
< / li >
< / ul >
< / section >
< section class = "tsd-panel tsd-member tsd-kind-method tsd-parent-kind-interface" >
< a name = "update" class = "tsd-anchor" > < / a >
< h3 > update< / h3 >
< ul class = "tsd-signatures tsd-kind-method tsd-parent-kind-interface" >
< li class = "tsd-signature tsd-kind-icon" > update< span class = "tsd-signature-symbol" > (< / span > section< span class = "tsd-signature-symbol" > : < / span > < span class = "tsd-signature-type" > string< / span > , value< span class = "tsd-signature-symbol" > : < / span > < span class = "tsd-signature-type" > any< / span > , configurationTarget< span class = "tsd-signature-symbol" > ?: < / span > < span class = "tsd-signature-type" > null< / span > < span class = "tsd-signature-symbol" > | < / span > < span class = "tsd-signature-type" > boolean< / span > < span class = "tsd-signature-symbol" > | < / span > < a href = "../enums/vscode.ConfigurationTarget.html" class = "tsd-signature-type" data-tsd-kind = "Enumeration" > ConfigurationTarget< / a > , overrideInLanguage< span class = "tsd-signature-symbol" > ?: < / span > < span class = "tsd-signature-type" > boolean< / span > < span class = "tsd-signature-symbol" > )< / span > < span class = "tsd-signature-symbol" > : < / span > < a href = "Thenable.html" class = "tsd-signature-type" data-tsd-kind = "Interface" > Thenable< / a > < span class = "tsd-signature-symbol" > < < / span > < span class = "tsd-signature-type" > void< / span > < span class = "tsd-signature-symbol" > > < / span > < / li >
< / ul >
< ul class = "tsd-descriptions" >
< li class = "tsd-description" >
< aside class = "tsd-sources" >
< ul >
< li > Defined in < a href = "https://github.com/youngjuning/vscode-api-cn/blob/bb17da2/vscode.d.ts#L5158" > vscode.d.ts:5158< / a > < / li >
< / ul >
< / aside >
< div class = "tsd-comment tsd-typography" >
< div class = "lead" >
< p > Update a configuration value. The updated configuration values are persisted.< / p >
< / div >
< p > A value can be changed in< / p >
< ul >
< li > < a href = "../enums/vscode.ConfigurationTarget.html#Global" > Global settings< / a > : Changes the value for all instances of the editor.< / li >
< li > < a href = "../enums/vscode.ConfigurationTarget.html#Workspace" > Workspace settings< / a > : Changes the value for current workspace, if available.< / li >
< li > < a href = "../enums/vscode.ConfigurationTarget.html#WorkspaceFolder" > Workspace folder settings< / a > : Changes the value for settings from one of the < a href = "../modules/vscode.workspace.html#workspaceFolders" > Workspace Folders< / a > under which the requested resource belongs to.< / li >
< li > Language settings: Changes the value for the requested languageId.< / li >
< / ul >
< p > < em > Note:< / em > To remove a configuration value use < code > undefined< / code > , like so: < code > config.update(' somekey' , undefined)< / code > < / p >
< dl class = "tsd-comment-tags" >
< dt > throws< / dt >
< dd > < p > error while updating
- configuration which is not registered.
- window configuration to workspace folder
- configuration to workspace or workspace folder when no workspace is opened.
- configuration to workspace folder when there is no workspace folder settings.
- configuration to workspace folder when < a href = "vscode.WorkspaceConfiguration.html" > WorkspaceConfiguration< / a > is not scoped to a resource.< / p >
< / dd >
< / dl >
< / div >
< h4 class = "tsd-parameters-title" > Parameters< / h4 >
< ul class = "tsd-parameters" >
< li >
< h5 > section: < span class = "tsd-signature-type" > string< / span > < / h5 >
< div class = "tsd-comment tsd-typography" >
< p > Configuration name, supports < em > dotted< / em > names.< / p >
< / div >
< / li >
< li >
< h5 > value: < span class = "tsd-signature-type" > any< / span > < / h5 >
< div class = "tsd-comment tsd-typography" >
< p > The new value.< / p >
< / div >
< / li >
< li >
< h5 > < span class = "tsd-flag ts-flagOptional" > Optional< / span > configurationTarget: < span class = "tsd-signature-type" > null< / span > < span class = "tsd-signature-symbol" > | < / span > < span class = "tsd-signature-type" > boolean< / span > < span class = "tsd-signature-symbol" > | < / span > < a href = "../enums/vscode.ConfigurationTarget.html" class = "tsd-signature-type" data-tsd-kind = "Enumeration" > ConfigurationTarget< / a > < / h5 >
< div class = "tsd-comment tsd-typography" >
< p > The < a href = "../enums/vscode.ConfigurationTarget.html" > configuration target< / a > or a boolean value.
- If < code > true< / code > updates < a href = "../enums/vscode.ConfigurationTarget.html#Global" > Global settings< / a > .
- If < code > false< / code > updates < a href = "../enums/vscode.ConfigurationTarget.html#Workspace" > Workspace settings< / a > .
- If < code > undefined< / code > or < code > null< / code > updates to < a href = "../enums/vscode.ConfigurationTarget.html#WorkspaceFolder" > Workspace folder settings< / a > if configuration is resource specific,
otherwise to < a href = "../enums/vscode.ConfigurationTarget.html#Workspace" > Workspace settings< / a > .< / p >
< / div >
< / li >
< li >
< h5 > < span class = "tsd-flag ts-flagOptional" > Optional< / span > overrideInLanguage: < span class = "tsd-signature-type" > boolean< / span > < / h5 >
< div class = "tsd-comment tsd-typography" >
< p > Whether to update the value in the scope of requested languageId or not.
- If < code > true< / code > updates the value under the requested languageId.
- If < code > undefined< / code > updates the value under the requested languageId only if the configuration is defined for the language.< / p >
< / div >
< / li >
< / ul >
< h4 class = "tsd-returns-title" > Returns < a href = "Thenable.html" class = "tsd-signature-type" data-tsd-kind = "Interface" > Thenable< / a > < span class = "tsd-signature-symbol" > < < / span > < span class = "tsd-signature-type" > void< / span > < span class = "tsd-signature-symbol" > > < / span > < / h4 >
< / li >
< / ul >
< / section >
< / section >
< / div >
< div class = "col-4 col-menu menu-sticky-wrap menu-highlight" >
< nav class = "tsd-navigation primary" >
< ul >
< li class = " " >
< a href = "../modules.html" > Exports< / a >
< / li >
< li class = "current tsd-kind-namespace" >
< a href = "../modules/vscode.html" > vscode< / a >
< ul >
< li class = " tsd-kind-namespace tsd-parent-kind-namespace" >
< a href = "../modules/vscode.authentication.html" > authentication< / a >
< / li >
< li class = " tsd-kind-namespace tsd-parent-kind-namespace" >
< a href = "../modules/vscode.commands.html" > commands< / a >
< / li >
< li class = " tsd-kind-namespace tsd-parent-kind-namespace" >
< a href = "../modules/vscode.comments.html" > comments< / a >
< / li >
< li class = " tsd-kind-namespace tsd-parent-kind-namespace" >
< a href = "../modules/vscode.debug.html" > debug< / a >
< / li >
< li class = " tsd-kind-namespace tsd-parent-kind-namespace" >
< a href = "../modules/vscode.env.html" > env< / a >
< / li >
< li class = " tsd-kind-namespace tsd-parent-kind-namespace" >
< a href = "../modules/vscode.extensions.html" > extensions< / a >
< / li >
< li class = " tsd-kind-namespace tsd-parent-kind-namespace" >
< a href = "../modules/vscode.languages.html" > languages< / a >
< / li >
< li class = " tsd-kind-namespace tsd-parent-kind-namespace" >
< a href = "../modules/vscode.notebooks.html" > notebooks< / a >
< / li >
< li class = " tsd-kind-namespace tsd-parent-kind-namespace" >
< a href = "../modules/vscode.scm.html" > scm< / a >
< / li >
< li class = " tsd-kind-namespace tsd-parent-kind-namespace" >
< a href = "../modules/vscode.tasks.html" > tasks< / a >
< / li >
< li class = " tsd-kind-namespace tsd-parent-kind-namespace" >
< a href = "../modules/vscode.tests.html" > tests< / a >
< / li >
< li class = " tsd-kind-namespace tsd-parent-kind-namespace" >
< a href = "../modules/vscode.window.html" > window< / a >
< / li >
< li class = " tsd-kind-namespace tsd-parent-kind-namespace" >
< a href = "../modules/vscode.workspace.html" > workspace< / a >
< / li >
< / ul >
< / li >
< / ul >
< / nav >
< nav class = "tsd-navigation secondary menu-sticky" >
< div style = "width: 200px" >
< script type = "text/javascript" id = "clstr_globe" src = "//clustrmaps.com/globe.js?d=cMnk-gSDNcAzNMMm67U8rWRaHnjUc0Xb0giSGndepK4" > < / script >
< / div >
< ul class = "before-current" >
< / ul >
< ul class = "current" >
< li class = "current tsd-kind-interface tsd-parent-kind-namespace" >
< a href = "vscode.WorkspaceConfiguration.html" class = "tsd-kind-icon" > Workspace< wbr > Configuration< / a >
< ul >
< li class = " tsd-kind-method tsd-parent-kind-interface tsd-has-type-parameter" >
< a href = "vscode.WorkspaceConfiguration.html#get" class = "tsd-kind-icon" > get< / a >
< / li >
< li class = " tsd-kind-method tsd-parent-kind-interface" >
< a href = "vscode.WorkspaceConfiguration.html#has" class = "tsd-kind-icon" > has< / a >
< / li >
< li class = " tsd-kind-method tsd-parent-kind-interface tsd-has-type-parameter" >
< a href = "vscode.WorkspaceConfiguration.html#inspect" class = "tsd-kind-icon" > inspect< / a >
< / li >
< li class = " tsd-kind-method tsd-parent-kind-interface" >
< a href = "vscode.WorkspaceConfiguration.html#update" class = "tsd-kind-icon" > update< / a >
< / li >
< / ul >
< / li >
< / ul >
< ul class = "after-current" >
< / ul >
< / nav >
< / div >
< / div >
< / div >
< footer class = "with-border-bottom" >
< div class = "container" >
< h2 > 图例< / h2 >
< div class = "tsd-legend-group" >
< ul class = "tsd-legend" >
< li class = "tsd-kind-method tsd-parent-kind-interface" > < span class = "tsd-kind-icon" > Method< / span > < / li >
< / ul >
< / div >
< / div >
< / footer >
< div class = "container tsd-generator" >
< p > 友链：< a href = "https://jeasonstudio.gitbooks.io/vscode-cn-doc/content/" target = "_blank" > VS Code 中文文档< / a > | < a href = "https://code.visualstudio.com/docs" target = "_blank" > VS Code 官网文档< / a > | < a href = "https://marketplace.visualstudio.com/" target = "_blank" > VS Code 扩展市场< / a > < / p >
< p > Generated by < a href = "https://typedoc.org/" target = "_blank" > TypeDoc< / a > . Maintained by < a href = "https://youngjuning.js.org" target = "_blank" > 洛竹< / a > < / p >
< / div >
< div class = "overlay" > < / div >
< script src = "../assets/js/main.js" > < / script >
< / body >
< / html >
