Theia API Documentation v1.67.0
    Preparing search index...

    Interface PreferenceChange

    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.

    interface PreferenceChange {
        domain?: string[];
        newValue?: JSONValue;
        oldValue?: JSONValue;
        preferenceName: string;
        scope: PreferenceScope;
        affects(resourceUri?: string): boolean;
    }

    Hierarchy (View Summary)

    Implemented by

    Index

    Properties

    domain? newValue? oldValue? preferenceName scope

    Methods

    affects

    Properties

    domain?: string[]

    URIs of the scopes in which this change applies.

    newValue?: JSONValue

    The new value of the changed preference. Can be undefined for multiple reasons:

    • The preference has been reset to its default value.
    • The preference has been reset and has no value explicitly stored. If undefined, use the preference service to determine the effective new value if needed.
    oldValue?: JSONValue

    The old value of the changed preference.

    preferenceName: string

    The name of the changed preference.

    scope: PreferenceScope

    The PreferenceScope of the changed preference.

    Methods

    Settings

    Member Visibility

    On This Page

    Properties
    Methods