Class InjectablePreferenceProxy<T>

Type Parameters

T extends Record<string, JSONValue>

Implements

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

Constructors

constructor

new InjectablePreferenceProxy<T extends Record<string, JSONValue>>(): InjectablePreferenceProxy<
T,
>
Type Parameters
- T extends Record<string, JSONValue>
Returns InjectablePreferenceProxy<T>

Properties

`Protected`_onPreferenceChangedEmitter

_onPreferenceChangedEmitter: undefined | Emitter<PreferenceChangeEvent<T>>

`Protected` `Readonly`promisedSchema

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

`Protected`schema

schema: undefined | PreferenceSchema

`Protected`toDispose

toDispose: DisposableCollection = ...

Accessors

`Protected`isDeep

get isDeep(): boolean
Returns boolean
- Defined in packages/core/src/common/preferences/injectable-preference-proxy.ts:73

`Protected`isFlat

get isFlat(): boolean
Returns boolean
- Defined in packages/core/src/common/preferences/injectable-preference-proxy.ts:78

onPreferenceChanged

get onPreferenceChanged(): Event<PreferenceChangeEvent<T>>
Returns Event<PreferenceChangeEvent<T>>
- Defined in packages/core/src/common/preferences/injectable-preference-proxy.ts:92

`Protected`onPreferenceChangedEmitter

get onPreferenceChangedEmitter(): Emitter<PreferenceChangeEvent<T>>
Returns Emitter<PreferenceChangeEvent<T>>
- Defined in packages/core/src/common/preferences/injectable-preference-proxy.ts:83

`Protected`overrideIdentifier

get overrideIdentifier(): undefined | string
Returns undefined | string
- Defined in packages/core/src/common/preferences/injectable-preference-proxy.ts:69

`Protected`prefix

get prefix(): string
Returns string
- Defined in packages/core/src/common/preferences/injectable-preference-proxy.ts:57

`Protected`resourceUri

get resourceUri(): undefined | string
Returns undefined | string
- Defined in packages/core/src/common/preferences/injectable-preference-proxy.ts:65

`Protected`style

get style(): "flat" | "deep" | "both"
Returns "flat" | "deep" | "both"
- Defined in packages/core/src/common/preferences/injectable-preference-proxy.ts:61

Methods

`Protected`buildNewChangeEvent

buildNewChangeEvent(
change: PreferenceProviderDataChange,
overrideInfo?: OverridePreferenceName,
): PreferenceChangeEvent<T>
Parameters
- change: PreferenceProviderDataChange
- OptionaloverrideInfo: OverridePreferenceName
Returns PreferenceChangeEvent<T>
- Defined in packages/core/src/common/preferences/injectable-preference-proxy.ts:264

defineProperty

defineProperty(): never
A trap for Object.defineProperty().

Returns never
A Boolean indicating whether or not the property has been defined.
Implementation of ProxyHandler.defineProperty
- Defined in packages/core/src/common/preferences/injectable-preference-proxy.ts:226

deleteProperty

deleteProperty(): never
A trap for the delete operator.

Returns never
A Boolean indicating whether or not the property was deleted.
Implementation of ProxyHandler.deleteProperty
- Defined in packages/core/src/common/preferences/injectable-preference-proxy.ts:222

dispose

dispose(): void
Returns void
- Defined in packages/core/src/common/preferences/injectable-preference-proxy.ts:278

`Protected`fireChangeEvent

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

get

get(target: unknown, property: string, receiver: unknown): unknown
A trap for getting a property value.
Parameters
- target: unknown
  The original object which is being proxied.
- property: string
- receiver: unknown
  The proxy or an object that inherits from the proxy.
Returns unknown
Implementation of ProxyHandler.get
- Defined in packages/core/src/common/preferences/injectable-preference-proxy.ts:106

getOwnPropertyDescriptor

getOwnPropertyDescriptor(target: unknown, property: string): PropertyDescriptor
A trap for Object.getOwnPropertyDescriptor().
Parameters
- target: unknown
  The original object which is being proxied.
- property: string
Returns PropertyDescriptor
Implementation of ProxyHandler.getOwnPropertyDescriptor
- Defined in packages/core/src/common/preferences/injectable-preference-proxy.ts:212

`Protected`getValue

getValue<K extends string>(
    preferenceIdentifier: K | OverridePreferenceName & { preferenceName: K },
    defaultValue: T[K],
    resourceUri?: undefined | string,
): T[K]
Type Parameters
- K extends string
Parameters
- preferenceIdentifier: K | OverridePreferenceName & { preferenceName: K }
- defaultValue: T[K]
- resourceUri: undefined | string = ...
Returns T[K]
- Defined in packages/core/src/common/preferences/injectable-preference-proxy.ts:271

`Protected`handlePreferenceChanges

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

`Protected`init

init(): void
Returns void
- Defined in packages/core/src/common/preferences/injectable-preference-proxy.ts:97

`Protected`isRelevantChange

isRelevantChange(
change: PreferenceChange,
overrideInfo?: OverridePreferenceName,
): boolean
Parameters
- change: PreferenceChange
- OptionaloverrideInfo: OverridePreferenceName
Returns boolean
- Defined in packages/core/src/common/preferences/injectable-preference-proxy.ts:253

ownKeys

ownKeys(): string[]
A trap for Reflect.ownKeys().

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

set

set(
    target: unknown,
    property: string,
    value: unknown,
    receiver: unknown,
): boolean
A trap for setting a property value.
Parameters
- target: unknown
  The original object which is being proxied.
- property: string
- value: unknown
- receiver: unknown
  The object to which the assignment was originally directed.
Returns boolean
A Boolean indicating whether or not the property was set.
Implementation of ProxyHandler.set
- Defined in packages/core/src/common/preferences/injectable-preference-proxy.ts:156

`Protected`subscribeToChangeEvents

subscribeToChangeEvents(): void
Returns void
- Defined in packages/core/src/common/preferences/injectable-preference-proxy.ts:238

toJSON

toJSON(): JSONValue
Returns JSONValue
- Defined in packages/core/src/common/preferences/injectable-preference-proxy.ts:230

Class InjectablePreferenceProxy<T>

Type Parameters

Implements

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Type Parameters

Returns InjectablePreferenceProxy<T>

Properties

Protected_onPreferenceChangedEmitter

Protected Readonlyfactory

Protected Readonlyoptions

Protected Readonlypreferences

Protected ReadonlypromisedSchema

Protectedschema

ProtectedtoDispose

Accessors

ProtectedisDeep

Returns boolean

ProtectedisFlat

Returns boolean

onPreferenceChanged

Returns Event<PreferenceChangeEvent<T>>

ProtectedonPreferenceChangedEmitter

Returns Emitter<PreferenceChangeEvent<T>>

ProtectedoverrideIdentifier

Returns undefined | string

Protectedprefix

Returns string

ProtectedresourceUri

Returns undefined | string

Protectedstyle

Returns "flat" | "deep" | "both"

Methods

ProtectedbuildNewChangeEvent

Parameters

Returns PreferenceChangeEvent<T>

defineProperty

Returns never

deleteProperty

Returns never

dispose

Returns void

ProtectedfireChangeEvent

Parameters

Returns void

get

Parameters

Returns unknown

getOwnPropertyDescriptor

Parameters

Returns PropertyDescriptor

ProtectedgetValue

Type Parameters

Parameters

Returns T[K]

ProtectedhandlePreferenceChanges

Parameters

Returns void

Protectedinit

Returns void

ProtectedisRelevantChange

Parameters

Returns boolean

ownKeys

Returns string[]

set

Parameters

Returns boolean

ProtectedsubscribeToChangeEvents

Returns void

toJSON

Returns JSONValue

Settings

On This Page

`Protected`_onPreferenceChangedEmitter

`Protected` `Readonly`factory

`Protected` `Readonly`options

`Protected` `Readonly`preferences

`Protected` `Readonly`promisedSchema

`Protected`schema

`Protected`toDispose

`Protected`isDeep

`Protected`isFlat

`Protected`onPreferenceChangedEmitter

`Protected`overrideIdentifier

`Protected`prefix

`Protected`resourceUri

`Protected`style

`Protected`buildNewChangeEvent

`Protected`fireChangeEvent

`Protected`getValue

`Protected`handlePreferenceChanges

`Protected`init

`Protected`isRelevantChange

`Protected`subscribeToChangeEvents