isaacscript-common 85.1.0 → 86.0.0

package/dist/features.js

@@ -61,7 +61,7 @@ const UnlockAchievementsDetection_1 = require("./classes/features/other/UnlockAc
 const ISCFeature_1 = require("./enums/ISCFeature");
 const ModCallbackCustom_1 = require("./enums/ModCallbackCustom");
 const enums_1 = require("./functions/enums");
-(0, enums_1.validateInterfaceMatchesEnum)();
+(0, enums_1.interfaceSatisfiesEnum)();
 // eslint-disable-next-line @typescript-eslint/explicit-module-boundary-types
 function getFeatures(mod, callbacks) {
     // Some features rely on other features; we must initialize those first.

package/dist/features.lua

@@ -120,8 +120,8 @@ local ISCFeature = ____ISCFeature.ISCFeature
 local ____ModCallbackCustom = require("enums.ModCallbackCustom")
 local ModCallbackCustom = ____ModCallbackCustom.ModCallbackCustom
 local ____enums = require("functions.enums")
-local validateInterfaceMatchesEnum = ____enums.validateInterfaceMatchesEnum
-validateInterfaceMatchesEnum(nil)
+local interfaceSatisfiesEnum = ____enums.interfaceSatisfiesEnum
+interfaceSatisfiesEnum(nil)
 function ____exports.getFeatures(self, mod, callbacks)
     local gameReorderedCallbacks = __TS__New(
         GameReorderedCallbacks,

package/dist/functions/enums.d.ts

@@ -113,30 +113,6 @@ export declare function getLowestEnumValue<T extends TranspiledEnum>(transpiledE
  * @param exceptions Optional. An array of elements to skip over if selected.
  */
 export declare function getRandomEnumValue<T extends TranspiledEnum>(transpiledEnum: T, seedOrRNG: Seed | RNG | undefined, exceptions?: ReadonlyArray<T[keyof T]>): T[keyof T];
-/** Helper function to validate that a particular value exists inside of an enum. */
-export declare function isEnumValue<T extends TranspiledEnum>(value: number | string | BitFlag | BitFlag128, transpiledEnum: T): value is T[keyof T];
-/**
- * Helper function to check every value of a custom enum for -1. Will throw an run-time error if any
- * -1 values are found. This is helpful because many methods of the Isaac class return -1 if they
- * fail.
- *
- * For example:
- *
- * ```ts
- * enum EntityTypeCustom {
- *   FOO = Isaac.GetEntityTypeByName("Foo"),
- * }
- *
- * validateCustomEnum("EntityTypeCustom", EntityTypeCustom);
- * ```
- */
-export declare function validateCustomEnum(transpiledEnumName: string, transpiledEnum: TranspiledEnum): void;
-/**
- * Helper function to validate if every value in a number enum is contiguous, starting at 0.
- *
- * This is useful to automate checking large enums for typos.
- */
-export declare function validateEnumContiguous<T extends TranspiledEnum>(transpiledEnumName: string, transpiledEnum: T): void;
 /**
  * Helper function to validate that an interface contains all of the keys of an enum. You must
  * specify both generic parameters in order for this to work properly (i.e. the interface and then
@@ -157,12 +133,36 @@ export declare function validateEnumContiguous<T extends TranspiledEnum>(transpi
  *   [MyEnum.Value3]: string;
  * }
  *
- * validateInterfaceMatchesEnum<MyEnumToType, MyEnum>();
+ * interfaceSatisfiesEnum<MyEnumToType, MyEnum>();
  * ```
  *
  * This function is only meant to be used with interfaces (i.e. types that will not exist at
  * run-time). If you are generating an object that will contain all of the keys of an enum, use the
  * `satisfies` operator with the `Record` type instead.
  */
-export declare function validateInterfaceMatchesEnum<T extends Record<Enum, unknown>, Enum extends string | number>(): void;
+export declare function interfaceSatisfiesEnum<T extends Record<Enum, unknown>, Enum extends string | number>(): void;
+/** Helper function to validate that a particular value exists inside of an enum. */
+export declare function isEnumValue<T extends TranspiledEnum>(value: number | string | BitFlag | BitFlag128, transpiledEnum: T): value is T[keyof T];
+/**
+ * Helper function to check every value of a custom enum for -1. Will throw an run-time error if any
+ * -1 values are found. This is helpful because many methods of the Isaac class return -1 if they
+ * fail.
+ *
+ * For example:
+ *
+ * ```ts
+ * enum EntityTypeCustom {
+ *   FOO = Isaac.GetEntityTypeByName("Foo"),
+ * }
+ *
+ * validateCustomEnum("EntityTypeCustom", EntityTypeCustom);
+ * ```
+ */
+export declare function validateCustomEnum(transpiledEnumName: string, transpiledEnum: TranspiledEnum): void;
+/**
+ * Helper function to validate if every value in a number enum is contiguous, starting at 0.
+ *
+ * This is useful to automate checking large enums for typos.
+ */
+export declare function validateEnumContiguous<T extends TranspiledEnum>(transpiledEnumName: string, transpiledEnum: T): void;
 //# sourceMappingURL=enums.d.ts.map

package/dist/functions/enums.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"enums.d.ts","sourceRoot":"","sources":["../../src/functions/enums.ts"],"names":[],"mappings":";;;;;AAMA;;;GAGG;AACH,MAAM,MAAM,cAAc,GAAG,MAAM,CACjC,MAAM,EACN,MAAM,GAAG,MAAM,GAAG,OAAO,GAAG,UAAU,CACvC,CAAC;AAEF;;;;;;;;;;;;;;;;;GAiBG;AACH,wBAAgB,cAAc,CAAC,CAAC,SAAS,cAAc,EACrD,cAAc,EAAE,CAAC,GAChB,aAAa,CAAC,CAAC,GAAG,EAAE,MAAM,EAAE,KAAK,EAAE,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC,CAiBjD;AAED;;;;;;;;;;;;;;;;GAgBG;AACH,wBAAgB,WAAW,CAAC,cAAc,EAAE,cAAc,GAAG,SAAS,MAAM,EAAE,CAG7E;AAED,sEAAsE;AACtE,wBAAgB,aAAa,CAAC,cAAc,EAAE,cAAc,GAAG,GAAG,CAGjE;AAED;;;;;;;;;;;;;;;;GAgBG;AACH,wBAAgB,YAAY,CAC1B,cAAc,EAAE,cAAc,GAC7B,SAAS,MAAM,EAAE,CAanB;AAED;;;;;;;;;;;;;;;;GAgBG;AACH,wBAAgB,aAAa,CAAC,CAAC,SAAS,cAAc,EACpD,cAAc,EAAE,CAAC,GAChB,aAAa,CAAC,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC,CAG3B;AAED;;;;;;;GAOG;AACH,wBAAgB,mBAAmB,CAAC,CAAC,SAAS,cAAc,EAC1D,cAAc,EAAE,CAAC,GAChB,CAAC,CAAC,MAAM,CAAC,CAAC,CAUZ;AAED;;;;;;;GAOG;AACH,wBAAgB,kBAAkB,CAAC,CAAC,SAAS,cAAc,EACzD,cAAc,EAAE,CAAC,GAChB,CAAC,CAAC,MAAM,CAAC,CAAC,CAUZ;AAED;;;;;;;;;;GAUG;AACH,wBAAgB,kBAAkB,CAAC,CAAC,SAAS,cAAc,EACzD,cAAc,EAAE,CAAC,EACjB,SAAS,EAAE,IAAI,GAAG,GAAG,GAAG,SAAS,EACjC,UAAU,GAAE,aAAa,CAAC,CAAC,CAAC,MAAM,CAAC,CAAC,CAAM,GACzC,CAAC,CAAC,MAAM,CAAC,CAAC,CAGZ;AAED,oFAAoF;AACpF,wBAAgB,WAAW,CAAC,CAAC,SAAS,cAAc,EAClD,KAAK,EAAE,MAAM,GAAG,MAAM,GAAG,OAAO,GAAG,UAAU,EAC7C,cAAc,EAAE,CAAC,GAChB,KAAK,IAAI,CAAC,CAAC,MAAM,CAAC,CAAC,CAGrB;AAED;;;;;;;;;;;;;;GAcG;AACH,wBAAgB,kBAAkB,CAChC,kBAAkB,EAAE,MAAM,EAC1B,cAAc,EAAE,cAAc,GAC7B,IAAI,CAQN;AAED;;;;GAIG;AACH,wBAAgB,sBAAsB,CAAC,CAAC,SAAS,cAAc,EAC7D,kBAAkB,EAAE,MAAM,EAC1B,cAAc,EAAE,CAAC,GAChB,IAAI,CAsBN;AAED;;;;;;;;;;;;;;;;;;;;;;;;;;GA0BG;AACH,wBAAgB,4BAA4B,CAE1C,CAAC,SAAS,MAAM,CAAC,IAAI,EAAE,OAAO,CAAC,EAC/B,IAAI,SAAS,MAAM,GAAG,MAAM,KACzB,IAAI,CAAG"}
+{"version":3,"file":"enums.d.ts","sourceRoot":"","sources":["../../src/functions/enums.ts"],"names":[],"mappings":";;;;;AAMA;;;GAGG;AACH,MAAM,MAAM,cAAc,GAAG,MAAM,CACjC,MAAM,EACN,MAAM,GAAG,MAAM,GAAG,OAAO,GAAG,UAAU,CACvC,CAAC;AAEF;;;;;;;;;;;;;;;;;GAiBG;AACH,wBAAgB,cAAc,CAAC,CAAC,SAAS,cAAc,EACrD,cAAc,EAAE,CAAC,GAChB,aAAa,CAAC,CAAC,GAAG,EAAE,MAAM,EAAE,KAAK,EAAE,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC,CAiBjD;AAED;;;;;;;;;;;;;;;;GAgBG;AACH,wBAAgB,WAAW,CAAC,cAAc,EAAE,cAAc,GAAG,SAAS,MAAM,EAAE,CAG7E;AAED,sEAAsE;AACtE,wBAAgB,aAAa,CAAC,cAAc,EAAE,cAAc,GAAG,GAAG,CAGjE;AAED;;;;;;;;;;;;;;;;GAgBG;AACH,wBAAgB,YAAY,CAC1B,cAAc,EAAE,cAAc,GAC7B,SAAS,MAAM,EAAE,CAanB;AAED;;;;;;;;;;;;;;;;GAgBG;AACH,wBAAgB,aAAa,CAAC,CAAC,SAAS,cAAc,EACpD,cAAc,EAAE,CAAC,GAChB,aAAa,CAAC,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC,CAG3B;AAED;;;;;;;GAOG;AACH,wBAAgB,mBAAmB,CAAC,CAAC,SAAS,cAAc,EAC1D,cAAc,EAAE,CAAC,GAChB,CAAC,CAAC,MAAM,CAAC,CAAC,CAUZ;AAED;;;;;;;GAOG;AACH,wBAAgB,kBAAkB,CAAC,CAAC,SAAS,cAAc,EACzD,cAAc,EAAE,CAAC,GAChB,CAAC,CAAC,MAAM,CAAC,CAAC,CAUZ;AAED;;;;;;;;;;GAUG;AACH,wBAAgB,kBAAkB,CAAC,CAAC,SAAS,cAAc,EACzD,cAAc,EAAE,CAAC,EACjB,SAAS,EAAE,IAAI,GAAG,GAAG,GAAG,SAAS,EACjC,UAAU,GAAE,aAAa,CAAC,CAAC,CAAC,MAAM,CAAC,CAAC,CAAM,GACzC,CAAC,CAAC,MAAM,CAAC,CAAC,CAGZ;AAED;;;;;;;;;;;;;;;;;;;;;;;;;;GA0BG;AACH,wBAAgB,sBAAsB,CAEpC,CAAC,SAAS,MAAM,CAAC,IAAI,EAAE,OAAO,CAAC,EAC/B,IAAI,SAAS,MAAM,GAAG,MAAM,KACzB,IAAI,CAAG;AAEZ,oFAAoF;AACpF,wBAAgB,WAAW,CAAC,CAAC,SAAS,cAAc,EAClD,KAAK,EAAE,MAAM,GAAG,MAAM,GAAG,OAAO,GAAG,UAAU,EAC7C,cAAc,EAAE,CAAC,GAChB,KAAK,IAAI,CAAC,CAAC,MAAM,CAAC,CAAC,CAGrB;AAED;;;;;;;;;;;;;;GAcG;AACH,wBAAgB,kBAAkB,CAChC,kBAAkB,EAAE,MAAM,EAC1B,cAAc,EAAE,cAAc,GAC7B,IAAI,CAQN;AAED;;;;GAIG;AACH,wBAAgB,sBAAsB,CAAC,CAAC,SAAS,cAAc,EAC7D,kBAAkB,EAAE,MAAM,EAC1B,cAAc,EAAE,CAAC,GAChB,IAAI,CAsBN"}

package/dist/functions/enums.js

@@ -1,6 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.validateInterfaceMatchesEnum = exports.validateEnumContiguous = exports.validateCustomEnum = exports.isEnumValue = exports.getRandomEnumValue = exports.getLowestEnumValue = exports.getHighestEnumValue = exports.getEnumValues = exports.getEnumNames = exports.getEnumLength = exports.getEnumKeys = exports.getEnumEntries = void 0;
+exports.validateEnumContiguous = exports.validateCustomEnum = exports.isEnumValue = exports.interfaceSatisfiesEnum = exports.getRandomEnumValue = exports.getLowestEnumValue = exports.getHighestEnumValue = exports.getEnumValues = exports.getEnumNames = exports.getEnumLength = exports.getEnumKeys = exports.getEnumEntries = void 0;
 const ReadonlySet_1 = require("../types/ReadonlySet");
 const array_1 = require("./array");
 const sort_1 = require("./sort");
@@ -162,6 +162,35 @@ function getRandomEnumValue(transpiledEnum, seedOrRNG, exceptions = []) {
     return (0, array_1.getRandomArrayElement)(enumValues, seedOrRNG, exceptions);
 }
 exports.getRandomEnumValue = getRandomEnumValue;
+/**
+ * Helper function to validate that an interface contains all of the keys of an enum. You must
+ * specify both generic parameters in order for this to work properly (i.e. the interface and then
+ * the enum).
+ *
+ * For example:
+ *
+ * ```ts
+ * enum MyEnum {
+ *   Value1,
+ *   Value2,
+ *   Value3,
+ * }
+ *
+ * interface MyEnumToType {
+ *   [MyEnum.Value1]: boolean;
+ *   [MyEnum.Value2]: number;
+ *   [MyEnum.Value3]: string;
+ * }
+ *
+ * interfaceSatisfiesEnum<MyEnumToType, MyEnum>();
+ * ```
+ *
+ * This function is only meant to be used with interfaces (i.e. types that will not exist at
+ * run-time). If you are generating an object that will contain all of the keys of an enum, use the
+ * `satisfies` operator with the `Record` type instead.
+ */
+function interfaceSatisfiesEnum() { } // eslint-disable-line @typescript-eslint/no-empty-function
+exports.interfaceSatisfiesEnum = interfaceSatisfiesEnum;
 /** Helper function to validate that a particular value exists inside of an enum. */
 function isEnumValue(value, transpiledEnum) {
     const enumValues = getEnumValues(transpiledEnum);
@@ -211,32 +240,3 @@ function validateEnumContiguous(transpiledEnumName, transpiledEnum) {
     }
 }
 exports.validateEnumContiguous = validateEnumContiguous;
-/**
- * Helper function to validate that an interface contains all of the keys of an enum. You must
- * specify both generic parameters in order for this to work properly (i.e. the interface and then
- * the enum).
- *
- * For example:
- *
- * ```ts
- * enum MyEnum {
- *   Value1,
- *   Value2,
- *   Value3,
- * }
- *
- * interface MyEnumToType {
- *   [MyEnum.Value1]: boolean;
- *   [MyEnum.Value2]: number;
- *   [MyEnum.Value3]: string;
- * }
- *
- * validateInterfaceMatchesEnum<MyEnumToType, MyEnum>();
- * ```
- *
- * This function is only meant to be used with interfaces (i.e. types that will not exist at
- * run-time). If you are generating an object that will contain all of the keys of an enum, use the
- * `satisfies` operator with the `Record` type instead.
- */
-function validateInterfaceMatchesEnum() { } // eslint-disable-line @typescript-eslint/no-empty-function
-exports.validateInterfaceMatchesEnum = validateInterfaceMatchesEnum;

package/dist/functions/enums.lua

@@ -188,6 +188,33 @@ function ____exports.getRandomEnumValue(self, transpiledEnum, seedOrRNG, excepti
     local enumValues = ____exports.getEnumValues(nil, transpiledEnum)
     return getRandomArrayElement(nil, enumValues, seedOrRNG, exceptions)
 end
+--- Helper function to validate that an interface contains all of the keys of an enum. You must
+-- specify both generic parameters in order for this to work properly (i.e. the interface and then
+-- the enum).
+-- 
+-- For example:
+-- 
+-- ```ts
+-- enum MyEnum {
+--   Value1,
+--   Value2,
+--   Value3,
+-- }
+-- 
+-- interface MyEnumToType {
+--   [MyEnum.Value1]: boolean;
+--   [MyEnum.Value2]: number;
+--   [MyEnum.Value3]: string;
+-- }
+-- 
+-- interfaceSatisfiesEnum<MyEnumToType, MyEnum>();
+-- ```
+-- 
+-- This function is only meant to be used with interfaces (i.e. types that will not exist at
+-- run-time). If you are generating an object that will contain all of the keys of an enum, use the
+-- `satisfies` operator with the `Record` type instead.
+function ____exports.interfaceSatisfiesEnum(self)
+end
 --- Helper function to validate that a particular value exists inside of an enum.
 function ____exports.isEnumValue(self, value, transpiledEnum)
     local enumValues = ____exports.getEnumValues(nil, transpiledEnum)
@@ -232,31 +259,4 @@ function ____exports.validateEnumContiguous(self, transpiledEnumName, transpiled
         end
     end
 end
---- Helper function to validate that an interface contains all of the keys of an enum. You must
--- specify both generic parameters in order for this to work properly (i.e. the interface and then
--- the enum).
--- 
--- For example:
--- 
--- ```ts
--- enum MyEnum {
---   Value1,
---   Value2,
---   Value3,
--- }
--- 
--- interface MyEnumToType {
---   [MyEnum.Value1]: boolean;
---   [MyEnum.Value2]: number;
---   [MyEnum.Value3]: string;
--- }
--- 
--- validateInterfaceMatchesEnum<MyEnumToType, MyEnum>();
--- ```
--- 
--- This function is only meant to be used with interfaces (i.e. types that will not exist at
--- run-time). If you are generating an object that will contain all of the keys of an enum, use the
--- `satisfies` operator with the `Record` type instead.
-function ____exports.validateInterfaceMatchesEnum(self)
-end
 return ____exports

package/dist/index.rollup.d.ts

@@ -8870,6 +8870,35 @@ export declare function inSecretShop(): boolean;
  */
 export declare function inStartingRoom(): boolean;
 
+/**
+ * Helper function to validate that an interface contains all of the keys of an enum. You must
+ * specify both generic parameters in order for this to work properly (i.e. the interface and then
+ * the enum).
+ *
+ * For example:
+ *
+ * ```ts
+ * enum MyEnum {
+ *   Value1,
+ *   Value2,
+ *   Value3,
+ * }
+ *
+ * interface MyEnumToType {
+ *   [MyEnum.Value1]: boolean;
+ *   [MyEnum.Value2]: number;
+ *   [MyEnum.Value3]: string;
+ * }
+ *
+ * interfaceSatisfiesEnum<MyEnumToType, MyEnum>();
+ * ```
+ *
+ * This function is only meant to be used with interfaces (i.e. types that will not exist at
+ * run-time). If you are generating an object that will contain all of the keys of an enum, use the
+ * `satisfies` operator with the `Record` type instead.
+ */
+export declare function interfaceSatisfiesEnum<T extends Record<Enum, unknown>, Enum extends string | number>(): void;
+
 /**
  * Helper type to get a range of integers. It is inclusive on both ends. (The "I" in the type name
  * stands for inclusive.)
@@ -19226,35 +19255,6 @@ export declare function validateCustomEnum(transpiledEnumName: string, transpile
  */
 export declare function validateEnumContiguous<T extends TranspiledEnum>(transpiledEnumName: string, transpiledEnum: T): void;
 
-/**
- * Helper function to validate that an interface contains all of the keys of an enum. You must
- * specify both generic parameters in order for this to work properly (i.e. the interface and then
- * the enum).
- *
- * For example:
- *
- * ```ts
- * enum MyEnum {
- *   Value1,
- *   Value2,
- *   Value3,
- * }
- *
- * interface MyEnumToType {
- *   [MyEnum.Value1]: boolean;
- *   [MyEnum.Value2]: number;
- *   [MyEnum.Value3]: string;
- * }
- *
- * validateInterfaceMatchesEnum<MyEnumToType, MyEnum>();
- * ```
- *
- * This function is only meant to be used with interfaces (i.e. types that will not exist at
- * run-time). If you are generating an object that will contain all of the keys of an enum, use the
- * `satisfies` operator with the `Record` type instead.
- */
-export declare function validateInterfaceMatchesEnum<T extends Record<Enum, unknown>, Enum extends string | number>(): void;
-
 /**
  * An array that represents the range from the first vanilla card type to the last vanilla card
  * type.

package/dist/interfaces/PlayerStats.js

@@ -1,4 +1,4 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 const enums_1 = require("../functions/enums");
-(0, enums_1.validateInterfaceMatchesEnum)();
+(0, enums_1.interfaceSatisfiesEnum)();

package/dist/interfaces/PlayerStats.lua

@@ -1,5 +1,5 @@
 local ____exports = {}
 local ____enums = require("functions.enums")
-local validateInterfaceMatchesEnum = ____enums.validateInterfaceMatchesEnum
-validateInterfaceMatchesEnum(nil)
+local interfaceSatisfiesEnum = ____enums.interfaceSatisfiesEnum
+interfaceSatisfiesEnum(nil)
 return ____exports

package/dist/interfaces/private/AddCallbackParametersCustom.js

@@ -1,4 +1,4 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 const enums_1 = require("../../functions/enums");
-(0, enums_1.validateInterfaceMatchesEnum)();
+(0, enums_1.interfaceSatisfiesEnum)();

package/dist/interfaces/private/AddCallbackParametersCustom.lua

@@ -1,5 +1,5 @@
 local ____exports = {}
 local ____enums = require("functions.enums")
-local validateInterfaceMatchesEnum = ____enums.validateInterfaceMatchesEnum
-validateInterfaceMatchesEnum(nil)
+local interfaceSatisfiesEnum = ____enums.interfaceSatisfiesEnum
+interfaceSatisfiesEnum(nil)
 return ____exports

package/dist/isaacscript-common.lua

@@ -1,6 +1,6 @@
 --[[
 
-isaacscript-common 85.0.2
+isaacscript-common 85.1.0
 
 This is the "isaacscript-common" library, which was created with the IsaacScript tool.
 
@@ -19251,6 +19251,33 @@ function ____exports.getRandomEnumValue(self, transpiledEnum, seedOrRNG, excepti
     local enumValues = ____exports.getEnumValues(nil, transpiledEnum)
     return getRandomArrayElement(nil, enumValues, seedOrRNG, exceptions)
 end
+--- Helper function to validate that an interface contains all of the keys of an enum. You must
+-- specify both generic parameters in order for this to work properly (i.e. the interface and then
+-- the enum).
+-- 
+-- For example:
+-- 
+-- ```ts
+-- enum MyEnum {
+--   Value1,
+--   Value2,
+--   Value3,
+-- }
+-- 
+-- interface MyEnumToType {
+--   [MyEnum.Value1]: boolean;
+--   [MyEnum.Value2]: number;
+--   [MyEnum.Value3]: string;
+-- }
+-- 
+-- interfaceSatisfiesEnum<MyEnumToType, MyEnum>();
+-- ```
+-- 
+-- This function is only meant to be used with interfaces (i.e. types that will not exist at
+-- run-time). If you are generating an object that will contain all of the keys of an enum, use the
+-- `satisfies` operator with the `Record` type instead.
+function ____exports.interfaceSatisfiesEnum(self)
+end
 --- Helper function to validate that a particular value exists inside of an enum.
 function ____exports.isEnumValue(self, value, transpiledEnum)
     local enumValues = ____exports.getEnumValues(nil, transpiledEnum)
@@ -19295,33 +19322,6 @@ function ____exports.validateEnumContiguous(self, transpiledEnumName, transpiled
         end
     end
 end
---- Helper function to validate that an interface contains all of the keys of an enum. You must
--- specify both generic parameters in order for this to work properly (i.e. the interface and then
--- the enum).
--- 
--- For example:
--- 
--- ```ts
--- enum MyEnum {
---   Value1,
---   Value2,
---   Value3,
--- }
--- 
--- interface MyEnumToType {
---   [MyEnum.Value1]: boolean;
---   [MyEnum.Value2]: number;
---   [MyEnum.Value3]: string;
--- }
--- 
--- validateInterfaceMatchesEnum<MyEnumToType, MyEnum>();
--- ```
--- 
--- This function is only meant to be used with interfaces (i.e. types that will not exist at
--- run-time). If you are generating an object that will contain all of the keys of an enum, use the
--- `satisfies` operator with the `Record` type instead.
-function ____exports.validateInterfaceMatchesEnum(self)
-end
 return ____exports
  end,
 ["cachedEnumValues"] = function(...) 
@@ -19596,15 +19596,15 @@ return ____exports
 ["interfaces.PlayerStats"] = function(...) 
 local ____exports = {}
 local ____enums = require("functions.enums")
-local validateInterfaceMatchesEnum = ____enums.validateInterfaceMatchesEnum
-validateInterfaceMatchesEnum(nil)
+local interfaceSatisfiesEnum = ____enums.interfaceSatisfiesEnum
+interfaceSatisfiesEnum(nil)
 return ____exports
  end,
 ["interfaces.private.AddCallbackParametersCustom"] = function(...) 
 local ____exports = {}
 local ____enums = require("functions.enums")
-local validateInterfaceMatchesEnum = ____enums.validateInterfaceMatchesEnum
-validateInterfaceMatchesEnum(nil)
+local interfaceSatisfiesEnum = ____enums.interfaceSatisfiesEnum
+interfaceSatisfiesEnum(nil)
 return ____exports
  end,
 ["types.AllButFirst"] = function(...) 
@@ -63616,8 +63616,8 @@ local ISCFeature = ____ISCFeature.ISCFeature
 local ____ModCallbackCustom = require("enums.ModCallbackCustom")
 local ModCallbackCustom = ____ModCallbackCustom.ModCallbackCustom
 local ____enums = require("functions.enums")
-local validateInterfaceMatchesEnum = ____enums.validateInterfaceMatchesEnum
-validateInterfaceMatchesEnum(nil)
+local interfaceSatisfiesEnum = ____enums.interfaceSatisfiesEnum
+interfaceSatisfiesEnum(nil)
 function ____exports.getFeatures(self, mod, callbacks)
     local gameReorderedCallbacks = __TS__New(
         GameReorderedCallbacks,

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "isaacscript-common",
-  "version": "85.1.0",
+  "version": "86.0.0",
   "description": "Helper functions and features for IsaacScript mods.",
   "keywords": [
     "isaac",

package/src/features.ts

@@ -59,7 +59,7 @@ import { UnlockAchievementsDetection } from "./classes/features/other/UnlockAchi
 import type { Feature } from "./classes/private/Feature";
 import { ISCFeature } from "./enums/ISCFeature";
 import { ModCallbackCustom } from "./enums/ModCallbackCustom";
-import { validateInterfaceMatchesEnum } from "./functions/enums";
+import { interfaceSatisfiesEnum } from "./functions/enums";
 import type { ModUpgradedInterface } from "./interfaces/private/ModUpgradedInterface";
 
 export interface ISCFeatureToClass {
@@ -125,7 +125,7 @@ export interface ISCFeatureToClass {
   [ISCFeature.UNLOCK_ACHIEVEMENTS_DETECTION]: UnlockAchievementsDetection;
 }
 
-validateInterfaceMatchesEnum<ISCFeatureToClass, ISCFeature>();
+interfaceSatisfiesEnum<ISCFeatureToClass, ISCFeature>();
 
 // eslint-disable-next-line @typescript-eslint/explicit-module-boundary-types
 export function getFeatures(

package/src/functions/enums.ts

@@ -202,6 +202,39 @@ export function getRandomEnumValue<T extends TranspiledEnum>(
   return getRandomArrayElement(enumValues, seedOrRNG, exceptions);
 }
 
+/**
+ * Helper function to validate that an interface contains all of the keys of an enum. You must
+ * specify both generic parameters in order for this to work properly (i.e. the interface and then
+ * the enum).
+ *
+ * For example:
+ *
+ * ```ts
+ * enum MyEnum {
+ *   Value1,
+ *   Value2,
+ *   Value3,
+ * }
+ *
+ * interface MyEnumToType {
+ *   [MyEnum.Value1]: boolean;
+ *   [MyEnum.Value2]: number;
+ *   [MyEnum.Value3]: string;
+ * }
+ *
+ * interfaceSatisfiesEnum<MyEnumToType, MyEnum>();
+ * ```
+ *
+ * This function is only meant to be used with interfaces (i.e. types that will not exist at
+ * run-time). If you are generating an object that will contain all of the keys of an enum, use the
+ * `satisfies` operator with the `Record` type instead.
+ */
+export function interfaceSatisfiesEnum<
+  // eslint-disable-next-line @typescript-eslint/no-unused-vars
+  T extends Record<Enum, unknown>,
+  Enum extends string | number,
+>(): void {} // eslint-disable-line @typescript-eslint/no-empty-function
+
 /** Helper function to validate that a particular value exists inside of an enum. */
 export function isEnumValue<T extends TranspiledEnum>(
   value: number | string | BitFlag | BitFlag128,
@@ -270,36 +303,3 @@ export function validateEnumContiguous<T extends TranspiledEnum>(
     }
   }
 }
-
-/**
- * Helper function to validate that an interface contains all of the keys of an enum. You must
- * specify both generic parameters in order for this to work properly (i.e. the interface and then
- * the enum).
- *
- * For example:
- *
- * ```ts
- * enum MyEnum {
- *   Value1,
- *   Value2,
- *   Value3,
- * }
- *
- * interface MyEnumToType {
- *   [MyEnum.Value1]: boolean;
- *   [MyEnum.Value2]: number;
- *   [MyEnum.Value3]: string;
- * }
- *
- * validateInterfaceMatchesEnum<MyEnumToType, MyEnum>();
- * ```
- *
- * This function is only meant to be used with interfaces (i.e. types that will not exist at
- * run-time). If you are generating an object that will contain all of the keys of an enum, use the
- * `satisfies` operator with the `Record` type instead.
- */
-export function validateInterfaceMatchesEnum<
-  // eslint-disable-next-line @typescript-eslint/no-unused-vars
-  T extends Record<Enum, unknown>,
-  Enum extends string | number,
->(): void {} // eslint-disable-line @typescript-eslint/no-empty-function

package/src/interfaces/PlayerStats.ts

@@ -1,6 +1,6 @@
 import type { TearFlag } from "isaac-typescript-definitions";
 import type { PlayerStat } from "../enums/PlayerStat";
-import { validateInterfaceMatchesEnum } from "../functions/enums";
+import { interfaceSatisfiesEnum } from "../functions/enums";
 
 /**
  * Contains every player stat along with its corresponding data type. For example, `StatType.DAMAGE`
@@ -22,4 +22,4 @@ export interface PlayerStats {
   [PlayerStat.SIZE]: Vector;
 }
 
-validateInterfaceMatchesEnum<PlayerStats, PlayerStat>();
+interfaceSatisfiesEnum<PlayerStats, PlayerStat>();

package/src/interfaces/private/AddCallbackParametersCustom.ts

@@ -39,7 +39,7 @@ import type { HealthType } from "../../enums/HealthType";
 import type { ModCallbackCustom } from "../../enums/ModCallbackCustom";
 import type { PlayerStat } from "../../enums/PlayerStat";
 import type { SlotDestructionType } from "../../enums/SlotDestructionType";
-import { validateInterfaceMatchesEnum } from "../../functions/enums";
+import { interfaceSatisfiesEnum } from "../../functions/enums";
 import type {
   PickingUpItem,
   PickingUpItemCollectible,
@@ -1059,4 +1059,4 @@ export interface AddCallbackParametersCustom {
   ];
 }
 
-validateInterfaceMatchesEnum<AddCallbackParametersCustom, ModCallbackCustom>();
+interfaceSatisfiesEnum<AddCallbackParametersCustom, ModCallbackCustom>();