Skip to main content

modules/workspace/configuration

Interfaces​

ConfigurationProperty​

Defined in: modules/workspace/configuration.d.ts:23

Structural validation and metadata profile configuration for a single key-value setting.

Properties​

default?​

optional default?: any

Defined in: modules/workspace/configuration.d.ts:27

Baseline fallback configuration instantiation state initialized by application defaults.

description?​

optional description?: string

Defined in: modules/workspace/configuration.d.ts:32

Plain text string providing baseline overview descriptions.

enum?​

optional enum?: (string | number | boolean | null)[]

Defined in: modules/workspace/configuration.d.ts:39

Shorthand arrays declaring primitive acceptable fallback constraints natively.

enumItemLabels?​

optional enumItemLabels?: string[]

Defined in: modules/workspace/configuration.d.ts:41

Plain description names associated with structural positions inside alternative enum paths.

markdownDescription?​

optional markdownDescription?: string

Defined in: modules/workspace/configuration.d.ts:34

Markdown documentation strings (takes precedence over plain text).

maximum?​

optional maximum?: number

Defined in: modules/workspace/configuration.d.ts:46

Enforces numeric maximum evaluation parameters.

minimum?​

optional minimum?: number

Defined in: modules/workspace/configuration.d.ts:44

Enforces numeric minimum evaluation parameters.

options?​

optional options?: SettingOption[]

Defined in: modules/workspace/configuration.d.ts:37

Explicit array objects binding key indices directly into dynamic rendering selectors.

order?​

optional order?: number

Defined in: modules/workspace/configuration.d.ts:53

Positional arrangement sort criteria.

pattern?​

optional pattern?: string

Defined in: modules/workspace/configuration.d.ts:48

Regular expression validation string used to verify structure strings before saving.

patternErrorMessage?​

optional patternErrorMessage?: string

Defined in: modules/workspace/configuration.d.ts:50

Context error notification displayed when standard regular expression patterns fail.

title?​

optional title?: string

Defined in: modules/workspace/configuration.d.ts:30

Visual header title caption label rendered on structural elements.

type​

type: SettingType

Defined in: modules/workspace/configuration.d.ts:25

Structural scalar configuration primitive target validation blueprint type.

IConfigurationSection​

Defined in: modules/workspace/configuration.d.ts:59

Top-level structure mapping configurations into contextual groups.

Properties​

id​

id: string

Defined in: modules/workspace/configuration.d.ts:61

Top-level feature domain categorization identifier (e.g., 'myExtension').

order?​

optional order?: number

Defined in: modules/workspace/configuration.d.ts:65

Global sort order precedence given to this entire segment group.

properties​

properties: Record<string, ConfigurationProperty>

Defined in: modules/workspace/configuration.d.ts:67

Detailed lookup dictionary mapping settings keys to their configuration properties.

title​

title: string

Defined in: modules/workspace/configuration.d.ts:63

Header category title rendered as the main navigation anchor label in the Settings UI.

SettingOption​

Defined in: modules/workspace/configuration.d.ts:9

Structural definition for individual selections used in bounded 'select' schema varieties.

Properties​

description?​

optional description?: string

Defined in: modules/workspace/configuration.d.ts:15

Optional plain-text fallback description snippet.

label​

label: string

Defined in: modules/workspace/configuration.d.ts:13

Natural text caption rendered visible to users inside components.

markdownDescription?​

optional markdownDescription?: string

Defined in: modules/workspace/configuration.d.ts:17

Rich documentation layout text leveraging internal markdown renderer nodes.

value​

value: string

Defined in: modules/workspace/configuration.d.ts:11

Underlying primitive string key saved back into configuration state profiles.

WorkspaceConfiguration​

Defined in: modules/workspace/configuration.d.ts:73

Represents the configuration for a specific extension or workspace section.

Methods​

get()​

get<T>(key, defaultValue?): T

Defined in: modules/workspace/configuration.d.ts:80

Retrieves a configuration value. *

Type Parameters​
T​

T

Parameters​
key​

string

The configuration key (e.g., 'enabled' if the section is 'myExtension').

defaultValue?​

T

The fallback value if the key is not found in user settings.

Returns​

T

The value from settings or the provided default.

Type Aliases​

SettingType​

SettingType = "string" | "number" | "boolean" | "select" | "textarea" | "object" | "array" | "null"

Defined in: modules/workspace/configuration.d.ts:6

Valid runtime scalar and complex primitive types supported by the setting definitions.

References​

ActivityBarItemOptions​

Re-exports ActivityBarItemOptions

app​

Re-exports app

authentication​

Re-exports authentication

BookmarkFolder​

Re-exports BookmarkFolder

CommandMetadata​

Re-exports CommandMetadata

commands​

Re-exports commands

CommitOptions​

Re-exports CommitOptions

CopyOptions​

Re-exports CopyOptions

Diagnostic​

Re-exports Diagnostic

DiagnosticCollection​

Re-exports DiagnosticCollection

DiagnosticSeverity​

Re-exports DiagnosticSeverity

Disposable​

Re-exports Disposable

DocumentSymbol​

Re-exports DocumentSymbol

ExtensionContext​

Re-exports ExtensionContext

ExtensionInfo​

Re-exports ExtensionInfo

extensions​

Re-exports extensions

FileDecoration​

Re-exports FileDecoration

FileFilter​

Re-exports FileFilter

FileStat​

Re-exports FileStat

FileSystemAPI​

Re-exports FileSystemAPI

FindOptions​

Re-exports FindOptions

fs​

Re-exports fs

git​

Re-exports git

GitBranch​

Re-exports GitBranch

GitChangedFile​

Re-exports GitChangedFile

GitCommit​

Re-exports GitCommit

GitFileStatus​

Re-exports GitFileStatus

GitHubUser​

Re-exports GitHubUser

GitRepository​

Re-exports GitRepository

GitSortMode​

Re-exports GitSortMode

GitStash​

Re-exports GitStash

IconThemeDefinition​

Re-exports IconThemeDefinition

IconThemeMap​

Re-exports IconThemeMap

InputBoxOptions​

Re-exports InputBoxOptions

languages​

Re-exports languages

lsp​

Re-exports lsp

LspServerConfig​

Re-exports LspServerConfig

Re-exports MenuItem

Re-exports menus

ModalOptions​

Re-exports ModalOptions

MSCodeUIColors​

Re-exports MSCodeUIColors

MultiPickerOptions​

Re-exports MultiPickerOptions

NotificationAction​

Re-exports NotificationAction

OutputChannel​

Re-exports OutputChannel

PickerOptions​

Re-exports PickerOptions

Position​

Re-exports Position

ProgressNotification​

Re-exports ProgressNotification

QuickPickItem​

Re-exports QuickPickItem

QuickPickOptions​

Re-exports QuickPickOptions

RecentWorkspace​

Re-exports RecentWorkspace

ReplaceOptions​

Re-exports ReplaceOptions

ResolvedIcon​

Re-exports ResolvedIcon

Re-exports search

SearchFileResult​

Re-exports SearchFileResult

SearchMatch​

Re-exports SearchMatch

Selection​

Re-exports Selection

SidebarPanelDef​

Re-exports SidebarPanelDef

SidebarPanelHeader​

Re-exports SidebarPanelHeader

SidebarSectionContent​

Re-exports SidebarSectionContent

SidebarSectionContext​

Re-exports SidebarSectionContext

SidebarSectionDef​

Re-exports SidebarSectionDef

SidebarState​

Re-exports SidebarState

SilentSearchOptions​

Re-exports SilentSearchOptions

StashOptions​

Re-exports StashOptions

StatusBarAlignment​

Re-exports StatusBarAlignment

StatusBarItemController​

Re-exports StatusBarItemController

StatusBarItemOptions​

Re-exports StatusBarItemOptions

SymbolKind​

Re-exports SymbolKind

SymbolProvider​

Re-exports SymbolProvider

Tab​

Re-exports Tab

TabDiffData​

Re-exports TabDiffData

TabOptions​

Re-exports TabOptions

TabType​

Re-exports TabType

TaskExecution​

Re-exports TaskExecution

TaskOptions​

Re-exports TaskOptions

tasks​

Re-exports tasks

Terminal​

Re-exports Terminal

TerminalExitStatus​

Re-exports TerminalExitStatus

TerminalOptions​

Re-exports TerminalOptions

termis​

Re-exports termis

TermisView​

Re-exports TermisView

TextDocument​

Re-exports TextDocument

TextEditor​

Re-exports TextEditor

TextEditorEdit​

Re-exports TextEditorEdit

TextEditorOptions​

Re-exports TextEditorOptions

ThemeDefinition​

Re-exports ThemeDefinition

themes​

Re-exports themes

TokenColor​

Re-exports TokenColor

TreeDataProvider​

Re-exports TreeDataProvider

TreeItem​

Re-exports TreeItem

TreeView​

Re-exports TreeView

TreeViewOptions​

Re-exports TreeViewOptions

window​

Re-exports window

workspace​

Re-exports workspace

WorkspaceFolder​

Re-exports WorkspaceFolder

WriteOptions​

Re-exports WriteOptions