Class InjectablePreferenceProxy<T>

Type Parameters

T extends Record<string, JSONValue>

Hierarchy

InjectablePreferenceProxy

Implements

ProxyHandler<T>
ProxyHandler<Disposable>
ProxyHandler<PreferenceEventEmitter<T>>
ProxyHandler<PreferenceRetrieval<T>>

Constructors

constructor

new InjectablePreferenceProxy<T>(): InjectablePreferenceProxy<T>

Type Parameters
- T extends Record<string, JSONValue>
Returns InjectablePreferenceProxy<T>

Properties

Protected _onPreferenceChangedEmitter

_onPreferenceChangedEmitter: undefined | Emitter<PreferenceChangeEvent<T>>

Protected Readonly factory

factory: PreferenceProxyFactory

Protected Readonly options

options: PreferenceProxyOptions

Protected Readonly preferences

preferences: PreferenceService

Protected Readonly promisedSchema

promisedSchema: (() => PreferenceSchema | Promise<PreferenceSchema>)

Type declaration

- (): PreferenceSchema | Promise<PreferenceSchema>
- Returns PreferenceSchema | Promise<PreferenceSchema>

Protected schema

schema: undefined | PreferenceSchema

Protected toDispose

toDispose: DisposableCollection = ...

Accessors

Protected isDeep

get isDeep(): boolean

- Defined in packages/core/src/browser/preferences/injectable-preference-proxy.ts:73
Returns boolean

Protected isFlat

get isFlat(): boolean

- Defined in packages/core/src/browser/preferences/injectable-preference-proxy.ts:78
Returns boolean

onPreferenceChanged

get onPreferenceChanged(): Event<PreferenceChangeEvent<T>>

- Defined in packages/core/src/browser/preferences/injectable-preference-proxy.ts:92
Returns Event<PreferenceChangeEvent<T>>

Protected onPreferenceChangedEmitter

get onPreferenceChangedEmitter(): Emitter<PreferenceChangeEvent<T>>

- Defined in packages/core/src/browser/preferences/injectable-preference-proxy.ts:83
Returns Emitter<PreferenceChangeEvent<T>>

Protected overrideIdentifier

get overrideIdentifier(): undefined | string

- Defined in packages/core/src/browser/preferences/injectable-preference-proxy.ts:69
Returns undefined | string

Protected prefix

get prefix(): string

- Defined in packages/core/src/browser/preferences/injectable-preference-proxy.ts:57
Returns string

Protected resourceUri

get resourceUri(): undefined | string

- Defined in packages/core/src/browser/preferences/injectable-preference-proxy.ts:65
Returns undefined | string

Protected style

get style(): "flat" | "deep" | "both"

- Defined in packages/core/src/browser/preferences/injectable-preference-proxy.ts:61
Returns "flat" | "deep" | "both"

Methods

Protected buildNewChangeEvent

buildNewChangeEvent(change: PreferenceProviderDataChange, overrideInfo?: OverridePreferenceName): PreferenceChangeEvent<T>

- Defined in packages/core/src/browser/preferences/injectable-preference-proxy.ts:264
Parameters
- change: PreferenceProviderDataChange
- Optional overrideInfo: OverridePreferenceName
Returns PreferenceChangeEvent<T>

defineProperty

defineProperty(): never

Implementation of ProxyHandler.defineProperty
- Defined in packages/core/src/browser/preferences/injectable-preference-proxy.ts:226
Returns never

deleteProperty

deleteProperty(): never

Implementation of ProxyHandler.deleteProperty
- Defined in packages/core/src/browser/preferences/injectable-preference-proxy.ts:222
Returns never

dispose

dispose(): void

- Defined in packages/core/src/browser/preferences/injectable-preference-proxy.ts:278
Returns void

Protected fireChangeEvent

fireChangeEvent(change: PreferenceChangeEvent<T>): void

- Defined in packages/core/src/browser/preferences/injectable-preference-proxy.ts:260
Parameters
- change: PreferenceChangeEvent<T>
Returns void

get

get(target: unknown, property: string, receiver: unknown): unknown

Implementation of ProxyHandler.get
- Defined in packages/core/src/browser/preferences/injectable-preference-proxy.ts:106
Parameters
- target: unknown
- property: string
- receiver: unknown
Returns unknown

getOwnPropertyDescriptor

getOwnPropertyDescriptor(target: unknown, property: string): PropertyDescriptor

Implementation of ProxyHandler.getOwnPropertyDescriptor
- Defined in packages/core/src/browser/preferences/injectable-preference-proxy.ts:212
Parameters
- target: unknown
- property: string
Returns PropertyDescriptor

Protected getValue

getValue<K>(preferenceIdentifier: K | OverridePreferenceName & { preferenceName: K }, defaultValue: T[K], resourceUri?: undefined | string): T[K]

- Defined in packages/core/src/browser/preferences/injectable-preference-proxy.ts:271
Type Parameters
- K extends string
Parameters
- preferenceIdentifier: K | OverridePreferenceName & { preferenceName: K }
- defaultValue: T[K]
- resourceUri: undefined | string = ...
Returns T[K]

Protected handlePreferenceChanges

handlePreferenceChanges(changes: PreferenceChanges): void

- Defined in packages/core/src/browser/preferences/injectable-preference-proxy.ts:242
Parameters
- changes: PreferenceChanges
Returns void

Protected init

init(): void

- Defined in packages/core/src/browser/preferences/injectable-preference-proxy.ts:97
Returns void

Protected isRelevantChange

isRelevantChange(change: PreferenceChange, overrideInfo?: OverridePreferenceName): boolean

- Defined in packages/core/src/browser/preferences/injectable-preference-proxy.ts:253
Parameters
- change: PreferenceChange
- Optional overrideInfo: OverridePreferenceName
Returns boolean

ownKeys

ownKeys(): string[]

Implementation of ProxyHandler.ownKeys
- Defined in packages/core/src/browser/preferences/injectable-preference-proxy.ts:189
Returns string[]

set

set(target: unknown, property: string, value: unknown, receiver: unknown): boolean

Implementation of ProxyHandler.set
- Defined in packages/core/src/browser/preferences/injectable-preference-proxy.ts:156
Parameters
- target: unknown
- property: string
- value: unknown
- receiver: unknown
Returns boolean

Protected subscribeToChangeEvents

subscribeToChangeEvents(): void

- Defined in packages/core/src/browser/preferences/injectable-preference-proxy.ts:238
Returns void

toJSON

toJSON(): JSONValue

- Defined in packages/core/src/browser/preferences/injectable-preference-proxy.ts:230
Returns JSONValue