API Reference › core-backend› Workspace › SettingSchema

SettingSchema Interface

The properties of a single Setting, used by the settings editor. This interface also includes the default value if it is not specified in any Settings file. This interface includes all members of JSONSchema with the extensions added by VSCode.

@note the type member is marked optional in JSONSchema but is required for Settings.

Extends

Properties

Name Type Description
cumulative Readonly "true" | undefined whether the setting replaces lower priority entries with the same name or combines with them.  
items Readonly SettingSchema | undefined    
properties Readonly [name: string]: SettingSchema | undefined    
type Readonly JSONSchemaTypeName    

Inherited properties

Name Type Inherited from Description
$comment Readonly string | undefined Readonly  
$id Readonly string | undefined Readonly  
$ref Readonly string | undefined Readonly  
$schema Readonly string | undefined Readonly  
additionalItems Readonly boolean | JSONSchema Readonly  
additionalProperties Readonly boolean | JSONSchema Readonly  
allOf Readonly JSONSchema[] | undefined Readonly  
allowComments Readonly boolean | undefined Readonly  
allowTrailingCommas Readonly boolean | undefined Readonly  
anyOf Readonly JSONSchema[] | undefined Readonly  
const Readonly any | undefined Readonly  
contains Readonly JSONSchema | undefined Readonly  
default Readonly JSONSchemaType | undefined Readonly  
defaultSnippets Readonly JSONSchemaSnippet[] | undefined Readonly  
definitions Readonly JSONSchemaMap | undefined Readonly  
dependencies Readonly JSONSchemaMap | [prop: string]: string[] Readonly  
deprecationMessage Readonly string | undefined Readonly  
description Readonly string | undefined Readonly  
doNotSuggest Readonly boolean | undefined Readonly  
else Readonly JSONSchema | undefined Readonly  
enum Readonly JSONSchemaType[] | undefined Readonly  
enumDescriptions Readonly string[] | undefined Readonly  
errorMessage Readonly string | undefined Readonly  
exclusiveMaximum Readonly number | boolean Readonly  
exclusiveMinimum Readonly number | boolean Readonly  
format Readonly string | undefined Readonly  
id Readonly string | undefined Readonly  
if Readonly JSONSchema | undefined Readonly  
markdownDeprecationMessage Readonly string | undefined Readonly  
markdownDescription Readonly string | undefined Readonly  
markdownEnumDescriptions Readonly string[] | undefined Readonly  
maxItems Readonly number | undefined Readonly  
maxLength Readonly number | undefined Readonly  
maxProperties Readonly number | undefined Readonly  
maximum Readonly number | undefined Readonly  
minItems Readonly number | undefined Readonly  
minLength Readonly number | undefined Readonly  
minProperties Readonly number | undefined Readonly  
minimum Readonly number | undefined Readonly  
multipleOf Readonly number | undefined Readonly  
not Readonly JSONSchema | undefined Readonly  
oneOf Readonly JSONSchema[] | undefined Readonly  
pattern Readonly string | undefined Readonly  
patternErrorMessage Readonly string | undefined Readonly  
patternProperties Readonly JSONSchemaMap | undefined Readonly  
propertyNames Readonly JSONSchema | undefined Readonly  
required Readonly string[] | undefined Readonly  
suggestSortText Readonly string | undefined Readonly  
then Readonly JSONSchema | undefined Readonly  
title Readonly string | undefined Readonly  
uniqueItems Readonly boolean | undefined Readonly  

Defined in

Last Updated: 13 May, 2024