Enum

Index

Type Aliases

• KeyOf
• ValueOf

Variables

• enumKeys

Functions

• define
• keys
• values

Type Aliases

KeyOf

KeyOf<T>: ArrayValue<T[typeof Symbol.enumKeys]>

Return enum keys of T

---

Type parameters

• T: Enum<Record<string, any>>

ValueOf

ValueOf<T>: T[KeyOf<T>]

Return enum values of T

---

Type parameters

• T: Enum<Record<string, any>>

Variables

enumKeys

enumKeys: symbol = Symbol.enumKeys

Symbol for the property holding enum keys

Functions

define

• define<T>(enumObject: T & { typeName?: string }): Enum<T>

• Define a new Enum Object

  @example

  const MyEnum = Enum.define({
    // typeName: 'MyEnum', // Add this we want a named Enum
    Foo: 'foo',
    Bar: 'bar',
  });

  ---

  Type parameters

  • T: Record<string, string | number | boolean>

keys

• keys<T>(enumObject: T): ReadonlyArray<Enum.KeyOf<T>>

• Returns an array of enum keys

  @example

  const MyEnum = Enum.define({ Foo: 'foo', Bar: 'bar' });
  Enum.keys(MyEnum) // ['Foo', 'Bar']

  ---

  Type parameters

  • T: Enum

values

• values<T>(enumObject: T): ReadonlyArray<Enum.ValueOf<T>>

• Returns an array of enum values

  @example

  const MyEnum = Enum.define({ Foo: 'foo', Bar: 'bar' });
  Enum.values(MyEnum) // ['foo', 'bar']

  ---

  Type parameters

  • T: Enum