isaacscript-common 84.1.2 → 84.2.1

package/src/functions/set.ts

@@ -1,5 +1,6 @@
 import { ReadonlySet } from "../types/ReadonlySet";
 import { getArrayCombinations, getRandomArrayElement, sumArray } from "./array";
+import { sortNormal } from "./sort";
 import { isPrimitive } from "./types";
 
 /**
@@ -78,7 +79,7 @@ export function deleteSetsFromSet<T>(
  *                  a random seed.
  * @param exceptions Optional. An array of elements to skip over if selected.
  */
-export function getRandomSetElement<T>(
+export function getRandomSetElement<T extends number | string>(
   set: ReadonlySet<T>,
   seedOrRNG: Seed | RNG | undefined,
   exceptions: readonly T[] = [],
@@ -106,7 +107,7 @@ export function getRandomSetElement<T>(
  * @param set The set to get the combinations of.
  * @param includeEmptyArray Whether to include an empty array in the combinations.
  */
-export function getSetCombinations<T>(
+export function getSetCombinations<T extends number | string>(
   set: ReadonlySet<T>,
   includeEmptyArray: boolean,
 ): ReadonlyArray<ReadonlySet<T>> {
@@ -123,7 +124,9 @@ export function getSetCombinations<T>(
  * the contents is important.
  */
 // eslint-disable-next-line isaacscript/no-mutable-return
-export function getSortedSetValues<T>(set: ReadonlySet<T>): T[] {
+export function getSortedSetValues<T extends number | string>(
+  set: ReadonlySet<T>,
+): T[] {
   const values = [...set];
 
   // Check for problematic types in order to throw a helpful error message.
@@ -137,7 +140,7 @@ export function getSortedSetValues<T>(set: ReadonlySet<T>): T[] {
     }
   }
 
-  values.sort();
+  values.sort(sortNormal);
 
   return values;
 }

package/src/functions/sort.ts

@@ -1,6 +1,6 @@
 import { isNumber, isString, isTable } from "./types";
 
-function sortNormal(a: unknown, b: unknown): -1 | 0 | 1 {
+export function sortNormal(a: unknown, b: unknown): -1 | 0 | 1 {
   if (!isNumber(a) && !isString(a)) {
     error(
       `Failed to normal sort since the first value was not a number or string and was instead: ${type(
@@ -79,7 +79,7 @@ export function sortObjectArrayByKey(key: string) {
  *
  * ```ts
  * const myArray = [[1, 2], [2, 3], [3, 4]];
- * myArray.sort(twoDimensionalSort);
+ * myArray.sort(sortTwoDimensionalArray);
  * ```
  *
  * This function also properly handles when the array elements are strings or numbers (instead of

package/src/functions/table.ts

@@ -186,7 +186,7 @@ export function iterateTableInOrder<K extends AnyNotNil, V>(
     return;
   }
 
-  keys.sort();
+  keys.sort(); // eslint-disable-line @typescript-eslint/require-array-sort-compare
   for (const key of keys) {
     const keyIndex = key as unknown as K;
     const value = luaMap.get(keyIndex);

package/src/functions/types.ts

@@ -171,12 +171,12 @@ export function asTrinketType(num: int): TrinketType {
 }
 
 export function isBoolean(variable: unknown): variable is boolean {
-  return type(variable) === "boolean";
+  return typeof variable === "boolean";
 }
 
 // eslint-disable-next-line @typescript-eslint/ban-types
 export function isFunction(variable: unknown): variable is Function {
-  return type(variable) === "function";
+  return typeof variable === "function";
 }
 
 export function isInteger(variable: unknown): variable is int {
@@ -188,14 +188,14 @@ export function isInteger(variable: unknown): variable is int {
 }
 
 export function isNumber(variable: unknown): variable is number {
-  return type(variable) === "number";
+  return typeof variable === "number";
 }
 
 /** Helper function to detect if a variable is a boolean, number, or string. */
 export function isPrimitive(
   variable: unknown,
 ): variable is boolean | number | string {
-  const variableType = type(variable);
+  const variableType = typeof variable;
   return (
     variableType === "boolean" ||
     variableType === "number" ||
@@ -204,16 +204,18 @@ export function isPrimitive(
 }
 
 export function isString(variable: unknown): variable is string {
-  return type(variable) === "string";
+  return typeof variable === "string";
 }
 
 export function isTable(
   variable: unknown,
 ): variable is LuaMap<AnyNotNil, unknown> {
+  // We cannot use `typeof` here since "table" is not a JavaScript type.
   return type(variable) === "table";
 }
 
 export function isUserdata(variable: unknown): variable is LuaUserdata {
+  // We cannot use `typeof` here since "userdata" is not a JavaScript type.
   return type(variable) === "userdata";
 }