isaacscript-common 9.18.4 → 9.19.2

package/dist/index.d.ts

@@ -2106,6 +2106,23 @@ declare type ErrorCustomClassNotSerializable = "Error: Custom classes with one o
 
 declare type ErrorIsaacAPIClassIsNotSerializable = "Error: Isaac API classes (such as e.g. `Entity` or `RoomConfig`) are not serializable. For more information, see: https://isaacscript.github.io/main/gotchas#isaac-api-classes-are-not-serializable";
 
+/**
+ * These are a collection of functions for non-TypeScript users so that they can access some of
+ * useful methods offered on the `Array` class in the JavaScript standard library.
+ *
+ * If you are a TypeScript user, you should never use these functions, and instead use the more
+ * idiomatic object-oriented approach.
+ *
+ * @module
+ */
+/**
+ * Helper function for non-TypeScript users to check if every element in the array is equal to a
+ * condition.
+ *
+ * Internally, this just calls `array.every`.
+ */
+export declare function every<T>(array: T[], func: (value: T, index: number, array: T[]) => boolean): boolean;
+
 /**
  * A function that creates the default value for your `DefaultMap`. For example, if it was a
  * `DefaultMap` containing maps, the factory function would be: `() => new Map()`
@@ -2114,6 +2131,21 @@ export declare type FactoryFunction<V, Args extends unknown[]> = (...args: Args)
 
 export declare function fillLevelWithRedRooms(): void;
 
+/**
+ * Helper function for non-TypeScript users to filter the elements in an array. Returns the filtered
+ * array.
+ *
+ * Internally, this just calls `array.filter`.
+ */
+export declare function filter<T>(array: T[], func: (value: T, index: number, array: T[]) => boolean): T[];
+
+/**
+ * Helper function for non-TypeScript users to find an element in an array.
+ *
+ * Internally, this just calls `array.find`.
+ */
+export declare function find<T>(array: T[], func: (value: T, index: number, array: T[]) => boolean): T | undefined;
+
 /**
  * Helper function to get a room position that is not overlapping with a grid entity, a heaven door,
  * or a player. The `Room.FindFreePickupSpawnPosition` method will return locations that overlap
@@ -3370,6 +3402,13 @@ export declare function getHUDOffsetVector(): Vector;
  */
 export declare function getIsaacAPIClassName(object: unknown): string | undefined;
 
+/**
+ * Helper function to get the current version of the `isaacscript-common` library, according to the
+ * "package.json" file at the time of compilation. (The version is in the Semantic Versioning
+ * format, e.g. "1.0.0".)
+ */
+export declare function getIsaacScriptCommonVersion(): string;
+
 export declare function getItemConfigCardType(cardType: CardType): ItemConfigCardType;
 
 /**
@@ -5468,6 +5507,16 @@ export declare function inBeastRoom(): boolean;
  */
 export declare function inBossRoomOf(bossID: BossID): boolean;
 
+/**
+ * Helper function for non-TypeScript users to check if an element is in an array.
+ *
+ * Since this takes O(N) time, using this function is usually a mistake, since you can use a `Map`
+ * data structure to get O(1) lookups.
+ *
+ * Internally, this just calls `array.includes`.
+ */
+export declare function includes<T>(array: T[], element: T): boolean;
+
 /**
  * Helper function for determining whether the current room is a crawl space. Use this function over
  * comparing to `RoomType.DUNGEON` or `GridRoom.DUNGEON_IDX` since there is a special case of the
@@ -6052,6 +6101,10 @@ export declare function isLRoom(roomShape: RoomShape): boolean;
  *
  * This function uses the `package` global variable as a proxy to determine if the "--luadebug" flag
  * is enabled or not.
+ *
+ * Note that this function will return false if the Racing+ sandbox is enabled, even if the
+ * "--luadebug" flag is really turned on. If checking for this case is needed, check for the
+ * presence of the `sandboxGetTraceback` function.
  */
 export declare function isLuaDebugEnabled(): boolean;
 
@@ -6416,6 +6469,14 @@ export declare const itemConfig: ItemConfig;
  */
 export declare function iterateTableInOrder<K, V>(luaMap: LuaMap<K, V>, func: (key: K, value: V) => void, inOrder?: boolean): void;
 
+/**
+ * Helper function for non-TypeScript users to convert an array to a string with the specified
+ * separator.
+ *
+ * Internally, this just calls `array.join`.
+ */
+export declare function join<T>(array: T[], separator: string): string;
+
 /**
  * Converts a JSON string to a Lua table.
  *
@@ -6771,6 +6832,14 @@ export declare function logUserdata(userdata: unknown): void;
 
 export declare function logVector(vector: Vector, round?: boolean): void;
 
+/**
+ * Helper function for non-TypeScript users to convert all of the elements in an array to something
+ * else.
+ *
+ * Internally, this just calls `array.map`.
+ */
+export declare function map<T, U>(array: T[], func: (value: T, index: number, array: T[]) => U): U[];
+
 /**
  * Helper function to make using maps with an index of `PlayerIndex` easier. Use this instead of the
  * `Map.get` method if you have a map of this type.
@@ -11831,7 +11900,7 @@ export declare type TSTLClass = LuaMap<AnyNotNil, unknown> & {
  * From:
  * https://stackoverflow.com/questions/16096872/how-to-sort-2-dimensional-array-by-column-value
  */
-export declare function twoDimensionalSort<T>(a: T[], b: T[]): -1 | 0 | 1;
+export declare function twoDimensionalSort<T>(array1: T[], array2: T[]): -1 | 0 | 1;
 
 /**
  * This is the number of draw coordinates that each heart spans on the UI in the upper left hand