Interface PreferenceProxyOptions

Proxy configuration parameters.

interface PreferenceProxyOptions {
    isDisposable?: boolean;
    overrideIdentifier?: string;
    prefix?: string;
    resourceUri?: string;
    style?: "flat" | "deep" | "both";
}

Properties

isDisposable? overrideIdentifier? prefix? resourceUri? style?

Properties

Optional isDisposable

isDisposable?: boolean

Indicates whether the proxy should be disposable. Proxies that are shared between multiple callers should not be disposable.

Optional overrideIdentifier

overrideIdentifier?: string

The overrideIdentifier to use with the underlying preferenceService. Useful to potentially override existing values while keeping both values in store.

For example to store different editor settings, e.g. "[markdown].editor.autoIndent", "[json].editor.autoIndent" and "editor.autoIndent"

Optional prefix

prefix?: string

Prefix which is transparently added to all preference identifiers.

Optional resourceUri

resourceUri?: string

The default resourceUri to use if none was specified when calling "set" or "get".

Optional style

style?: "flat" | "deep" | "both"

Indicates whether '.' in schema properties shall be interpreted as regular names (flat), as declaring nested objects (deep) or both. Default is flat.

When 'deep' or 'both' is given, nested preference proxies can be retrieved.

Settings

Member Visibility

Theme

On This Page

isDisposableoverrideIdentifierprefixresourceUristyle