Options
All
  • Public
  • Public/Protected
  • All
Menu

Class PreferenceProvider

The PreferenceProvider is used to store and retrieve preference values. A PreferenceProvider does not operate in a global scope but is configured for one or more PreferenceScopes. The (default implementation for the) PreferenceService aggregates all PreferenceProviders and serves as a common facade for manipulating preference values.

Hierarchy

Implements

Index

Constructors

constructor

Properties

Protected _pendingChanges

_pendingChanges: Promise<boolean> = Promise.resolve(false)

Protected Readonly _ready

_ready: Deferred<void> = new Deferred<void>()

Protected deferredChanges

deferredChanges: PreferenceProviderDataChanges | undefined

Protected fireDidPreferencesChanged

fireDidPreferencesChanged: (...arguments: ArgumentsType) => Promise<ReturnType> = debounce(() => {const changes = this.deferredChanges;this.deferredChanges = undefined;if (changes && Object.keys(changes).length) {this.onDidPreferencesChangedEmitter.fire(changes);return true;}return false;}, 0)

Type declaration

    • (...arguments: ArgumentsType): Promise<ReturnType>
    • Parameters

      • Rest ...arguments: ArgumentsType

      Returns Promise<ReturnType>

Readonly onDidPreferencesChanged

onDidPreferencesChanged: Event<PreferenceProviderDataChanges> = this.onDidPreferencesChangedEmitter.event

Protected Readonly onDidPreferencesChangedEmitter

onDidPreferencesChangedEmitter: Emitter<PreferenceProviderDataChanges> = new Emitter<PreferenceProviderDataChanges>()

Protected Readonly toDispose

toDispose: DisposableCollection = new DisposableCollection()

Accessors

pendingChanges

  • get pendingChanges(): Promise<boolean>

ready

  • get ready(): Promise<void>

Methods

dispose

  • dispose(): void

Protected emitPreferencesChangedEvent

get

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

    Type parameters

    • T

    Parameters

    • preferenceName: string

      the preference identifier.

    • Optional resourceUri: undefined | 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 T | undefined

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

getConfigUri

  • getConfigUri(resourceUri?: undefined | string, sectionName?: undefined | string): URI | undefined
  • Retrieve the configuration URI for the given resource URI.

    Parameters

    • Optional resourceUri: undefined | string

      the uri of the resource or undefined.

    • Optional sectionName: undefined | string

      the section to return the URI for, e.g. tasks or launch. Defaults to settings.

    Returns URI | undefined

    the corresponding resource URI or undefined if there is no valid URI.

Optional getContainingConfigUri

  • getContainingConfigUri(resourceUri?: undefined | string, sectionName?: undefined | string): URI | undefined
  • Retrieves the first valid configuration URI contained by the given resource.

    Parameters

    • Optional resourceUri: undefined | string

      the uri of the container resource or undefined.

    • Optional sectionName: undefined | string

    Returns URI | undefined

    the first valid configuration URI contained by the given resource undefined if there is no valid configuration URI at all.

getDomain

  • getDomain(): string[] | undefined

Abstract getPreferences

  • getPreferences(resourceUri?: undefined | string): {}

Protected mergePreferenceProviderDataChange

resolve

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

    Type parameters

    • T

    Parameters

    • preferenceName: string

      the preference identifier.

    • Optional resourceUri: undefined | 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.

Abstract setPreference

  • setPreference(key: string, value: any, resourceUri?: undefined | string): Promise<boolean>
  • Stores a new value for the given preference key in the provider.

    Parameters

    • key: string

      the preference key (typically the name).

    • value: any

      the new preference value.

    • Optional resourceUri: undefined | string

      the URI of the resource for which the preference is stored.

    Returns Promise<boolean>

    a promise that only resolves if all changes were delivered. If changes were made then implementation must either await on this.emitPreferencesChangedEvent(...) or this.pendingChanges if changes are fired indirectly.

Static merge

  • merge(source: JSONValue | undefined, target: JSONValue): JSONValue