PreferenceChange | Theia TypeDoc

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

PreferenceProviderDataChange
- PreferenceChange

Implemented by

PreferenceChangeImpl

Index

Properties

Methods

affects

Properties

Optional Readonly domain

domain?: string[]

URIs of the scopes in which this change applies.

Optional Readonly newValue

newValue?: any

The new value of the changed preference.

Optional Readonly oldValue

oldValue?: any

The old value of the changed preference.

Readonly preferenceName

preferenceName: string

The name of the changed preference.

Readonly scope

scope: PreferenceScope

The PreferenceScope of the changed preference.

Methods

affects

affects(resourceUri?: string): boolean

- Defined in packages/core/src/browser/preferences/preference-service.ts:41
Tests wether the given resource is affected by the preference change.

Parameters
- Optional resourceUri: string
  
  the uri of the resource to test.
Returns boolean

Hierarchy

Implemented by

Index

Properties

Methods

Properties

Optional Readonly domain

Optional Readonly newValue

Optional Readonly oldValue

Readonly preferenceName

Readonly scope

Methods

affects

Parameters

Optional resourceUri: string

Returns boolean