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

    Interface PreferenceRetrieval<T>

    Generic interface to declare a typesafe get function based on the given configuration type.

    interface PreferenceConfiguration {
     'myext.enabled': boolean,
    }
    const enabled : boolean = prefs.get('myext.enabled'); // valid
    const debug : string = prefs.get('myext.enabled'); // invalid
    prefs.get('foobar'); // invalid
    interface PreferenceRetrieval<T> {
        get<K extends string | number | symbol>(
            preferenceName: K | { overrideIdentifier?: string; preferenceName: K },
            defaultValue?: T[K],
            resourceUri?: string,
        ): T[K];
    }

    Type Parameters

    • T
    Index

    Methods

    get

    Methods

    • Type Parameters

      • K extends string | number | symbol

      Parameters

      • preferenceName: K | { overrideIdentifier?: string; preferenceName: K }
      • OptionaldefaultValue: T[K]
      • OptionalresourceUri: string

      Returns T[K]

    Settings

    Member Visibility

    On This Page

    Illustration
    Methods