Function isEnum

isEnum<TEnum extends Record<string, string | number>>(
enumeration: TEnum,
candidate: unknown,
): candidate is TEnum[keyof TEnum]
Gets whether the candidate can represent an enumeration object of type TEnum.

This is mostly helpful for type guarding value options in a type.
Type Parameters
- TEnum extends Record<string, string | number>
Parameters
- enumeration: TEnum
  The enumeration object that contains the values.
- candidate: unknown
  The candidate to check.
Returns candidate is TEnum[keyof TEnum]
True if candidate can represents one of the white listed object values in enumeration.
- Defined in enum/is-enum.mts:15