Class PreferenceChangeImpl

Representation of a preference change. A preference value can be set to undefined for a specific scope. This means that the value from a more general scope will be used.

Hierarchy (View Summary)

PreferenceChangeImpl
- PreferenceProxyChange

Implements

PreferenceChange

Index

Constructors

Properties

Accessors

domain newValue oldValue preferenceName scope

Methods

Constructors

constructor

new PreferenceChangeImpl(
change: PreferenceProviderDataChange,
): PreferenceChangeImpl
Parameters
- change: PreferenceProviderDataChange
Returns PreferenceChangeImpl
- Defined in packages/core/src/common/preferences/preference-service.ts:44

Properties

`Protected` `Readonly`change

change: PreferenceProviderDataChange

Accessors

domain

get domain(): undefined | string[]
URIs of the scopes in which this change applies.

Returns undefined | string[]
Implementation of PreferenceChange.domain
- Defined in packages/core/src/common/preferences/preference-service.ts:60

newValue

get newValue(): undefined | JSONValue
The new value of the changed preference.

Returns undefined | JSONValue
Implementation of PreferenceChange.newValue
- Defined in packages/core/src/common/preferences/preference-service.ts:51

oldValue

get oldValue(): undefined | JSONValue
The old value of the changed preference.

Returns undefined | JSONValue
Implementation of PreferenceChange.oldValue
- Defined in packages/core/src/common/preferences/preference-service.ts:54

preferenceName

get preferenceName(): string
The name of the changed preference.

Returns string
Implementation of PreferenceChange.preferenceName
- Defined in packages/core/src/common/preferences/preference-service.ts:48

scope

get scope(): PreferenceScope
The PreferenceScope of the changed preference.

Returns PreferenceScope
Implementation of PreferenceChange.scope
- Defined in packages/core/src/common/preferences/preference-service.ts:57

Methods

affects

affects(resourceUri?: string): boolean
TODO add tests
Parameters
- OptionalresourceUri: string
Returns boolean
Implementation of PreferenceChange.affects
- Defined in packages/core/src/common/preferences/preference-service.ts:65