PokéRogue
    Preparing search index...
    • Convert an array of enums or const objects into a readable string version.

      Type Parameters

      • E extends EnumOrObject
      • V extends string | number
      • X extends boolean

      Parameters

      • obj: E

        The EnumOrObject to source reverse mappings from

      • values: readonly V[]

        An array of obj's values to convert into strings

      • options: getEnumStrOptions<V, X> = {}

        Optional parameters modifying the stringification process

      Returns string

      The stringified representation of enums.

      enum fakeEnum {
      ONE = 1,
      TWO = 2,
      THREE = 3,
      }
      const vals = [fakeEnum.ONE, fakeEnum.TWO, fakeEnum.THREE] as const;

      console.log(stringifyEnumArray(fakeEnum, vals));
      // Output: "[ONE, TWO, THREE] (=[1, 2, 3])";
      console.log(stringifyEnumArray(fakeEnum, vals, {prefix: "Thing ", suffix: " Yeah", exclude: "values"}));
      // Output: "[Thing ONE Yeah, Thing TWO Yeah, Thing THREE Yeah]";