Abstract Constructor.
the name
the comparable value
Private Readonly #namePrivate Readonly #valueGet the enum name.
the name
Get the comparable value.
the value
Compare two ComparableEnum objects based on their value values.
the object to compare to
negative value, zero, or positive value if this instance is less than, equal to, or greater than o
Test if a string is equal to this enum's name.
As long as enum values are consistently obtained from the 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.
the value to test
true if value is the same as this instance's name value
Static enumStatic enumsThis method takes an array of enums and turns them into a mapped object, using the enum
name as object property names.
the enum list to turn into a value object
an object with enum name properties with associated enum values
Static minimumCompute a complete set of enum values based on a minimum enum and/or set of enums.
If cache is provided, then results computed via minAggregation
will be cached there, and subsequent calls will returned the cached result when appropriate.
Optional minEnum: Ta minimum enum value
Optional cache: Map<string, Set<T>>a cache of computed values
the computed set, or undefined if no values match
Static namesGet the names of a set of Enum instances.
the set of Enum instances to get the names of
array of Enum name values
Static valueGet an enum instance from its name.
This method searches the Util.Enum.enumValues array for a matching value.
the enum name to get an instnace for
the instance, or undefined if no instance exists for the given name
Generated using TypeDoc
An immutable enum-like object with an associated comparable value.
This class must be extended by another class that overrides the inerited Util.Enum.enumValues method.
Abstract