Options
All
  • Public
  • Public/Protected
  • All
Menu

Class PreferenceSchemaProvider

The PreferenceSchemaProvider collects all PreferenceContributions and combines the preference schema provided by these contributions into one collective schema. The preferences which are provided by this PreferenceProvider are derived from this combined schema.

Hierarchy

Index

Constructors

constructor

Properties

Protected _pendingChanges

_pendingChanges: Promise<boolean> = ...

Protected Readonly _ready

_ready: Deferred<void> = ...

Protected Readonly combinedSchema

combinedSchema: PreferenceDataSchema = ...

Protected Readonly configurations

configurations: PreferenceConfigurations

Protected deferredChanges

deferredChanges: undefined | PreferenceProviderDataChanges

Protected fireDidPreferencesChanged

fireDidPreferencesChanged: (...arguments: []) => Promise<boolean> = ...

Type declaration

    • (...arguments: []): Promise<boolean>
    • Parameters

      • Rest ...arguments: []

      Returns Promise<boolean>

Protected Readonly folderSchema

folderSchema: PreferenceDataSchema = ...

Readonly onDidPreferenceSchemaChanged

onDidPreferenceSchemaChanged: Event<void> = ...

Protected Readonly onDidPreferenceSchemaChangedEmitter

onDidPreferenceSchemaChangedEmitter: Emitter<void> = ...

Readonly onDidPreferencesChanged

onDidPreferencesChanged: Event<PreferenceProviderDataChanges> = ...

Protected Readonly onDidPreferencesChangedEmitter

onDidPreferencesChangedEmitter: Emitter<PreferenceProviderDataChanges> = ...

Protected Readonly overridePatternProperties

overridePatternProperties: Required<Pick<PreferenceDataProperty, "properties" | "additionalProperties">> & PreferenceDataProperty = ...

Protected overridePatternPropertiesKey

overridePatternPropertiesKey: undefined | string

Protected Readonly preferenceContributions

Protected Readonly preferenceOverrideService

preferenceOverrideService: PreferenceLanguageOverrideService

Protected Readonly preferences

preferences: {} = {}

Type declaration

  • [name: string]: any

Protected Readonly toDispose

toDispose: DisposableCollection = ...

Protected Readonly workspaceSchema

workspaceSchema: PreferenceDataSchema = ...

Accessors

pendingChanges

  • get pendingChanges(): Promise<boolean>

ready

  • get ready(): Promise<void>

Methods

dispose

  • dispose(): void

Protected doSetPreferenceValue

Protected doSetSchema

Protected doUnsetSchema

Protected emitPreferencesChangedEvent

Protected fireDidPreferenceSchemaChanged

  • fireDidPreferenceSchemaChanged(): void

get

  • get<T>(preferenceName: string, resourceUri?: string): undefined | T
  • Retrieve the stored value for the given preference and resource URI.

    Type parameters

    • T

    Parameters

    • preferenceName: string

      the preference identifier.

    • Optional resourceUri: string

      the uri of the resource for which the preference is stored. This is used to retrieve a potentially different value for the same preference for different resources, for example files.encoding.

    Returns undefined | T

    the value stored for the given preference and resourceUri if it exists, otherwise undefined.

getCombinedSchema

getConfigUri

  • getConfigUri(resourceUri?: string, sectionName?: string): undefined | default

Protected getConfiguredDefault

  • getConfiguredDefault(preferenceName: string): any

Optional getContainingConfigUri

  • getContainingConfigUri(resourceUri?: string, sectionName?: string): undefined | default

Protected getDefaultValue

getDomain

  • getDomain(): undefined | string[]

getOverridePreferenceNames

  • getOverridePreferenceNames(preferenceName: string): IterableIterator<string>

Protected getParsedContent

  • getParsedContent(jsonData: any): {}

getPreferenceNames

  • getPreferenceNames(): IterableIterator<string>

getPreferences

  • getPreferences(): {}

getSchema

Protected init

  • init(): void

isValidInScope

Protected mergePreferenceProviderDataChange

overriddenPreferenceName

overridePreferenceName

Protected readConfiguredPreferences

  • readConfiguredPreferences(): void

registerOverrideIdentifier

  • registerOverrideIdentifier(overrideIdentifier: string): void
  • Register a new overrideIdentifier. Existing identifiers are not replaced.

    Allows overriding existing values while keeping both values in store. For example to store different editor settings, e.g. "[markdown].editor.autoIndent", "[json].editor.autoIndent" and "editor.autoIndent"

    Parameters

    • overrideIdentifier: string

      the new overrideIdentifier

    Returns void

Protected removePropFromSchemas

  • removePropFromSchemas(key: string): void

resolve

  • Resolve the value for the given preference and resource URI.

    Type parameters

    • T

    Parameters

    • preferenceName: string

      the preference identifier.

    • Optional resourceUri: string

      the URI of the resource for which this provider should resolve the preference. This is used to retrieve a potentially different value for the same preference for different resources, for example files.encoding.

    Returns PreferenceResolveResult<T>

    an object containing the value stored for the given preference and resourceUri if it exists, otherwise undefined.

setPreference

  • setPreference(): Promise<boolean>

setSchema

testOverrideValue

Protected updateOverridePatternPropertiesKey

  • updateOverridePatternPropertiesKey(): void

Protected updateSchemaProps

Static deepEqual

  • deepEqual(a: undefined | null | string | number | boolean | JSONObject | JSONArray, b: undefined | null | string | number | boolean | JSONObject | JSONArray): boolean

Static merge

  • merge(source: undefined | null | string | number | boolean | JSONObject | JSONArray, target: JSONValue): JSONValue