Type Alias EnumMethods<T>

Readonly[iterator]

Readonly[toStringTag]

count

• count(): number

  number of entries in the Enum

  Returns number

entries

• entries(): EntryOf<T>[]

  tuple of enumerable entries

  Returns EntryOf<T>[]

extend

• extend<const E extends any[] | Property<any>>(
      list: E,
      frozen?: boolean,
  ): EnumifyType<any>

  extend an Enum with new entries

  Type Parameters

  • const E extends any[] | Property<any>

  Parameters

  • list: E
  • Optionalfrozen: boolean

  Returns EnumifyType<any>

filter

• filter(
      fn: (
          entry: EntryOf<T>,
          index: number,
          enumify: EnumifyType<any>,
      ) => boolean,
      thisArg?: any,
  ): EnumifyType<Partial<T>>

  filter Enum entries and return a new Enum

  Parameters

  • fn: (entry: EntryOf<T>, index: number, enumify: EnumifyType<any>) => boolean
  • OptionalthisArg: any

  Returns EnumifyType<Partial<T>>

forEach

• forEach(
      fn: (
          entry: EntryOf<T>,
          index: number,
          enumify: EnumifyType<any>,
      ) => void,
      thisArg?: any,
  ): void

  iterate through all Enum entries

  Parameters

  • fn: (entry: EntryOf<T>, index: number, enumify: EnumifyType<any>) => void
  • OptionalthisArg: any

  Returns void

has

• has(key: LooseKey<KeyOf<T>>): boolean

  check if a 'key' exists in the Enum

  Parameters

  • key: LooseKey<KeyOf<T>>

  Returns boolean

includes

• includes(search: LooseKey<ValueOf<T>>): boolean

  check if a 'value' exists in the Enum

  Parameters

  • search: LooseKey<ValueOf<T>>

  Returns boolean

invert

• invert(): Invert<T>

  return an object with the keys and values swapped

  Returns Invert<T>

keyOf

• keyOf(search: LooseKey<ValueOf<T>>): KeyOf<T>

  return the key for a given value

  Parameters

  • search: LooseKey<ValueOf<T>>

  Returns KeyOf<T>

keys

• keys(): KeyOf<T>[]

  array of all enumerable property names

  Returns KeyOf<T>[]

map

• map(
      fn: (entry: EntryOf<T>, index: number, enumify: EnumifyType<any>) => any,
      thisArg?: any,
  ): EnumifyType<Property<any>>

  map Enum entries and return a new Enum

  Parameters

  • fn: (entry: EntryOf<T>, index: number, enumify: EnumifyType<any>) => any
  • OptionalthisArg: any

  Returns EnumifyType<Property<any>>

values

• values(): ValueOf<T>[]

  array of all enumerable object values

  Returns ValueOf<T>[]