Class Enum

ReadonlyisEnum

StaticaddFlag

• addFlag<
      T,
      K =
          | number
          | BrandedType<number, "enum">
          | BrandedType<number, EnumPrototype<T>>,
  >(
      value: K,
      bits: EnumValueTyped<T>,
  ): K

  Adds the flag bits to the enum value.

  Type Parameters

  • T
  • K = number | BrandedType<number, "enum"> | BrandedType<number, EnumPrototype<T>>

  Parameters

  • value: K
  • bits: EnumValueTyped<T>

  Returns K

StaticcombineFlags

• combineFlags<TEnum extends typeof Enum>(
      this: TEnum,
      values: readonly EnumValueTyped<TEnum["prototype"], number>[],
  ): EnumValueTyped<TEnum["prototype"]>

  Takes an array of enum values and combines them as a single enum flag value. This assumes that the target enum is a flag enum that can have their values combined using bitwise operators.

  Type Parameters

  • TEnum extends typeof Enum

  Parameters

  • this: TEnum
  • values: readonly EnumValueTyped<TEnum["prototype"], number>[]

    The array of values to be combined using bitwise-or operator.

  Returns EnumValueTyped<TEnum["prototype"]>

  The combined enum value.

StaticgetEnumName

• getEnumName<TEnum extends typeof Enum>(
      this: TEnum,
      index: number | BrandedType<number, "enum"> | BrandedType<number, Enum>,
  ): EnumNameForClass<TEnum>

  Type Parameters

  • TEnum extends typeof Enum

  Parameters

  • this: TEnum
  • index: number | BrandedType<number, "enum"> | BrandedType<number, Enum>

  Returns EnumNameForClass<TEnum>

  Obsolete

  Compatibility

StaticgetEnumNames

• getEnumNames(): string[]

  Returns string[]

  Obsolete

  Compatibility

StaticgetEnumValue

• getEnumValue(index: number): number

  Parameters

  • index: number

  Returns number

  Obsolete

  Compatibility

StaticgetEnumValues

• getEnumValues(): number[]

  Returns number[]

  Obsolete

  Compatibility

StaticgetNameForValue

• getNameForValue<TEnum extends typeof Enum>(
      this: TEnum,
      enumValue: number | BrandedType<number, "enum"> | BrandedType<number, Enum>,
  ): EnumNameForClass<TEnum>

  Gets the name for the enumeration value that matches the specified enumValue.

  Type Parameters

  • TEnum extends typeof Enum

  Parameters

  • this: TEnum
  • enumValue: number | BrandedType<number, "enum"> | BrandedType<number, Enum>

    The enumeration value.

  Returns EnumNameForClass<TEnum>

  The enumeration value or undefined if not found.

StaticgetNames

• getNames<TEnum extends typeof Enum>(this: TEnum): EnumNameForClass<TEnum>[]

  Gets the enumeration names

  Type Parameters

  • TEnum extends typeof Enum

  Parameters

  • this: TEnum

  Returns EnumNameForClass<TEnum>[]

  The enumeration names.

StaticgetValueAtIndex

• getValueAtIndex<TEnum extends typeof Enum>(
      this: TEnum,
      index: number,
  ): EnumValueTyped<TEnum["prototype"], number>

  Gets the enumeration value at the specified index.

  Type Parameters

  • TEnum extends typeof Enum

  Parameters

  • this: TEnum
  • index: number

    The index.

  Returns EnumValueTyped<TEnum["prototype"], number>

  The enumeration value or undefined if not found.

StaticgetValues

• getValues<TEnum extends typeof Enum>(
      this: TEnum,
  ): EnumValueTyped<TEnum["prototype"], number>[]

  Gets the enumeration values

  Type Parameters

  • TEnum extends typeof Enum

  Parameters

  • this: TEnum

  Returns EnumValueTyped<TEnum["prototype"], number>[]

  The enumeration values.

StatichasFlag

• hasFlag<
      T,
      K =
          | number
          | BrandedType<number, "enum">
          | BrandedType<number, EnumPrototype<T>>,
  >(
      value: K,
      bits: EnumValueTyped<T>,
  ): boolean

  Determines if the enum value has the flags set.

  Type Parameters

  • T
  • K = number | BrandedType<number, "enum"> | BrandedType<number, EnumPrototype<T>>

  Parameters

  • value: K
  • bits: EnumValueTyped<T>

  Returns boolean

StatichasFlagChanged

• hasFlagChanged<
      T,
      K =
          | number
          | BrandedType<number, "enum">
          | BrandedType<number, EnumPrototype<T>>,
  >(
      previousValue: K,
      newValue: K,
      bits: EnumValueTyped<T>,
  ): boolean

  Determines if the enum bits were changed from previousValue to currentValue.

  Type Parameters

  • T
  • K = number | BrandedType<number, "enum"> | BrandedType<number, EnumPrototype<T>>

  Parameters

  • previousValue: K
  • newValue: K
  • bits: EnumValueTyped<T>

  Returns boolean

StaticiterateNames

• iterateNames<TEnum extends typeof Enum>(
      this: TEnum,
  ): Generator<EnumNameForClass<TEnum>>

  Iterates the enumeration names

  Type Parameters

  • TEnum extends typeof Enum

  Parameters

  • this: TEnum

  Returns Generator<EnumNameForClass<TEnum>>

  The enumeration names.

StaticiterateValues

• iterateValues<TEnum extends typeof Enum>(
      this: TEnum,
  ): Generator<EnumValueTyped<TEnum["prototype"], number>>

  Iterates the enumeration values

  Type Parameters

  • TEnum extends typeof Enum

  Parameters

  • this: TEnum

  Returns Generator<EnumValueTyped<TEnum["prototype"], number>>

  The enumeration values.

StaticremoveFlag

• removeFlag<
      T,
      K =
          | number
          | BrandedType<number, "enum">
          | BrandedType<number, EnumPrototype<T>>,
  >(
      value: K,
      bits: EnumValueTyped<T>,
  ): K

  Removes the flag bits from the enum value.

  Type Parameters

  • T
  • K = number | BrandedType<number, "enum"> | BrandedType<number, EnumPrototype<T>>

  Parameters

  • value: K
  • bits: EnumValueTyped<T>

  Returns K

StaticsplitFlags

• splitFlags<TEnum extends typeof Enum>(
      this: TEnum,
      value: EnumValueTyped<TEnum["prototype"]>,
  ): EnumValueTyped<TEnum["prototype"], number>[]

  Takes a single enum value and splits it into separated flag values set on the value. This assumes that the target enum is a flag enum that can have their values combined using bitwise operators.

  Type Parameters

  • TEnum extends typeof Enum

  Parameters

  • this: TEnum
  • value: EnumValueTyped<TEnum["prototype"]>

    The enum value to have it's value split using bitwise-and operator.

  Returns EnumValueTyped<TEnum["prototype"], number>[]

  An array of each "bit flag" set in the enum.