new ObjectOption(value [, comment] [, category] [, range])
Stores any object. Shallow copies the object using
object.assign.
Parameters:
| Name | Type | Argument | Default | Description |
|---|---|---|---|---|
value |
object | Value of this option. | ||
comment |
string |
<optional> <nullable> |
null | Comment/description for the user about this option. |
category |
string |
<optional> <nullable> |
null | Category this option falls under for showing user. |
range |
Object |
<optional> |
Range of allowable values for this option. |
- Source:
Extends
Members
-
<nullable> category :string
-
Get the category of this option.
Type:
- string
- Inherited From:
- Overrides:
- Source:
-
<nullable> comment :string
-
Get the description of this option.
Type:
- string
- Inherited From:
- Overrides:
- Source:
-
entries
-
- Inherited From:
- Overrides:
- Source:
-
keys
-
- Inherited From:
- Overrides:
- Source:
-
range
-
Get the range of allowable values for this option.
- Source:
-
value :*
-
Get the value of this option.
Type:
- *
- Inherited From:
- Overrides:
- Source: