An object that describes a directive, its values and all available metadata.
Parameter |
Type |
Count |
Description |
name |
String |
1 |
The directive’s actual name in the configuration |
section |
String |
1 |
Section name within the configuration file |
fileValue |
Enum |
1 |
Registered value for the directive in the configuration file |
defaultValue |
Boolean |
1 |
Official default value for the directive when no value is specified |
previousValue |
Boolean |
1 |
Following a value change for a directive, the previous value (which is still in effect) is returned. This value disappears once the server is restarted |
description |
Boolean |
1 |
Text describing the directive and its use |
type |
String |
1 |
One of: String, Select, Boolean, Shorthand, int, int_boolean |
units |
String |
1 |
String for the units the directive measures/specifies |
listValues |
List of strings |
1 |
A list of listValue elements which contain possible values for a “Select” type directive |
Version: 1.3