isaacscript-common 20.18.1 → 21.1.0

package/dist/index.d.ts

@@ -5928,6 +5928,31 @@ export declare function getRedHearts(): EntityPickupHeart[];
  */
 export declare function getRepentanceDoor(): GridEntityDoor | undefined;
 
+/**
+ * Helper function to get a copy of a map with the keys and the values reversed.
+ *
+ * For example:
+ *
+ * ```ts
+ * new Map<string, number>([
+ *   ["foo", 1],
+ *   ["bar", 2],
+ * ]);
+ * ```
+ *
+ * Would be reversed to:
+ *
+ * ```ts
+ * new Map<number, string>([
+ *   [1, "foo"],
+ *   [2, "bar"],
+ * ]);
+ * ```
+ */
+export declare function getReversedMap<K, V>(map: Map<K, V>): Map<V, K>;
+
+export declare function getReversedMap<K, V>(map: ReadonlyMap<K, V>): ReadonlyMap<V, K>;
+
 /**
  * Helper function to get the alternate rock type (i.e. urn, mushroom, etc.) that the current room
  * will have.
@@ -6764,32 +6789,6 @@ export declare function gridIndexToGridPosition(gridIndex: int, roomShape: RoomS
  */
 export declare function gridPositionToWorldPosition(gridPosition: Vector): Vector;
 
-/**
- * Helper type to ensure that an object contains a key for every enum member. Use this with `as
- * const` and `satisfies` to prevent narrowing the type of the object.
- *
- * For example:
- *
- * ```ts
- * enum MyEnum {
- *   Value1,
- *   Value2,
- *   Value3,
- * }
- *
- * const MyEnumToString = {
- *   [MyEnum.Value1]: "foo",
- *   [MyEnum.Value2]: "bar",
- *   [MyEnum.Value3]: "baz",
- * } as const satisfies HasAllEnumKeys<MyEnum, string>;
- *
- * const value = MyEnumToString[MyEnum.Value2];
- * ```
- */
-export declare type HasAllEnumKeys<Enum extends string | number, T> = {
-    readonly [Key in Enum]: T;
-};
-
 /**
  * Helper function to see if a particular entity has armor. In this context, armor refers to the
  * damage scaling mechanic. For example, Ultra Greed has armor, but a Gaper does not.
@@ -8135,9 +8134,6 @@ export declare function isVanillaWallGridIndex(gridIndex: int): boolean;
 /** Helper function to check if something is an instantiated `Vector` object. */
 export declare function isVector(object: unknown): object is Vector;
 
-/** The set of all `ItemConfigCardType` values that are not a rune or special object. */
-export declare const ITEM_CONFIG_CARD_TYPES_FOR_CARDS: ReadonlySet<ItemConfigCardType>;
-
 /**
  * A cached version of the class returned from the `Isaac.GetItemConfig()` constructor.
  *
@@ -11713,16 +11709,16 @@ export declare enum MysteriousPaperEffect {
 }
 
 /** This is near the top door. */
-export declare const NEW_FLOOR_STARTING_POSITION_GREED_MODE: Vector;
+export declare const NEW_FLOOR_STARTING_POSITION_GREED_MODE: Readonly<Vector>;
 
 /** This is in the center of the room. */
-export declare const NEW_FLOOR_STARTING_POSITION_NORMAL_MODE: Vector;
+export declare const NEW_FLOOR_STARTING_POSITION_NORMAL_MODE: Readonly<Vector>;
 
 /**
  * This is next to the bottom door. Presumably, the player does not start in the center of the room
  * (like they do when getting to a new stage) so that the controls graphic is more visible.
  */
-export declare const NEW_RUN_PLAYER_STARTING_POSITION: Vector;
+export declare const NEW_RUN_PLAYER_STARTING_POSITION: Readonly<Vector>;
 
 /**
  * Constructor for a `ChargeBarSprites` object. For more information, see the `renderChargeBar`
@@ -12539,6 +12535,25 @@ export declare function printEnabled(enabled: boolean, description: string): voi
 /** Helper type to extract only the public interface of a class. */
 export declare type PublicInterface<T> = Pick<T, keyof T>;
 
+/** An alias for the `Map` constructor that returns a read-only map. */
+declare const ReadonlyMap_2: ReadonlyMapConstructor;
+export { ReadonlyMap_2 as ReadonlyMap }
+
+declare interface ReadonlyMapConstructor {
+    new (): ReadonlyMap<any, any>;
+    new <K, V>(entries?: ReadonlyArray<readonly [K, V]> | null): ReadonlyMap<K, V>;
+    readonly prototype: ReadonlyMap<any, any>;
+}
+
+/** An alias for the `Set` constructor that returns a read-only set. */
+declare const ReadonlySet_2: ReadonlySetConstructor;
+export { ReadonlySet_2 as ReadonlySet }
+
+declare interface ReadonlySetConstructor {
+    new <T = any>(values?: readonly T[] | null): ReadonlySet<T>;
+    readonly prototype: ReadonlySet<any>;
+}
+
 /**
  * Helper function to reload the current room using `Game.StartRoomTransition`.
  *
@@ -15362,7 +15377,7 @@ export declare function validateEnumContiguous<T>(transpiledEnumName: string, tr
  *
  * 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 `HasAllEnumValues` helper type instead.
+ * `satisfies` operator with the `Record` type instead.
  */
 export declare function validateInterfaceMatchesEnum<T extends Record<Enum, unknown>, Enum extends string | number>(): void;