Constructor
(abstract) new KeyedEnum(name, key)
Constructor.
Name | Type | Description |
---|---|---|
name | string | the unique name for this type |
key | string | the key value associated with this type |
- Source
Extends
Members
key
Get the key value.
- Source
name
Get the enum name.
- Overrides
- Source
Methods
equals(value) → {boolean}
Test if a string is equal to this enum's name.
As long as enum values are consistently obtained from the module:util~Enum.enumValues array then enum instances can be compared with ===
. If unsure, this method can be used to compare string values instead.
If value
is passed as an actual Enum instance, then if that enum is the same class as this enum it's name
is compared to this instance's name
.
Name | Type | Description |
---|---|---|
value | string | | the value to test |
- Overrides
- Source
true
if value
is the same as this instance's name
value
- Type:
- boolean
(static) valueOf(value) → {module:util~KeyedEnum|null}
Get an enum instance from its key or name.
This method searches the module:util~Enum#enumVvalues array for a matching key or name value.
Name | Type | Description |
---|---|---|
value | string | the enum key or name to get the enum instance for |
- Source
the matching enum value, or null
if no values match
- Type:
- module:util~KeyedEnum |
null