Interface ConfigurationProvider

interface ConfigurationProvider {
    ready: Promise<void>;
    getConfiguration(language: string, configuration: string): Promise<any>;
    initialize(params: InitializeParams): void;
    initialized(params: ConfigurationInitializedParams): Promise<void>;
    onConfigurationSectionUpdate(callback: ConfigurationSectionUpdateListener): Disposable;
    updateConfiguration(change: DidChangeConfigurationParams): void;
}

Implemented by

DefaultConfigurationProvider

Index

Properties

Methods

getConfiguration initialize initialized onConfigurationSectionUpdate updateConfiguration

Properties

`Readonly`ready

ready: Promise<void>

A promise that resolves when the configuration provider is ready to be used.

Methods

getConfiguration

getConfiguration(language, configuration): Promise<any>
Returns a configuration value stored for the given language.
Parameters
- language: string
  The language id
- configuration: string
  Configuration name
Returns Promise<any>
- Defined in packages/langium/src/workspace/configuration.ts:48

initialize

initialize(params): void
When used in a language server context, this method is called when the server receives the initialize request.
Parameters
- params: InitializeParams
Returns void
- Defined in packages/langium/src/workspace/configuration.ts:34

initialized

initialized(params): Promise<void>
When used in a language server context, this method is called when the server receives the initialized notification.
Parameters
- params: ConfigurationInitializedParams
Returns Promise<void>
- Defined in packages/langium/src/workspace/configuration.ts:40

onConfigurationSectionUpdate

onConfigurationSectionUpdate(callback): Disposable
Get notified after a configuration section has been updated.
Parameters
- callback: ConfigurationSectionUpdateListener
Returns Disposable
- Defined in packages/langium/src/workspace/configuration.ts:61

updateConfiguration

updateConfiguration(change): void
Updates the cached configurations using the change notification parameters.
Parameters
- change: DidChangeConfigurationParams
  The parameters of a change configuration notification. settings property of the change object could be expressed as Record<string, Record<string, any>>
Returns void
- Defined in packages/langium/src/workspace/configuration.ts:56