Class DefaultConfigurationProvider

Base configuration provider for building up other configuration providers

Implements

ConfigurationProvider

Index

Constructors

Properties

_ready onConfigurationSectionUpdateEmitter serviceRegistry settings workspaceConfig

Accessors

onConfigurationSectionUpdate ready

Methods

getConfiguration initialize initialized toSectionName updateConfiguration updateSectionConfiguration

Constructors

constructor

new DefaultConfigurationProvider(
services: LangiumSharedCoreServices,
): DefaultConfigurationProvider
Parameters
- services: LangiumSharedCoreServices
Returns DefaultConfigurationProvider
- Defined in packages/langium/src/workspace/configuration.ts:94

Properties

`Protected` `Readonly`_ready

_ready: Deferred<void> = ...

`Protected` `Readonly`onConfigurationSectionUpdateEmitter

onConfigurationSectionUpdateEmitter: Emitter<ConfigurationSectionUpdate> = ...

`Protected` `Readonly`serviceRegistry

serviceRegistry: ServiceRegistry

`Protected`settings

settings: Record<string, Record<string, any>> = {}

`Protected`workspaceConfig

workspaceConfig: boolean = false

Accessors

onConfigurationSectionUpdate

get onConfigurationSectionUpdate(): Event<ConfigurationSectionUpdate>
Get notified after a configuration section has been updated.

Returns Event<ConfigurationSectionUpdate>
Implementation of ConfigurationProvider.onConfigurationSectionUpdate
- Defined in packages/langium/src/workspace/configuration.ts:176

ready

get ready(): Promise<void>
A promise that resolves when the configuration provider is ready to be used.

Returns Promise<void>
Implementation of ConfigurationProvider.ready
- Defined in packages/langium/src/workspace/configuration.ts:98

Methods

getConfiguration

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

initialize

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

initialized

initialized(params: ConfigurationInitializedParams): 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>
Implementation of ConfigurationProvider.initialized
- Defined in packages/langium/src/workspace/configuration.ts:106

`Protected`toSectionName

toSectionName(languageId: string): string
Parameters
- languageId: string
Returns string
- Defined in packages/langium/src/workspace/configuration.ts:172

updateConfiguration

updateConfiguration(change: DidChangeConfigurationParams): 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
Implementation of ConfigurationProvider.updateConfiguration
- Defined in packages/langium/src/workspace/configuration.ts:143

`Protected`updateSectionConfiguration

updateSectionConfiguration(section: string, configuration: any): void
Parameters
- section: string
- configuration: any
Returns void
- Defined in packages/langium/src/workspace/configuration.ts:153