Options
All
  • Public
  • Public/Protected
  • All
Menu

Namespace EnumObject<T>

Type parameters

  • T

Index

Functions

Functions

get

  • get<E>(enumObject: E): E & { [EnumProperty.ENTRIES]?: ReadonlyArray<[]>; [EnumProperty.EXCLUDED]?: ReadonlySet<keyof T>; [EnumProperty.KEYS]?: ReadonlyArray<keyof T>; [EnumProperty.MOD_START]?: undefined | number; [EnumProperty.NAME]?: undefined | string; [EnumProperty.OFFICIAL_MAX]?: undefined | number; [EnumProperty.VALUES]?: ReadonlyArray<Exclude<T[keyof T], AnyFunction>> }
  • Type parameters

    • E

    Parameters

    • enumObject: E

    Returns E & { [EnumProperty.ENTRIES]?: ReadonlyArray<[]>; [EnumProperty.EXCLUDED]?: ReadonlySet<keyof T>; [EnumProperty.KEYS]?: ReadonlyArray<keyof T>; [EnumProperty.MOD_START]?: undefined | number; [EnumProperty.NAME]?: undefined | string; [EnumProperty.OFFICIAL_MAX]?: undefined | number; [EnumProperty.VALUES]?: ReadonlyArray<Exclude<T[keyof T], AnyFunction>> }

setExcluded

  • setExcluded<E>(enumObject: E, ...keys: Array<keyof E>): void
  • Sets the enum keys that won't be iterated over in the enum.

    Type parameters

    • E

    Parameters

    • enumObject: E
    • Rest ...keys: Array<keyof E>

    Returns void

Generated using TypeDoc