type-fns/dist/checks/isOfEnum.d.ts

A set of types, type checks, and type guards for simpler, safer, and easier to read code.

import { AssessWithAssure } from '../wrappers/withAssure';
/**
 * a generic fn that allows us to create type checks for enums. for example:
 * ```ts
 *   // you have an enum
 *   enum Planet {
 *     ...
 *     VENUS = 'VENUS',
 *     EARTH = 'EARTH',
 *     MARS = 'MARS',
 *     ...
 *   }
 *
 *   // define a type check for your enum
 *   const isPlanet = createIsOfEnum.assess(Planet);
 *
 *   // use it to assess type for type guarded blocks
 *   if (!isPlanet.assess(potentialPlanet)) throw new Error('is not a planet');
 *
 *   // use it to assure type for type guarded type casts
 *   const planet: Planet = isPlanet.assure(potentialPlanet)
 * ```
 *
 * ref: https://stackoverflow.com/a/58278753/3068233
 */
export declare const createIsOfEnum: <T extends {
    [index: string]: string | number;
    [index: number]: string | number;
    [index: symbol]: string | number;
}>(e: T) => AssessWithAssure<string | number | symbol, T[keyof T]>;