SettingsDictionary Interface
A named container that supplies values for Settings.
@see addDictionary to register a new settings dictionary.
Methods
| Name | Description | |
|---|---|---|
| getSetting<T extends JSONSchemaType>(settingName: string): undefined | T | Obtain a copy of the value of the setting named settingName stored in this dictionary, or undefined if no such setting exists. |
|
| toJSON(): SettingsContainer | Return a deep copy of all settings in this dictionary as a SettingsContainer. |
Properties
| Name | Type | Description | |
|---|---|---|---|
| props Readonly | SettingsDictionaryProps | Metadata describing the dictionary. |
Defined in
Last Updated: 28 March, 2026
Found something wrong, missing, or unclear on this page? Raise an issue in our repo.