resolveSetting Method
Overloads | |
---|---|
resolveSetting<T extends JSONSchemaType>(settingName, resolver, defaultValue?) | |
resolveSetting<T extends JSONSchemaType>(settingName, resolver, defaultValue) |
resolveSetting<T extends JSONSchemaType>(settingName, resolver, defaultValue?)
resolveSetting<T extends JSONSchemaType>(settingName: string, resolver: SettingResolver<T>, defaultValue?: T): undefined | T
Parameter | Type | Description |
---|---|---|
settingName | string | |
resolver | SettingResolver<T> | |
defaultValue | T |
Returns - undefined | T
resolveSetting<T extends JSONSchemaType>(settingName, resolver, defaultValue)
Resolve a setting, by name, using a SettingResolver.
resolveSetting<T extends JSONSchemaType>(settingName: string, resolver: SettingResolver<T>, defaultValue: T): T
@returns the resolved setting value.
Parameter | Type | Description |
---|---|---|
settingName | string | The name of the setting to resolve |
resolver | SettingResolver<T> | function to be called for each SettingDictionary with a matching Setting. Iteration stops when it returns a non-undefined value. |
defaultValue | T | value returned if settingName is not present in any SettingDictionary or resolver never returned a value. |
Returns - T
the resolved setting value.
Defined in
Last Updated: 17 May, 2024
Found something wrong, missing, or unclear on this page?Raise an issue in our repo.