IFlatConfigItem
Defined in: src/types/IFlatConfig.ts:11
A configuration item as produced by Configuard.parseFlat().
It mirrors IConfigItem, except that any ${...} placeholders in value
are resolved (the value stays a string — it is not cast to its type), and
the options field is resolved from its referenced “option list” into a
string array (or null when the item has no options).
Extends
Section titled “Extends”Omit<IConfigItem,"options">
Properties
Section titled “Properties”accessor
Section titled “accessor”accessor:
AccessorType
Defined in: src/types/IAccessorInfo.ts:12
Type of the clients allowed to access this configuration item. Either
“system”, “application” or “all”. See AccessorType enumeration.
Default
Section titled “Default”"application"Inherited from
Section titled “Inherited from”appAccess?
Section titled “appAccess?”
optionalappAccess?:number|null
Defined in: src/types/IAccessorInfo.ts:19
Bitwise value of client config flags which specifies which application
clients have access to this configuration item. Has no affect if
accessor is set to a value other than "application".
Default
Section titled “Default”nullInherited from
Section titled “Inherited from”
optionalid?:number|null
Defined in: src/types/IConfigItem.ts:12
Record ID.
Inherited from
Section titled “Inherited from”key:
string
Defined in: src/types/IConfigItem.ts:16
Dot-notation of the configuration item as an object property.
Inherited from
Section titled “Inherited from”type:
ValueType
Defined in: src/types/IConfigItem.ts:21
Data type of the configuration item. See ValueType enumeration for
possible values.
Inherited from
Section titled “Inherited from”listType
Section titled “listType”listType:
ListType
Defined in: src/types/IConfigItem.ts:27
Specifies the type of value list, indicating whether it’s an array or
comma separated list. Set to "none" if the value is not a list. See
ListType enumeration for possible values. Default: "none"
Inherited from
Section titled “Inherited from”value?
Section titled “value?”
optionalvalue?:string|null
Defined in: src/types/IConfigItem.ts:32
Configuration item’s value to be parsed into specified type.
Default
Section titled “Default”nullInherited from
Section titled “Inherited from”defaultValue?
Section titled “defaultValue?”
optionaldefaultValue?:string|null
Defined in: src/types/IConfigItem.ts:41
Initial (factory) value of the configuration. This should be used for reverting the configuration.
Inherited from
Section titled “Inherited from”editable
Section titled “editable”editable:
boolean
Defined in: src/types/IConfigItem.ts:46
Whether this configuration is editable by the accessor.
Default
Section titled “Default”trueInherited from
Section titled “Inherited from”requiresReboot
Section titled “requiresReboot”requiresReboot:
boolean
Defined in: src/types/IConfigItem.ts:52
Whether this configuration requires the related app/system to be rebooted, if changed.
Default
Section titled “Default”falseInherited from
Section titled “Inherited from”encrypt
Section titled “encrypt”encrypt:
boolean
Defined in: src/types/IConfigItem.ts:58
Whether this configuration should be encrypted at rest. Decryption is
opt-in via the decrypt hook (see IConfiguardOptions).
Default
Section titled “Default”falseInherited from
Section titled “Inherited from”description?
Section titled “description?”
optionaldescription?:string|null
Defined in: src/types/IConfigItem.ts:62
Description of the configuration item.
Inherited from
Section titled “Inherited from”options?
Section titled “options?”
optionaloptions?:string[] |null
Defined in: src/types/IFlatConfig.ts:17
Possible values for this configuration, resolved into a string array from
the referenced @-key option list (or an inline comma-separated list).
null when the item declares no options.