isaacscript-common 1.2.191 → 1.2.192

package/dist/functions/utils.d.ts

@@ -36,6 +36,21 @@
  * ```
  */
 export declare const ensureAllCases: (obj: never) => never;
+/**
+ * TypeScriptToLua will transpile TypeScript enums to Lua tables that have a double mapping. Thus,
+ * when you iterate over them, you will get both the names of the enums and the values of the enums,
+ * in a random order. If all you need are the keys of an enum, use this helper function.
+ *
+ * This function will return the enum keys in a sorted order, which may not necessarily be the same
+ * order as which they were declared in.
+ *
+ * This function will work properly for both number enums and string enums. (Reverse mappings are
+ * not created for string enums.)
+ *
+ * For a more in depth explanation, see:
+ * https://isaacscript.github.io/docs/gotchas#iterating-over-enums
+ */
+export declare function getEnumKeys<T>(transpiledEnum: T): string[];
 /**
  * TypeScriptToLua will transpile TypeScript enums to Lua tables that have a double mapping. Thus,
  * when you iterate over them, you will get both the names of the enums and the values of the enums,

package/dist/functions/utils.lua

@@ -6,6 +6,16 @@ local __TS__StringSubstr = ____lualib.__TS__StringSubstr
 local ____exports = {}
 local HEX_STRING_LENGTH = 6
 ____exports.ensureAllCases = function(____, obj) return obj end
+function ____exports.getEnumKeys(self, transpiledEnum)
+    local enumKeys = {}
+    for key in pairs(transpiledEnum) do
+        if type(key) == "string" then
+            __TS__ArrayPush(enumKeys, key)
+        end
+    end
+    __TS__ArraySort(enumKeys)
+    return enumKeys
+end
 function ____exports.getEnumValues(self, transpiledEnum)
     local enumValues = {}
     for key, value in pairs(transpiledEnum) do

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "isaacscript-common",
-  "version": "1.2.191",
+  "version": "1.2.192",
   "description": "Helper functions for IsaacScript mods",
   "keywords": [
     "isaac",