API Reference > core-backend > Workspace > SettingSchema

SettingSchema Interface

Beta  

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 undefined | "true" whether the setting replaces lower priority entries with the same name or combines with them.  
items Readonly undefined | SettingSchema    
properties Readonly undefined | { T }    
type Readonly JSONSchemaTypeName    

Inherited properties

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

Defined in

Last Updated: 20 June, 2023