Function createPreferenceProxy

createPreferenceProxy<T>(preferences, promisedSchema, options?): PreferenceProxy<T>
Creates a preference proxy for typesafe preference handling.
Type Parameters
- T
Parameters
- preferences: PreferenceService
  the underlying preference service to use for preference handling.
- promisedSchema: MaybePromise<PreferenceSchema>
  the JSON Schema which describes which preferences are available including types and descriptions. Can be a promise.
- Optional options: PreferenceProxyOptions
  configuration options.
Returns PreferenceProxy<T>
the created preference proxy.

Usage
1. Create JSON Schema specifying your preferences
2. Create Configuration type based on the JSON Schema
3. Bind the return value of createPreferenceProxy to make your preferences available wherever needed.
See CorePreferences for an example.

Note that if schema is a Promise, most actions will be no-ops until the promise is resolved.

Deprecated
Since
1.23.0 use PreferenceProxyFactory instead.
- Defined in packages/core/src/browser/preferences/preference-proxy.ts:177