isaacscript-common 81.0.4 → 81.0.5

package/src/functions/rng.ts

@@ -1,6 +1,7 @@
 import type { CopyableIsaacAPIClassType } from "isaac-typescript-definitions";
 import { game } from "../core/cachedClasses";
 import { SerializationBrand } from "../enums/private/SerializationBrand";
+import type { ReadonlyRecord } from "../types/ReadonlyRecord";
 import { traceback } from "./debugFunctions";
 import { isaacAPIClassEquals, isIsaacAPIClassOfType } from "./isaacAPIClass";
 import { logError } from "./log";
@@ -121,7 +122,10 @@ export function serializeRNG(rng: RNG): SerializedRNG {
  * Helper function to iterate over the provided object and set the seed for all of the values that
  * are RNG objects equal to a particular seed.
  */
-export function setAllRNGToSeed(object: unknown, seed: Seed): void {
+export function setAllRNGToSeed(
+  object: ReadonlyRecord<string, RNG>,
+  seed: Seed,
+): void {
   if (!isTable(object)) {
     error(
       `Failed to iterate over the object containing RNG objects since the type of the provided object was: ${typeof object}`,
@@ -147,7 +151,9 @@ export function setAllRNGToSeed(object: unknown, seed: Seed): void {
  * Helper function to iterate over the provided object and set the seed for all of the values that
  * are RNG objects equal to the start seed for the current run.
  */
-export function setAllRNGToStartSeed(object: unknown): void {
+export function setAllRNGToStartSeed(
+  object: ReadonlyRecord<string, RNG>,
+): void {
   const seeds = game.GetSeeds();
   const startSeed = seeds.GetStartSeed();
 

package/src/functions/rooms.ts

@@ -472,7 +472,7 @@ export function inMirrorRoom(): boolean {
  *
  * This function is variadic, which means you can pass as many room shapes as you want to match for.
  */
-export function inRoomShape(...roomShapes: RoomShape[]): boolean {
+export function inRoomShape(...roomShapes: readonly RoomShape[]): boolean {
   const roomData = getRoomData();
   return isRoomShape(roomData, ...roomShapes);
 }
@@ -482,7 +482,7 @@ export function inRoomShape(...roomShapes: RoomShape[]): boolean {
  *
  * This function is variadic, which means you can pass as many room types as you want to match for.
  */
-export function inRoomType(...roomTypes: RoomType[]): boolean {
+export function inRoomType(...roomTypes: readonly RoomType[]): boolean {
   const roomData = getRoomData();
   return isRoomType(roomData, ...roomTypes);
 }
@@ -806,7 +806,7 @@ export function isMirrorRoom(roomData: RoomConfig): boolean {
  */
 export function isRoomShape(
   roomData: RoomConfig,
-  ...roomShapes: RoomShape[]
+  ...roomShapes: readonly RoomShape[]
 ): boolean {
   return roomShapes.includes(roomData.Shape);
 }
@@ -818,7 +818,7 @@ export function isRoomShape(
  */
 export function isRoomType(
   roomData: RoomConfig,
-  ...roomTypes: RoomType[]
+  ...roomTypes: readonly RoomType[]
 ): boolean {
   return roomTypes.includes(roomData.Type);
 }

package/src/functions/run.ts

@@ -10,7 +10,9 @@ import { log } from "./log";
 import { isString } from "./types";
 
 /** Alias for the `anySeedEffectEnabled` function. */
-export function anyEasterEggEnabled(exceptions?: SeedEffect[]): boolean {
+export function anyEasterEggEnabled(
+  exceptions?: readonly SeedEffect[],
+): boolean {
   return anySeedEffectEnabled(exceptions);
 }
 
@@ -19,7 +21,9 @@ export function anyEasterEggEnabled(exceptions?: SeedEffect[]): boolean {
  *
  * @param exceptions Optional. An array of seed effects to ignore.
  */
-export function anySeedEffectEnabled(exceptions?: SeedEffect[]): boolean {
+export function anySeedEffectEnabled(
+  exceptions?: readonly SeedEffect[],
+): boolean {
   const seeds = game.GetSeeds();
 
   if (exceptions === undefined) {

package/src/functions/set.ts

@@ -9,6 +9,7 @@ import { isPrimitive } from "./types";
  * This function is variadic, meaning that you can specify N sets to add to the first set.
  */
 export function addSetsToSet<T>(
+  // eslint-disable-next-line isaacscript/prefer-readonly-parameter-types
   mainSet: Set<T>,
   ...setsToAdd: ReadonlyArray<ReadonlySet<T>>
 ): void {
@@ -54,6 +55,7 @@ export function copySet<T>(oldSet: ReadonlySet<T>): Set<T> {
  * This function is variadic, meaning that you can specify N sets to remove from the first set.
  */
 export function deleteSetsFromSet<T>(
+  // eslint-disable-next-line isaacscript/prefer-readonly-parameter-types
   mainSet: Set<T>,
   ...setsToRemove: ReadonlyArray<ReadonlySet<T>>
 ): void {
@@ -217,6 +219,7 @@ export function objectValuesToSet<K extends string | number | symbol, V>(
  *
  * This function is variadic, meaning that you can pass as many things as you want to add.
  */
+// eslint-disable-next-line isaacscript/prefer-readonly-parameter-types
 export function setAdd<T>(set: Set<T>, ...elements: readonly T[]): void {
   for (const element of elements) {
     set.add(element);

package/src/functions/sort.ts

@@ -88,7 +88,10 @@ export function sortObjectArrayByKey(key: string) {
  * From:
  * https://stackoverflow.com/questions/16096872/how-to-sort-2-dimensional-array-by-column-value
  */
-export function sortTwoDimensionalArray<T>(a: T[], b: T[]): -1 | 0 | 1 {
+export function sortTwoDimensionalArray<T>(
+  a: readonly T[],
+  b: readonly T[],
+): -1 | 0 | 1 {
   const aType = type(a);
   const bType = type(b);
   if (aType !== bType) {
@@ -148,6 +151,7 @@ export function sortTwoDimensionalArray<T>(a: T[], b: T[]): -1 | 0 | 1 {
  */
 // eslint-disable-next-line isaacscript/no-mutable-return
 export function stableSort<T>(
+  // eslint-disable-next-line isaacscript/prefer-readonly-parameter-types
   array: T[],
   sortFunc: (a: T, b: T) => -1 | 0 | 1 = sortNormal,
 ): T[] {

package/src/functions/stage.ts

@@ -362,7 +362,9 @@ export function onDarkRoom(): boolean {
  *
  * This function is variadic, which means you can pass as many stages as you want to match for.
  */
-export function onEffectiveStage(...effectiveStages: LevelStage[]): boolean {
+export function onEffectiveStage(
+  ...effectiveStages: readonly LevelStage[]
+): boolean {
   const thisEffectiveStage = getEffectiveStage();
   return effectiveStages.includes(thisEffectiveStage);
 }
@@ -422,7 +424,7 @@ export function onSheol(): boolean {
  *
  * This function is variadic, which means you can pass as many stages as you want to match for.
  */
-export function onStage(...stages: LevelStage[]): boolean {
+export function onStage(...stages: readonly LevelStage[]): boolean {
   const level = game.GetLevel();
   const thisStage = level.GetStage();
   return stages.includes(thisStage);
@@ -447,7 +449,7 @@ export function onStageOrLower(stage: LevelStage): boolean {
  *
  * This function is variadic, which means you can pass as many room types as you want to match for.
  */
-export function onStageType(...stageTypes: StageType[]): boolean {
+export function onStageType(...stageTypes: readonly StageType[]): boolean {
   const level = game.GetLevel();
   const thisStageType = level.GetStageType();
   return stageTypes.includes(thisStageType);

package/src/functions/string.ts

@@ -1,3 +1,4 @@
+import type { ReadonlyRecord } from "../types/ReadonlyRecord";
 import { parseIntSafe } from "./types";
 import { assertDefined } from "./utils";
 
@@ -81,7 +82,7 @@ export function getMapPartialMatch<T>(
  */
 export function getObjectPartialMatch<T>(
   searchText: string,
-  object: Record<string, T>,
+  object: ReadonlyRecord<string, T>,
 ): [string, T] | undefined {
   const keys = Object.keys(object);
 
@@ -204,7 +205,7 @@ export function removeNonAlphanumericCharacters(str: string): string {
  */
 export function removeSubstring(
   string: string,
-  ...substrings: string[]
+  ...substrings: readonly string[]
 ): string {
   for (const substring of substrings) {
     string = string.replaceAll(substring, "");

package/src/functions/table.ts

@@ -43,7 +43,7 @@ export function copyUserdataValuesToTable(
 export function getBooleansFromTable(
   luaMap: LuaMap<string, unknown>,
   objectName: string,
-  ...keys: string[]
+  ...keys: readonly string[]
 ): readonly boolean[] {
   const booleans: boolean[] = [];
   for (const key of keys) {
@@ -75,7 +75,7 @@ export function getBooleansFromTable(
 export function getNumbersFromTable(
   luaMap: LuaMap<string, unknown>,
   objectName: string,
-  ...keys: string[]
+  ...keys: readonly string[]
 ): readonly number[] {
   const numbers: number[] = [];
   for (const key of keys) {
@@ -114,7 +114,7 @@ export function getNumbersFromTable(
 export function getStringsFromTable(
   luaMap: LuaMap<string, unknown>,
   objectName: string,
-  ...keys: string[]
+  ...keys: readonly string[]
 ): readonly string[] {
   const strings: string[] = [];
   for (const key of keys) {
@@ -204,7 +204,7 @@ export function iterateTableInOrder<K extends AnyNotNil, V>(
  */
 export function tableHasKeys(
   luaMap: LuaMap<AnyNotNil, unknown>,
-  ...keys: string[]
+  ...keys: readonly string[]
 ): boolean {
   return keys.every((key) => luaMap.has(key));
 }

package/src/functions/trinketGive.ts

@@ -88,7 +88,7 @@ export function smeltTrinket(
  */
 export function smeltTrinkets(
   player: EntityPlayer,
-  ...trinketTypes: TrinketType[]
+  ...trinketTypes: readonly TrinketType[]
 ): void {
   for (const trinketType of trinketTypes) {
     smeltTrinket(player, trinketType);

package/src/functions/utils.ts

@@ -228,4 +228,4 @@ export function repeat(num: int, func: (i: int) => void): void {
  * @allowEmptyVariadic
  */
 // eslint-disable-next-line @typescript-eslint/no-unused-vars, @typescript-eslint/no-empty-function
-export function todo(...args: unknown[]): void {}
+export function todo(...args: readonly unknown[]): void {}

package/src/functions/vector.ts

@@ -86,7 +86,7 @@ export function doesVectorHaveLength(
  */
 export function getClosestVectorTo(
   referenceVector: Vector,
-  vectors: Vector[],
+  vectors: readonly Vector[],
 ): Vector | undefined {
   let closestVector: Vector | undefined;
   let closestDistance = math.huge;

package/src/functions/weighted.ts

@@ -17,7 +17,7 @@ import { assertDefined } from "./utils";
  *                  a random seed.
  */
 export function getRandomFromWeightedArray<T>(
-  weightedArray: WeightedArray<T>,
+  weightedArray: Readonly<WeightedArray<T>>,
   seedOrRNG: Seed | RNG | undefined,
 ): T {
   const randomIndex = getRandomIndexFromWeightedArray(weightedArray, seedOrRNG);
@@ -45,7 +45,7 @@ export function getRandomFromWeightedArray<T>(
  *                  a random seed.
  */
 export function getRandomIndexFromWeightedArray<T>(
-  weightedArray: WeightedArray<T>,
+  weightedArray: Readonly<WeightedArray<T>>,
   seedOrRNG: Seed | RNG | undefined,
 ): int {
   if (weightedArray.length === 0) {

package/src/index.ts

@@ -185,6 +185,7 @@ export * from "./types/PlayerIndex";
 export * from "./types/PossibleStatType";
 export * from "./types/PublicInterface";
 export * from "./types/ReadonlyMap";
+export * from "./types/ReadonlyRecord";
 export * from "./types/ReadonlySet";
 export * from "./types/StartsWithLowercase";
 export * from "./types/StartsWithUppercase";

package/src/types/AnyFunction.ts

@@ -2,4 +2,4 @@
  * Helper type to represent any function. This is safer than using the built-in `Function` type, as
  * it does not completely turn off all type safety.
  */
-export type AnyFunction = (...args: unknown[]) => unknown;
+export type AnyFunction = (...args: readonly unknown[]) => unknown;

package/src/types/ReadonlyRecord.ts

@@ -0,0 +1,3 @@
+export type ReadonlyRecord<K extends string | number | symbol, V> = Readonly<
+  Record<K, V>
+>;