Skip to main content

configurationRegistry

MS Code Extension API

MS Code Extension API / core/extensionAPI/registry/configurationRegistry

core/extensionAPI/registry/configurationRegistry

Interfaces​

IConfigurationSection​

Defined in: core/extensionAPI/registry/configurationRegistry.ts:98

Top-level structure mapping configurations into contextual groups during initialization blocks.

Properties​

id​

id: string

Defined in: core/extensionAPI/registry/configurationRegistry.ts:100

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

order?​

optional order?: number

Defined in: core/extensionAPI/registry/configurationRegistry.ts:104

Global sort order precedence given to this entire segment group

properties​

properties: Record<string, Omit<SettingDefinition, "id" | "category" | "subCategory"> & object>

Defined in: core/extensionAPI/registry/configurationRegistry.ts:106

Detailed lookup dictionary mapping configurations over clean properties

title​

title: string

Defined in: core/extensionAPI/registry/configurationRegistry.ts:102

Header category title rendered as the main navigation anchor label

SettingDefinition​

Defined in: core/extensionAPI/registry/configurationRegistry.ts:27

Full structural validation and metadata template profile configuration for a single key-value variable.

Properties​

category​

category: string

Defined in: core/extensionAPI/registry/configurationRegistry.ts:38

Primary sidebar taxonomy categorization label (e.g., "Text Editor")

defaultValue​

defaultValue: any

Defined in: core/extensionAPI/registry/configurationRegistry.ts:46

Baseline fallback configuration instantiation state initialized by application defaults

deprecationMessage?​

optional deprecationMessage?: string

Defined in: core/extensionAPI/registry/configurationRegistry.ts:88

Standard warning banner string indicating alternative configuration paths

description?​

optional description?: string

Defined in: core/extensionAPI/registry/configurationRegistry.ts:50

Plain text string providing baseline overview descriptions for individual settings

enum?​

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

Defined in: core/extensionAPI/registry/configurationRegistry.ts:58

Shorthand arrays declaring primitive acceptable fallback constraints natively

enumDescriptions?​

optional enumDescriptions?: string[]

Defined in: core/extensionAPI/registry/configurationRegistry.ts:64

Plain fallback context definitions tracking positions matching explicit array values

enumItemLabels?​

optional enumItemLabels?: string[]

Defined in: core/extensionAPI/registry/configurationRegistry.ts:60

Plain description names associated with structural positions inside alternative enum paths

experimental?​

optional experimental?: boolean

Defined in: core/extensionAPI/registry/configurationRegistry.ts:82

Toggle indicator which appends visibility indicator alerts directly on container surfaces

id​

id: string

Defined in: core/extensionAPI/registry/configurationRegistry.ts:30

Fully-qualified namespace address path (e.g., 'editor.fontSize')

label?​

optional label?: string

Defined in: core/extensionAPI/registry/configurationRegistry.ts:34

Secondary or alternative natural text display descriptor

markdownDeprecationMessage?​

optional markdownDeprecationMessage?: string

Defined in: core/extensionAPI/registry/configurationRegistry.ts:90

Markdown message string detailing modification paths for deprecated keys

markdownDescription?​

optional markdownDescription?: string

Defined in: core/extensionAPI/registry/configurationRegistry.ts:52

Markdown documentation strings (takes precedence over plain text inside interactive components)

markdownEnumDescriptions?​

optional markdownEnumDescriptions?: string[]

Defined in: core/extensionAPI/registry/configurationRegistry.ts:62

Rich formatting markdown text accompanying corresponding entries inside programmatic enums

maximum?​

optional maximum?: number

Defined in: core/extensionAPI/registry/configurationRegistry.ts:70

Enforces numeric maximum evaluation parameters

minimum?​

optional minimum?: number

Defined in: core/extensionAPI/registry/configurationRegistry.ts:68

Enforces numeric minimum evaluation parameters

options?​

optional options?: SettingOption[]

Defined in: core/extensionAPI/registry/configurationRegistry.ts:56

Explicit array objects binding key indices directly into dynamic rendering selectors

order?​

optional order?: number

Defined in: core/extensionAPI/registry/configurationRegistry.ts:78

Positional arrangement sort criteria calculated relative to corresponding peer elements

pattern?​

optional pattern?: string

Defined in: core/extensionAPI/registry/configurationRegistry.ts:72

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

patternErrorMessage?​

optional patternErrorMessage?: string

Defined in: core/extensionAPI/registry/configurationRegistry.ts:74

Context error notification displayed when standard regular expression patterns fail validation

scope?​

optional scope?: "application" | "machine" | "window" | "resource" | "language-overridable" | "workspace"

Defined in: core/extensionAPI/registry/configurationRegistry.ts:84

Scope configuration layer tracking runtime execution context environments

subCategory​

subCategory: string

Defined in: core/extensionAPI/registry/configurationRegistry.ts:40

Secondary grouping boundary index token (e.g., "Font Configuration")

tags?​

optional tags?: string[]

Defined in: core/extensionAPI/registry/configurationRegistry.ts:80

Filter tokens indexed by search queries to parse matching components

title​

title: string

Defined in: core/extensionAPI/registry/configurationRegistry.ts:32

Visual header title caption label rendered on structural elements

type​

type: SettingType

Defined in: core/extensionAPI/registry/configurationRegistry.ts:44

Structural scalar configuration primitive target validation blueprint type

SettingOption​

Defined in: core/extensionAPI/registry/configurationRegistry.ts:119

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

Properties​

description?​

optional description?: string

Defined in: core/extensionAPI/registry/configurationRegistry.ts:125

Optional plain-text fallback description snippet

label​

label: string

Defined in: core/extensionAPI/registry/configurationRegistry.ts:123

Natural text caption rendered visible to users inside components

markdownDescription?​

optional markdownDescription?: string

Defined in: core/extensionAPI/registry/configurationRegistry.ts:127

Rich documentation layout text leveraging internal markdown renderer nodes

value​

value: string

Defined in: core/extensionAPI/registry/configurationRegistry.ts:121

Underlying primitive string key saved back into configuration state profiles

Type Aliases​

SettingType​

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

Defined in: core/extensionAPI/registry/configurationRegistry.ts:13

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

Variables​

configRegistry​

const configRegistry: ConfigurationRegistry

Defined in: core/extensionAPI/registry/configurationRegistry.ts:278