Class WorkspacePreferenceProvider

Hierarchy

PreferenceProvider
- WorkspacePreferenceProvider

Index

Constructors

constructor

Properties

Accessors

Methods

Constructors

constructor

new WorkspacePreferenceProvider(): WorkspacePreferenceProvider

Inherited from PreferenceProvider.constructor
- Defined in packages/core/lib/browser/preferences/preference-provider.d.ts:49
Returns WorkspacePreferenceProvider

Properties

Protected _delegate

_delegate: undefined | PreferenceProvider

Protected _pendingChanges

_pendingChanges: Promise<boolean>

Protected Readonly _ready

_ready: Deferred<void>

Protected deferredChanges

deferredChanges: undefined | PreferenceProviderDataChanges

Protected fireDidPreferencesChanged

fireDidPreferencesChanged: () => Promise<boolean>

Type declaration

- (): Promise<boolean>
- Returns Promise<boolean>

Protected Readonly folderPreferenceProvider

folderPreferenceProvider: PreferenceProvider

Readonly onDidPreferencesChanged

onDidPreferencesChanged: Event<PreferenceProviderDataChanges>

Protected Readonly onDidPreferencesChangedEmitter

onDidPreferencesChangedEmitter: Emitter<PreferenceProviderDataChanges>

Protected Readonly preferenceOverrideService

preferenceOverrideService: PreferenceLanguageOverrideService

Protected Readonly toDispose

toDispose: DisposableCollection

Protected Readonly toDisposeOnEnsureDelegateUpToDate

toDisposeOnEnsureDelegateUpToDate: DisposableCollection = ...

Protected Readonly workspaceFileProviderFactory

workspaceFileProviderFactory: WorkspaceFilePreferenceProviderFactory

Protected Readonly workspaceService

workspaceService: WorkspaceService

Accessors

Protected delegate

get delegate(): undefined | PreferenceProvider

- Defined in packages/preferences/src/browser/workspace-preference-provider.ts:62
Returns undefined | PreferenceProvider

pendingChanges

get pendingChanges(): Promise<boolean>

- Defined in packages/core/lib/browser/preferences/preference-provider.d.ts:54
Returns Promise<boolean>

ready

get ready(): Promise<void>

- Defined in packages/core/lib/browser/preferences/preference-provider.d.ts:102
Resolved when the preference provider is ready to provide preferences It should be resolved by subclasses.

Returns Promise<void>

Methods

Protected createDelegate

createDelegate(): undefined | PreferenceProvider

- Defined in packages/preferences/src/browser/workspace-preference-provider.ts:88
Returns undefined | PreferenceProvider

dispose

dispose(): void

Inherited from PreferenceProvider.dispose
- Defined in packages/core/lib/browser/preferences/preference-provider.d.ts:51
Returns void

Protected emitPreferencesChangedEvent

emitPreferencesChangedEvent(changes: PreferenceProviderDataChanges | PreferenceProviderDataChange[]): Promise<boolean>

Inherited from PreferenceProvider.emitPreferencesChangedEvent
- Defined in packages/core/lib/browser/preferences/preference-provider.d.ts:59
Informs the listeners that one or more preferences of this provider are changed. The listeners are able to find what was changed from the emitted event.

Parameters
- changes: PreferenceProviderDataChanges | PreferenceProviderDataChange[]
Returns Promise<boolean>

Protected ensureDelegateUpToDate

ensureDelegateUpToDate(): void

- Defined in packages/preferences/src/browser/workspace-preference-provider.ts:66
Returns void

Protected ensureResourceUri

ensureResourceUri(): undefined | string

- Defined in packages/preferences/src/browser/workspace-preference-provider.ts:127
Returns undefined | string

get

get<T>(preferenceName: string, resourceUri?: undefined | string): undefined | T

Overrides PreferenceProvider.get
- Defined in packages/preferences/src/browser/workspace-preference-provider.ts:104
Type parameters
- T
Parameters
- preferenceName: string
- resourceUri: undefined | string = ...
Returns undefined | T

getConfigUri

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

Overrides PreferenceProvider.getConfigUri
- Defined in packages/preferences/src/browser/workspace-preference-provider.ts:53
Parameters
- resourceUri: undefined | string = ...
- Optional sectionName: string
Returns undefined | default

getContainingConfigUri

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

Overrides PreferenceProvider.getContainingConfigUri
- Defined in packages/preferences/src/browser/workspace-preference-provider.ts:57
Parameters
- resourceUri: undefined | string = ...
- Optional sectionName: string
Returns undefined | default

getDomain

getDomain(): undefined | string[]

Inherited from PreferenceProvider.getDomain
- Defined in packages/core/lib/browser/preferences/preference-provider.d.ts:108
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): {}

Inherited from PreferenceProvider.getParsedContent
- Defined in packages/core/lib/browser/preferences/preference-provider.d.ts:130
Parameters
- jsonData: any
Returns {}
- [key: string]: any

getPreferences

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

Overrides PreferenceProvider.getPreferences
- Defined in packages/preferences/src/browser/workspace-preference-provider.ts:114
Parameters
- resourceUri: undefined | string = ...
Returns {}
- [p: string]: any

Protected init

init(): Promise<void>

- Defined in packages/preferences/src/browser/workspace-preference-provider.ts:41
Returns Promise<void>

Protected mergePreferenceProviderDataChange

mergePreferenceProviderDataChange(change: PreferenceProviderDataChange): void

Inherited from PreferenceProvider.mergePreferenceProviderDataChange
- Defined in packages/core/lib/browser/preferences/preference-provider.d.ts:60
Parameters
- change: PreferenceProviderDataChange
Returns void

resolve

resolve<T>(preferenceName: string, resourceUri?: undefined | string): { configUri?: default; value?: T }

Overrides PreferenceProvider.resolve
- Defined in packages/preferences/src/browser/workspace-preference-provider.ts:109
Type parameters
- T
Parameters
- preferenceName: string
- resourceUri: undefined | string = ...
Returns { configUri?: default; value?: T }
- Optional configUri?: default
- Optional value?: T

setPreference

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

Overrides PreferenceProvider.setPreference
- Defined in packages/preferences/src/browser/workspace-preference-provider.ts:119
Parameters
- preferenceName: string
- value: any
- resourceUri: undefined | string = ...
Returns Promise<boolean>

Static deepEqual

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

Inherited from PreferenceProvider.deepEqual
- Defined in packages/core/lib/browser/preferences/preference-provider.d.ts:129
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

Inherited from PreferenceProvider.merge
- Defined in packages/core/lib/browser/preferences/preference-provider.d.ts:125
Parameters
- source: undefined | null | string | number | boolean | JSONObject | JSONArray
- target: JSONValue
Returns JSONValue