xdash API Reference / toEnum
Function: toEnum()
toEnum<
T,CapitalizeKeys,CapitalizeValues>(list,options):EnumFromList<T,CapitalizeKeys,CapitalizeValues>
Defined in: src/typed.ts:112
Converts a list of strings to an enum.
Type Parameters
T
T extends readonly string[]
CapitalizeKeys
CapitalizeKeys extends boolean = true
CapitalizeValues
CapitalizeValues extends boolean = false
Parameters
list
T
list of strings to convert to an enum
options
options to customize the enum
capitalizeKeys?
CapitalizeKeys
capitalizeValues?
CapitalizeValues
Returns
EnumFromList<T, CapitalizeKeys, CapitalizeValues>
an enum from the list