Options
All
  • Public
  • Public/Protected
  • All
Menu

Class UserConfigsPreferenceProvider

Binds together preference section prefs providers for user-level preferences.

Hierarchy

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Properties

Protected _pendingChanges

_pendingChanges: Promise<boolean>

Protected Readonly _ready

_ready: Deferred<void>

Protected Readonly configurations

configurations: PreferenceConfigurations

Protected deferredChanges

deferredChanges: undefined | PreferenceProviderDataChanges

Protected fireDidPreferencesChanged

fireDidPreferencesChanged: () => Promise<boolean>

Type declaration

    • (): Promise<boolean>

    • Returns Promise<boolean>

Readonly onDidPreferencesChanged

onDidPreferencesChanged: Event<PreferenceProviderDataChanges>

Protected Readonly onDidPreferencesChangedEmitter

onDidPreferencesChangedEmitter: Emitter<PreferenceProviderDataChanges>

Protected Readonly preferenceOverrideService

preferenceOverrideService: PreferenceLanguageOverrideService

Protected Readonly providerFactory

providerFactory: UserPreferenceProviderFactory

Protected Readonly providers

providers: Map<string, UserPreferenceProvider> = ...

Protected Readonly toDispose

toDispose: DisposableCollection

Accessors

pendingChanges

  • get pendingChanges(): Promise<boolean>

  • Returns Promise<boolean>

ready

  • get ready(): Promise<void>

  • Resolved when the preference provider is ready to provide preferences It should be resolved by subclasses.

    Returns Promise<void>

Methods

Protected createProvider

Protected createProviders

  • createProviders(): void

dispose

  • dispose(): void

  • Returns void

Protected emitPreferencesChangedEvent

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.

getConfigUri

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

Optional getContainingConfigUri

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

  • Retrieves the first valid configuration URI contained by the given resource.

    Parameters

    • Optional resourceUri: string

      the uri of the container resource or undefined.

    • Optional sectionName: string

    Returns undefined | default

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

getDomain

  • getDomain(): undefined | string[]

  • Retrieve the domain for this provider.

    Returns undefined | string[]

    the domain or undefined if this provider is suitable for all domains.

Protected getParsedContent

  • getParsedContent(jsonData: any): {}

  • Parameters

    • jsonData: any

    Returns {}

    • [key: string]: any

getPreferences

  • getPreferences(resourceUri?: string): {}

Protected init

  • init(): Promise<void>

Protected mergePreferenceProviderDataChange

resolve

setPreference

  • setPreference(preferenceName: string, value: any, resourceUri?: string): Promise<boolean>

Static deepEqual

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

  • Handles deep equality with the possibility of undefined

    Parameters

    • a: undefined | null | string | number | boolean | JSONObject | JSONArray
    • b: undefined | null | string | number | boolean | JSONObject | JSONArray

    Returns boolean

Static merge

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

  • Parameters

    • source: undefined | null | string | number | boolean | JSONObject | JSONArray
    • target: JSONValue

    Returns JSONValue