Interface SettingsDefinition<TSpecs>

A validated settings group bound to one configuration section. Register it with a Module to make its SettingsAccessor token available at activation.

interface SettingsDefinition<TSpecs extends SettingSpecs> {
    contributed: boolean;
    policy: SettingsValidationPolicy;
    section: string;
    token: ServiceToken<SettingsAccessor<SettingsValues<TSpecs>>>;
    values: TSpecs;
}

Type Parameters

TSpecs extends SettingSpecs

Index

Properties

contributed policy section token values

Properties

`Readonly`contributed

contributed: boolean

Whether this extension contributes the section in its manifest, or only reads it.

`Readonly`policy

policy: SettingsValidationPolicy

How invalid values are treated. Defaults to lenient.

`Readonly`section

section: string

Configuration section, for example sample.projects.

`Readonly`token

token: ServiceToken<SettingsAccessor<SettingsValues<TSpecs>>>

Token the accessor is registered under, so handlers can inject it.

`Readonly`values

values: TSpecs

The specs, keyed by setting name.

Interface SettingsDefinition<TSpecs>

Type Parameters

Index

Properties

Properties

Readonlycontributed

Readonlypolicy

Readonlysection

Readonlytoken

Readonlyvalues

Settings

On This Page

`Readonly`contributed

`Readonly`policy

`Readonly`section

`Readonly`token

`Readonly`values