Function castEnum

Attempts to cast the candidate to an enumeration value.

Param: enumeration

The enumeration type.

Param: candidate

The candidate to cast to the enum type.

Param: fallback

The fallback to use in the case that candidate cannot represent the enumeration type.

Returns

The candidate if candidate represents the enumeration type, or fallback in the case that it does not.

castEnum<TEnum extends Record<string, string | number>>(
enumeration: TEnum,
candidate: unknown,
): TEnum[keyof TEnum] | undefined
Attempts to cast the candidate to an enumeration value.
Type Parameters
- TEnum extends Record<string, string | number>
Parameters
- enumeration: TEnum
  The enumeration type.
- candidate: unknown
  The candidate to cast to the enum type.
Returns TEnum[keyof TEnum] | undefined
The candidate if candidate represents the enumeration type, or undefined in the case that it does not.
- Defined in cast/cast-enum.mts:15
castEnum<TEnum extends Record<string, string | number>>(
    enumeration: TEnum,
    candidate: unknown,
    fallback: TEnum[keyof TEnum],
): TEnum[keyof TEnum]
Attempts to cast the candidate to an enumeration value.
Type Parameters
- TEnum extends Record<string, string | number>
Parameters
- enumeration: TEnum
  The enumeration type.
- candidate: unknown
  The candidate to cast to the enum type.
- fallback: TEnum[keyof TEnum]
  The fallback to use in the case that candidate cannot represent the enumeration type.
Returns TEnum[keyof TEnum]
The candidate if candidate represents the enumeration type, or fallback in the case that it does not.
- Defined in cast/cast-enum.mts:35