Options
All
  • Public
  • Public/Protected
  • All
Menu

Module preferences

Index

References

Namespaces

Enumerations

Classes

Interfaces

Type aliases

Properties

Variables

Functions

References

AbstractResourcePreferenceProvider

Re-exports AbstractResourcePreferenceProvider

FolderPreferenceProvider

Re-exports FolderPreferenceProvider

FolderPreferenceProviderFactory

Re-exports FolderPreferenceProviderFactory

FolderPreferenceProviderFolder

Re-exports FolderPreferenceProviderFolder

FolderPreferenceProviderOptions

Re-exports FolderPreferenceProviderOptions

FoldersPreferencesProvider

Re-exports FoldersPreferencesProvider

UserConfigsPreferenceProvider

Re-exports UserConfigsPreferenceProvider

UserPreferenceProvider

Re-exports UserPreferenceProvider

UserPreferenceProviderFactory

Re-exports UserPreferenceProviderFactory

WorkspacePreferenceProvider

Re-exports WorkspacePreferenceProvider

Type aliases

JsonType

JsonType: "string" | "array" | "number" | "integer" | "object" | "boolean" | "null"

PreferenceChangeEvent

PreferenceChangeEvent<T>: { affects: any } & {[ K in keyof T]: { newValue: T[K]; oldValue?: T[K]; preferenceName: K } }[keyof T]

Union of all possible key/value pairs for a type T

Type parameters

  • T

PreferenceInspectionScope

PreferenceInspectionScope: keyof Omit<PreferenceInspection<unknown>, "preferenceName">

PreferenceNodeRendererFactory

PreferenceNodeRendererFactory: (node: TreeNode) => PreferenceNodeRenderer

Type declaration

PreferenceProviderProvider

PreferenceProviderProvider: (scope: PreferenceScope, uri?: URI) => PreferenceProvider

Type declaration

PreferenceProxy

PreferenceProxy<T>: Readonly<T> & Disposable & PreferenceEventEmitter<T> & PreferenceRetrieval<T>

Typesafe schema-based preferences utility based on the PreferenceService. Can be used to get preferences as well as listen to preference changes.

See createPreferenceProxy on how to instantiate preference proxies.

Example usage

 
preferences.onPreferenceChanged(({ preferenceName, newValue }) => { ... });
const enabled = preferences['myext.enabled'];

Type parameters

  • T

WorkspaceFilePreferenceProviderFactory

WorkspaceFilePreferenceProviderFactory: (options: WorkspaceFilePreferenceProviderOptions) => WorkspaceFilePreferenceProvider

Type declaration

Properties

default

default: ContainerModule

Variables

Const COMMONLY_USED_SECTION_PREFIX

COMMONLY_USED_SECTION_PREFIX: "commonly-used" = 'commonly-used'

Const FOLDER_SCOPE_MENU_PATH

FOLDER_SCOPE_MENU_PATH: string[] = ...
deprecated

since 1.17.0 moved to PreferenceMenus namespace.

Const FolderPreferenceProviderFactory

FolderPreferenceProviderFactory: typeof FolderPreferenceProviderFactory = ...

Const FolderPreferenceProviderFolder

FolderPreferenceProviderFolder: typeof FolderPreferenceProviderFolder = ...

Const HEADER_CLASS

HEADER_CLASS: "settings-section-category-title" = 'settings-section-category-title'

Const OVERRIDE_PROPERTY_PATTERN

OVERRIDE_PROPERTY_PATTERN: RegExp
deprecated

since 1.13.0 import from @theia/core/lib/browser/preferences/preference-language-override-service.

Const PreferenceContribution

PreferenceContribution: unique symbol

Const PreferenceNodeRendererFactory

PreferenceNodeRendererFactory: typeof PreferenceNodeRendererFactory = ...

Const PreferenceProviderProvider

PreferenceProviderProvider: unique symbol

We cannot load providers directly in the case if they depend on PreferenceService somehow. It allows to load them lazily after DI is configured.

Const PreferenceService

PreferenceService: unique symbol

Const SUBHEADER_CLASS

SUBHEADER_CLASS: "settings-section-subcategory-title" = 'settings-section-subcategory-title'

Const SectionPreferenceProviderSection

SectionPreferenceProviderSection: typeof SectionPreferenceProviderSection = ...

Const SectionPreferenceProviderUri

SectionPreferenceProviderUri: typeof SectionPreferenceProviderUri = ...

Const UserPreferenceProviderFactory

UserPreferenceProviderFactory: typeof UserPreferenceProviderFactory = ...

Const WorkspaceFilePreferenceProviderFactory

WorkspaceFilePreferenceProviderFactory: typeof WorkspaceFilePreferenceProviderFactory = ...

Functions

bindFactory

  • bindFactory<F, C>(bind: interfaces.Bind, factoryId: interfaces.ServiceIdentifier<F>, constructor: interfaces.Newable<C>, ...parameterBindings: interfaces.ServiceIdentifier<any>[]): void

bindPreferenceProviders

  • bindPreferenceProviders(bind: interfaces.Bind, unbind: interfaces.Unbind): void

bindPreferenceSchemaProvider

  • bindPreferenceSchemaProvider(bind: interfaces.Bind): void

  • Parameters

    • bind: interfaces.Bind

    Returns void

bindPreferences

  • bindPreferences(bind: interfaces.Bind, unbind: interfaces.Unbind): void

bindPreferencesWidgets

  • bindPreferencesWidgets(bind: interfaces.Bind): void

bindWorkspaceFilePreferenceProvider

  • bindWorkspaceFilePreferenceProvider(bind: interfaces.Bind): void

createPreferenceProxy

  • 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.

Const getOverridePattern

  • getOverridePattern(identifier: string): string

  • Parameters

    • identifier: string

    Returns string