isaacscript-common 79.2.0 → 79.3.0

package/dist/functions/map.d.ts

@@ -54,8 +54,24 @@ export declare function mapSetHash<V>(map: Map<PtrHash, V>, entity: Entity, valu
  *
  * Note that the map values will be inserted in a random order, due to how `pairs` works under the
  * hood.
+ *
+ * Also see the `objectToReadonlyMap` function.
  */
 export declare function objectToMap<K extends string | number | symbol, V>(object: Record<K, V>): Map<K, V>;
+/**
+ * Helper function to convert an object to a read-only map.
+ *
+ * This is useful when you need to construct a type safe object with the `satisfies` operator, but
+ * then later on you need to query it in a way where you expect the return value to be T or
+ * undefined. In this situation, by converting the object to a map, you can avoid unsafe type
+ * assertions.
+ *
+ * Note that the map values will be inserted in a random order, due to how `pairs` works under the
+ * hood.
+ *
+ * Also see the `objectToMap` function.
+ */
+export declare function objectToReadonlyMap<K extends string | number | symbol, V>(object: Record<K, V>): ReadonlyMap<K, V>;
 /** Helper function to sum every value in a map together. */
 export declare function sumMap(map: Map<unknown, number> | ReadonlyMap<unknown, number>): number;
 //# sourceMappingURL=map.d.ts.map

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

@@ -1 +1 @@
-{"version":3,"file":"map.d.ts","sourceRoot":"","sources":["../../src/functions/map.ts"],"names":[],"mappings":";;AAAA,OAAO,KAAK,EAAE,UAAU,EAAE,MAAM,uBAAuB,CAAC;AAGxD,mGAAmG;AACnG,wBAAgB,OAAO,CAAC,CAAC,EAAE,CAAC,EAC1B,MAAM,EAAE,GAAG,CAAC,CAAC,EAAE,CAAC,CAAC,GAAG,WAAW,CAAC,CAAC,EAAE,CAAC,CAAC,GACpC,GAAG,CAAC,CAAC,EAAE,CAAC,CAAC,CAOX;AAED;;;GAGG;AACH,wBAAgB,iBAAiB,CAAC,CAAC,EAAE,CAAC,SAAS,OAAO,EAAE,EACtD,GAAG,EAAE,UAAU,CAAC,OAAO,EAAE,CAAC,EAAE,CAAC,CAAC,EAC9B,MAAM,EAAE,MAAM,EACd,GAAG,SAAS,EAAE,CAAC,GACd,CAAC,CAGH;AAED;;;;;;GAMG;AACH,wBAAgB,iBAAiB,CAAC,CAAC,EACjC,GAAG,EAAE,GAAG,CAAC,OAAO,EAAE,CAAC,CAAC,EACpB,MAAM,EAAE,MAAM,EACd,KAAK,EAAE,CAAC,GACP,IAAI,CAEN;AAED;;;;;;;;;;;;;;;;;;;;GAoBG;AACH,wBAAgB,cAAc,CAAC,CAAC,EAAE,CAAC,EAAE,GAAG,EAAE,GAAG,CAAC,CAAC,EAAE,CAAC,CAAC,GAAG,GAAG,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC;AAChE,wBAAgB,cAAc,CAAC,CAAC,EAAE,CAAC,EAAE,GAAG,EAAE,WAAW,CAAC,CAAC,EAAE,CAAC,CAAC,GAAG,WAAW,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC;AAahF;;;GAGG;AACH,wBAAgB,UAAU,CAAC,CAAC,EAC1B,GAAG,EAAE,GAAG,CAAC,OAAO,EAAE,CAAC,CAAC,EACpB,MAAM,EAAE,MAAM,EACd,KAAK,EAAE,CAAC,GACP,IAAI,CAGN;AAED;;;;;;;;;;GAUG;AACH,wBAAgB,WAAW,CAAC,CAAC,SAAS,MAAM,GAAG,MAAM,GAAG,MAAM,EAAE,CAAC,EAC/D,MAAM,EAAE,MAAM,CAAC,CAAC,EAAE,CAAC,CAAC,GACnB,GAAG,CAAC,CAAC,EAAE,CAAC,CAAC,CAQX;AAED,4DAA4D;AAC5D,wBAAgB,MAAM,CACpB,GAAG,EAAE,GAAG,CAAC,OAAO,EAAE,MAAM,CAAC,GAAG,WAAW,CAAC,OAAO,EAAE,MAAM,CAAC,GACvD,MAAM,CAGR"}
+{"version":3,"file":"map.d.ts","sourceRoot":"","sources":["../../src/functions/map.ts"],"names":[],"mappings":";;AAAA,OAAO,KAAK,EAAE,UAAU,EAAE,MAAM,uBAAuB,CAAC;AAGxD,mGAAmG;AACnG,wBAAgB,OAAO,CAAC,CAAC,EAAE,CAAC,EAC1B,MAAM,EAAE,GAAG,CAAC,CAAC,EAAE,CAAC,CAAC,GAAG,WAAW,CAAC,CAAC,EAAE,CAAC,CAAC,GACpC,GAAG,CAAC,CAAC,EAAE,CAAC,CAAC,CAOX;AAED;;;GAGG;AACH,wBAAgB,iBAAiB,CAAC,CAAC,EAAE,CAAC,SAAS,OAAO,EAAE,EACtD,GAAG,EAAE,UAAU,CAAC,OAAO,EAAE,CAAC,EAAE,CAAC,CAAC,EAC9B,MAAM,EAAE,MAAM,EACd,GAAG,SAAS,EAAE,CAAC,GACd,CAAC,CAGH;AAED;;;;;;GAMG;AACH,wBAAgB,iBAAiB,CAAC,CAAC,EACjC,GAAG,EAAE,GAAG,CAAC,OAAO,EAAE,CAAC,CAAC,EACpB,MAAM,EAAE,MAAM,EACd,KAAK,EAAE,CAAC,GACP,IAAI,CAEN;AAED;;;;;;;;;;;;;;;;;;;;GAoBG;AACH,wBAAgB,cAAc,CAAC,CAAC,EAAE,CAAC,EAAE,GAAG,EAAE,GAAG,CAAC,CAAC,EAAE,CAAC,CAAC,GAAG,GAAG,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC;AAChE,wBAAgB,cAAc,CAAC,CAAC,EAAE,CAAC,EAAE,GAAG,EAAE,WAAW,CAAC,CAAC,EAAE,CAAC,CAAC,GAAG,WAAW,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC;AAahF;;;GAGG;AACH,wBAAgB,UAAU,CAAC,CAAC,EAC1B,GAAG,EAAE,GAAG,CAAC,OAAO,EAAE,CAAC,CAAC,EACpB,MAAM,EAAE,MAAM,EACd,KAAK,EAAE,CAAC,GACP,IAAI,CAGN;AAED;;;;;;;;;;;;GAYG;AACH,wBAAgB,WAAW,CAAC,CAAC,SAAS,MAAM,GAAG,MAAM,GAAG,MAAM,EAAE,CAAC,EAC/D,MAAM,EAAE,MAAM,CAAC,CAAC,EAAE,CAAC,CAAC,GACnB,GAAG,CAAC,CAAC,EAAE,CAAC,CAAC,CAQX;AAED;;;;;;;;;;;;GAYG;AACH,wBAAgB,mBAAmB,CAAC,CAAC,SAAS,MAAM,GAAG,MAAM,GAAG,MAAM,EAAE,CAAC,EACvE,MAAM,EAAE,MAAM,CAAC,CAAC,EAAE,CAAC,CAAC,GACnB,WAAW,CAAC,CAAC,EAAE,CAAC,CAAC,CAEnB;AAED,4DAA4D;AAC5D,wBAAgB,MAAM,CACpB,GAAG,EAAE,GAAG,CAAC,OAAO,EAAE,MAAM,CAAC,GAAG,WAAW,CAAC,OAAO,EAAE,MAAM,CAAC,GACvD,MAAM,CAGR"}

package/dist/functions/map.lua

@@ -74,6 +74,8 @@ end
 -- 
 -- Note that the map values will be inserted in a random order, due to how `pairs` works under the
 -- hood.
+-- 
+-- Also see the `objectToReadonlyMap` function.
 function ____exports.objectToMap(self, object)
     local map = __TS__New(Map)
     for ____, ____value in ipairs(__TS__ObjectEntries(object)) do
@@ -83,6 +85,20 @@ function ____exports.objectToMap(self, object)
     end
     return map
 end
+--- Helper function to convert an object to a read-only map.
+-- 
+-- This is useful when you need to construct a type safe object with the `satisfies` operator, but
+-- then later on you need to query it in a way where you expect the return value to be T or
+-- undefined. In this situation, by converting the object to a map, you can avoid unsafe type
+-- assertions.
+-- 
+-- Note that the map values will be inserted in a random order, due to how `pairs` works under the
+-- hood.
+-- 
+-- Also see the `objectToMap` function.
+function ____exports.objectToReadonlyMap(self, object)
+    return ____exports.objectToMap(nil, object)
+end
 --- Helper function to sum every value in a map together.
 function ____exports.sumMap(self, map)
     local values = {__TS__Spread(map:values())}

package/dist/index.rollup.d.ts

@@ -14908,9 +14908,26 @@ export declare const NUM_VANILLA_TRINKET_TYPES: number;
  *
  * Note that the map values will be inserted in a random order, due to how `pairs` works under the
  * hood.
+ *
+ * Also see the `objectToReadonlyMap` function.
  */
 export declare function objectToMap<K extends string | number | symbol, V>(object: Record<K, V>): Map<K, V>;
 
+/**
+ * Helper function to convert an object to a read-only map.
+ *
+ * This is useful when you need to construct a type safe object with the `satisfies` operator, but
+ * then later on you need to query it in a way where you expect the return value to be T or
+ * undefined. In this situation, by converting the object to a map, you can avoid unsafe type
+ * assertions.
+ *
+ * Note that the map values will be inserted in a random order, due to how `pairs` works under the
+ * hood.
+ *
+ * Also see the `objectToMap` function.
+ */
+export declare function objectToReadonlyMap<K extends string | number | symbol, V>(object: Record<K, V>): ReadonlyMap<K, V>;
+
 /** Helper function to see if the player is playing any challenge. */
 export declare function onAnyChallenge(): boolean;
 

package/dist/isaacscript-common.lua

@@ -1,6 +1,6 @@
 --[[
 
-isaacscript-common 79.1.1
+isaacscript-common 79.2.0
 
 This is the "isaacscript-common" library, which was created with the IsaacScript tool.
 
@@ -46941,6 +46941,8 @@ end
 -- 
 -- Note that the map values will be inserted in a random order, due to how `pairs` works under the
 -- hood.
+-- 
+-- Also see the `objectToReadonlyMap` function.
 function ____exports.objectToMap(self, object)
     local map = __TS__New(Map)
     for ____, ____value in ipairs(__TS__ObjectEntries(object)) do
@@ -46950,6 +46952,20 @@ function ____exports.objectToMap(self, object)
     end
     return map
 end
+--- Helper function to convert an object to a read-only map.
+-- 
+-- This is useful when you need to construct a type safe object with the `satisfies` operator, but
+-- then later on you need to query it in a way where you expect the return value to be T or
+-- undefined. In this situation, by converting the object to a map, you can avoid unsafe type
+-- assertions.
+-- 
+-- Note that the map values will be inserted in a random order, due to how `pairs` works under the
+-- hood.
+-- 
+-- Also see the `objectToMap` function.
+function ____exports.objectToReadonlyMap(self, object)
+    return ____exports.objectToMap(nil, object)
+end
 --- Helper function to sum every value in a map together.
 function ____exports.sumMap(self, map)
     local values = {__TS__Spread(map:values())}

package/package.json

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

package/src/functions/map.ts

@@ -99,6 +99,8 @@ export function mapSetHash<V>(
  *
  * Note that the map values will be inserted in a random order, due to how `pairs` works under the
  * hood.
+ *
+ * Also see the `objectToReadonlyMap` function.
  */
 export function objectToMap<K extends string | number | symbol, V>(
   object: Record<K, V>,
@@ -112,6 +114,25 @@ export function objectToMap<K extends string | number | symbol, V>(
   return map;
 }
 
+/**
+ * Helper function to convert an object to a read-only map.
+ *
+ * This is useful when you need to construct a type safe object with the `satisfies` operator, but
+ * then later on you need to query it in a way where you expect the return value to be T or
+ * undefined. In this situation, by converting the object to a map, you can avoid unsafe type
+ * assertions.
+ *
+ * Note that the map values will be inserted in a random order, due to how `pairs` works under the
+ * hood.
+ *
+ * Also see the `objectToMap` function.
+ */
+export function objectToReadonlyMap<K extends string | number | symbol, V>(
+  object: Record<K, V>,
+): ReadonlyMap<K, V> {
+  return objectToMap(object);
+}
+
 /** Helper function to sum every value in a map together. */
 export function sumMap(
   map: Map<unknown, number> | ReadonlyMap<unknown, number>,