isaacscript-common 87.9.6 → 87.9.8

package/dist/functions/array.js

@@ -1,45 +1,14 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.arrayEquals = arrayEquals;
-exports.arrayRemove = arrayRemove;
-exports.arrayRemoveAllInPlace = arrayRemoveAllInPlace;
-exports.arrayRemoveInPlace = arrayRemoveInPlace;
-exports.arrayRemoveIndex = arrayRemoveIndex;
-exports.arrayRemoveIndexInPlace = arrayRemoveIndexInPlace;
-exports.arrayToString = arrayToString;
-exports.combineArrays = combineArrays;
-exports.copyArray = copyArray;
-exports.emptyArray = emptyArray;
-exports.filterMap = filterMap;
-exports.getArrayCombinations = getArrayCombinations;
-exports.getArrayDuplicateElements = getArrayDuplicateElements;
-exports.getArrayIndexes = getArrayIndexes;
-exports.getHighestArrayElement = getHighestArrayElement;
-exports.getLowestArrayElement = getLowestArrayElement;
-exports.getRandomArrayElement = getRandomArrayElement;
-exports.getRandomArrayElementAndRemove = getRandomArrayElementAndRemove;
-exports.getRandomArrayIndex = getRandomArrayIndex;
-exports.includes = includes;
-exports.isArray = isArray;
-exports.isArrayContiguous = isArrayContiguous;
-exports.isArrayElementsUnique = isArrayElementsUnique;
-exports.isArrayInArray = isArrayInArray;
-exports.setAllArrayElements = setAllArrayElements;
-exports.shuffleArray = shuffleArray;
-exports.shuffleArrayInPlace = shuffleArrayInPlace;
-exports.sumArray = sumArray;
-exports.swapArrayElements = swapArrayElements;
-const ReadonlySet_1 = require("../types/ReadonlySet");
-const random_1 = require("./random");
-const rng_1 = require("./rng");
-const sort_1 = require("./sort");
-const types_1 = require("./types");
-const utils_1 = require("./utils");
+import { ReadonlySet } from "../types/ReadonlySet";
+import { getRandomInt } from "./random";
+import { isRNG, newRNG } from "./rng";
+import { sortNormal } from "./sort";
+import { isNumber, isTable } from "./types";
+import { assertDefined, eRange } from "./utils";
 /**
  * Helper function for determining if two arrays contain the exact same elements. Note that this
  * only performs a shallow comparison.
  */
-function arrayEquals(array1, array2) {
+export function arrayEquals(array1, array2) {
     if (array1.length !== array2.length) {
         return false;
     }
@@ -57,10 +26,10 @@ function arrayEquals(array1, array2) {
  *
  * This function is variadic, meaning that you can specify N arguments to remove N elements.
  */
-function arrayRemove(originalArray, ...elementsToRemove
+export function arrayRemove(originalArray, ...elementsToRemove
 // eslint-disable-next-line complete/no-mutable-return
 ) {
-    const elementsToRemoveSet = new ReadonlySet_1.ReadonlySet(elementsToRemove);
+    const elementsToRemoveSet = new ReadonlySet(elementsToRemove);
     const array = [];
     for (const element of originalArray) {
         if (!elementsToRemoveSet.has(element)) {
@@ -81,7 +50,7 @@ function arrayRemove(originalArray, ...elementsToRemove
  *
  * @returns True if one or more elements were removed, false otherwise.
  */
-function arrayRemoveAllInPlace(
+export function arrayRemoveAllInPlace(
 // eslint-disable-next-line complete/prefer-readonly-parameter-types
 array, ...elementsToRemove) {
     let removedOneOrMoreElements = false;
@@ -97,33 +66,6 @@ array, ...elementsToRemove) {
     }
     return removedOneOrMoreElements;
 }
-/**
- * Removes the specified element(s) from the array. If the specified element(s) are not found in the
- * array, this function will do nothing.
- *
- * This function is variadic, meaning that you can specify N arguments to remove N elements.
- *
- * If there is more than one matching element in the array, this function will only remove the first
- * matching element. If you want to remove all of the elements, use the `arrayRemoveAllInPlace`
- * function instead.
- *
- * @returns The removed elements. This will be an empty array if no elements were removed.
- */
-function arrayRemoveInPlace(
-// eslint-disable-next-line complete/prefer-readonly-parameter-types
-array, ...elementsToRemove
-// eslint-disable-next-line complete/no-mutable-return
-) {
-    const removedElements = [];
-    for (const element of elementsToRemove) {
-        const index = array.indexOf(element);
-        if (index !== -1) {
-            const removedElement = array.splice(index, 1);
-            removedElements.push(...removedElement);
-        }
-    }
-    return removedElements;
-}
 /**
  * Shallow copies and removes the elements at the specified indexes from the array. Returns the
  * copied array. If the specified indexes are not found in the array, it will simply return a
@@ -131,10 +73,10 @@ array, ...elementsToRemove
  *
  * This function is variadic, meaning that you can specify N arguments to remove N elements.
  */
-function arrayRemoveIndex(originalArray, ...indexesToRemove
+export function arrayRemoveIndex(originalArray, ...indexesToRemove
 // eslint-disable-next-line complete/no-mutable-return
 ) {
-    const indexesToRemoveSet = new ReadonlySet_1.ReadonlySet(indexesToRemove);
+    const indexesToRemoveSet = new ReadonlySet(indexesToRemove);
     const array = [];
     for (const [i, element] of originalArray.entries()) {
         if (!indexesToRemoveSet.has(i)) {
@@ -151,7 +93,7 @@ function arrayRemoveIndex(originalArray, ...indexesToRemove
  *
  * @returns The removed elements. This will be an empty array if no elements were removed.
  */
-function arrayRemoveIndexInPlace(
+export function arrayRemoveIndexInPlace(
 // eslint-disable-next-line complete/prefer-readonly-parameter-types
 array, ...indexesToRemove
 // eslint-disable-next-line complete/no-mutable-return
@@ -160,17 +102,45 @@ array, ...indexesToRemove
     if (legalIndexes.length === 0) {
         return [];
     }
-    const legalIndexesSet = new ReadonlySet_1.ReadonlySet(legalIndexes);
+    const legalIndexesSet = new ReadonlySet(legalIndexes);
     const removedElements = [];
     for (let i = array.length - 1; i >= 0; i--) {
-        if (legalIndexesSet.has(i)) {
-            const removedElement = array.splice(i, 1);
+        if (!legalIndexesSet.has(i)) {
+            continue;
+        }
+        const removedElement = array.splice(i, 1);
+        removedElements.push(...removedElement);
+    }
+    return removedElements;
+}
+/**
+ * Removes the specified element(s) from the array. If the specified element(s) are not found in the
+ * array, this function will do nothing.
+ *
+ * This function is variadic, meaning that you can specify N arguments to remove N elements.
+ *
+ * If there is more than one matching element in the array, this function will only remove the first
+ * matching element. If you want to remove all of the elements, use the `arrayRemoveAllInPlace`
+ * function instead.
+ *
+ * @returns The removed elements. This will be an empty array if no elements were removed.
+ */
+export function arrayRemoveInPlace(
+// eslint-disable-next-line complete/prefer-readonly-parameter-types
+array, ...elementsToRemove
+// eslint-disable-next-line complete/no-mutable-return
+) {
+    const removedElements = [];
+    for (const element of elementsToRemove) {
+        const index = array.indexOf(element);
+        if (index !== -1) {
+            const removedElement = array.splice(index, 1);
             removedElements.push(...removedElement);
         }
     }
     return removedElements;
 }
-function arrayToString(array) {
+export function arrayToString(array) {
     if (array.length === 0) {
         return "[]";
     }
@@ -186,7 +156,7 @@ function arrayToString(array) {
  * that this will only perform a shallow copy of the array elements.
  */
 // eslint-disable-next-line complete/no-mutable-return
-function combineArrays(...arrays) {
+export function combineArrays(...arrays) {
     const elements = [];
     for (const array of arrays) {
         for (const element of array) {
@@ -203,7 +173,7 @@ function combineArrays(...arrays) {
  *                    entire array will be copied.
  */
 // eslint-disable-next-line complete/no-mutable-return
-function copyArray(oldArray, numElements) {
+export function copyArray(oldArray, numElements) {
     // Using the spread operator was benchmarked to be faster than manually creating an array using
     // the below algorithm.
     if (numElements === undefined) {
@@ -218,8 +188,8 @@ function copyArray(oldArray, numElements) {
 }
 /** Helper function to remove all of the elements in an array in-place. */
 // eslint-disable-next-line complete/prefer-readonly-parameter-types
-function emptyArray(array) {
-    array.splice(0);
+export function emptyArray(array) {
+    array.length = 0;
 }
 /**
  * Helper function to perform a filter and a map at the same time. Similar to `Array.map`, provide a
@@ -232,7 +202,7 @@ function emptyArray(array) {
  * This is named `filterMap` after the Rust function:
  * https://doc.rust-lang.org/std/iter/struct.FilterMap.html
  */
-function filterMap(array, func) {
+export function filterMap(array, func) {
     const filteredArray = [];
     for (const element of array) {
         const newElement = func(element);
@@ -266,7 +236,7 @@ function filterMap(array, func) {
  * @param max Optional. The maximum number of elements to include in each combination. Default is
  *            the length of the array.
  */
-function getArrayCombinations(array, includeEmptyArray, min, max) {
+export function getArrayCombinations(array, includeEmptyArray, min, max) {
     if (min === undefined || min <= 0) {
         min = 1;
     }
@@ -282,29 +252,16 @@ function getArrayCombinations(array, includeEmptyArray, min, max) {
     }
     // Finally, account for the empty array combination.
     if (includeEmptyArray) {
+        // eslint-disable-next-line unicorn/no-array-front-mutation
         all.unshift([]);
     }
     return all;
 }
-/** Mutates the `all` array in-place. */
-function addCombinations(n, src, got, 
-// eslint-disable-next-line complete/prefer-readonly-parameter-types
-all) {
-    if (n === 0) {
-        if (got.length > 0) {
-            all[all.length] = got;
-        }
-        return;
-    }
-    for (const [i, element] of src.entries()) {
-        addCombinations(n - 1, src.slice(i + 1), [...got, element], all);
-    }
-}
 /**
  * Helper function to get the duplicate elements in an array. Only one element for each value will
  * be returned. The elements will be sorted before they are returned.
  */
-function getArrayDuplicateElements(array) {
+export function getArrayDuplicateElements(array) {
     const duplicateElements = new Set();
     const set = new Set();
     for (const element of array) {
@@ -314,7 +271,7 @@ function getArrayDuplicateElements(array) {
         set.add(element);
     }
     const values = [...duplicateElements];
-    return values.toSorted(sort_1.sortNormal);
+    return values.toSorted(sortNormal);
 }
 /**
  * Helper function to get an array containing the indexes of an array.
@@ -325,14 +282,14 @@ function getArrayDuplicateElements(array) {
  * due to implementation details of TypeScriptToLua, this results in an array of 1 through N
  * (instead of an array of 0 through N -1).
  */
-function getArrayIndexes(array) {
-    return (0, utils_1.eRange)(array.length);
+export function getArrayIndexes(array) {
+    return eRange(array.length);
 }
 /**
  * Helper function to get the highest value in an array. Returns undefined if there were no elements
  * in the array.
  */
-function getHighestArrayElement(array) {
+export function getHighestArrayElement(array) {
     if (array.length === 0) {
         return undefined;
     }
@@ -348,7 +305,7 @@ function getHighestArrayElement(array) {
  * Helper function to get the lowest value in an array. Returns undefined if there were no elements
  * in the array.
  */
-function getLowestArrayElement(array) {
+export function getLowestArrayElement(array) {
     if (array.length === 0) {
         return undefined;
     }
@@ -372,14 +329,14 @@ function getLowestArrayElement(array) {
  *                  a random seed.
  * @param exceptions Optional. An array of elements to skip over if selected.
  */
-function getRandomArrayElement(array, seedOrRNG, exceptions = []) {
+export function getRandomArrayElement(array, seedOrRNG, exceptions = []) {
     if (array.length === 0) {
         error("Failed to get a random array element since the provided array is empty.");
     }
     const arrayToUse = exceptions.length > 0 ? arrayRemove(array, ...exceptions) : array;
     const randomIndex = getRandomArrayIndex(arrayToUse, seedOrRNG);
     const randomElement = arrayToUse[randomIndex];
-    (0, utils_1.assertDefined)(randomElement, `Failed to get a random array element since the random index of ${randomIndex} was not valid.`);
+    assertDefined(randomElement, `Failed to get a random array element since the random index of ${randomIndex} was not valid.`);
     return randomElement;
 }
 /**
@@ -395,7 +352,7 @@ function getRandomArrayElement(array, seedOrRNG, exceptions = []) {
  *                  a random seed.
  * @param exceptions Optional. An array of elements to skip over if selected.
  */
-function getRandomArrayElementAndRemove(
+export function getRandomArrayElementAndRemove(
 // eslint-disable-next-line complete/prefer-readonly-parameter-types
 array, seedOrRNG, exceptions = []) {
     const randomArrayElement = getRandomArrayElement(array, seedOrRNG, exceptions);
@@ -415,11 +372,11 @@ array, seedOrRNG, exceptions = []) {
  * @param exceptions Optional. An array of indexes that will be skipped over when getting the random
  *                   index. Default is an empty array.
  */
-function getRandomArrayIndex(array, seedOrRNG, exceptions = []) {
+export function getRandomArrayIndex(array, seedOrRNG, exceptions = []) {
     if (array.length === 0) {
         error("Failed to get a random array index since the provided array is empty.");
     }
-    return (0, random_1.getRandomInt)(0, array.length - 1, seedOrRNG, exceptions);
+    return getRandomInt(0, array.length - 1, seedOrRNG, exceptions);
 }
 /**
  * Similar to the `Array.includes` method, but works on a widened version of the array.
@@ -427,7 +384,7 @@ function getRandomArrayIndex(array, seedOrRNG, exceptions = []) {
  * This is useful when the normal `Array.includes` produces a type error from an array that uses an
  * `as const` assertion.
  */
-function includes(array, searchElement) {
+export function includes(array, searchElement) {
     const widenedArray = array;
     return widenedArray.includes(searchElement);
 }
@@ -442,8 +399,8 @@ function includes(array, searchElement) {
  * @param ensureContiguousValues Optional. Whether the Lua table has to have all contiguous keys in
  *                               order to be considered an array. Default is true.
  */
-function isArray(object, ensureContiguousValues = true) {
-    if (!(0, types_1.isTable)(object)) {
+export function isArray(object, ensureContiguousValues = true) {
+    if (!isTable(object)) {
         return false;
     }
     // First, if there is a metatable, this cannot be a simple array and must be a more complex
@@ -458,7 +415,7 @@ function isArray(object, ensureContiguousValues = true) {
         return true;
     }
     // Third, handle the case of non-numerical keys.
-    const hasAllNumberKeys = keys.every((key) => (0, types_1.isNumber)(key));
+    const hasAllNumberKeys = keys.every((key) => isNumber(key));
     if (!hasAllNumberKeys) {
         return false;
     }
@@ -478,7 +435,7 @@ function isArray(object, ensureContiguousValues = true) {
  *
  * For example, `[2, 3, 4]` would return true, and `[2, 3, 5]` would return false.
  */
-function isArrayContiguous(array) {
+export function isArrayContiguous(array) {
     let lastValue;
     for (const element of array) {
         lastValue ??= element - 1;
@@ -493,17 +450,17 @@ function isArrayContiguous(array) {
  *
  * Under the hood, this is performed by converting the array to a set.
  */
-function isArrayElementsUnique(array) {
+export function isArrayElementsUnique(array) {
     const set = new Set(array);
     return set.size === array.length;
 }
 /** Checks if an array is in the provided 2-dimensional array. */
-function isArrayInArray(arrayToMatch, parentArray) {
+export function isArrayInArray(arrayToMatch, parentArray) {
     return parentArray.some((element) => arrayEquals(element, arrayToMatch));
 }
 /** Helper function to set every element in an array to a specific value. */
 // eslint-disable-next-line complete/prefer-readonly-parameter-types
-function setAllArrayElements(array, value) {
+export function setAllArrayElements(array, value) {
     for (let i = 0; i < array.length; i++) {
         array[i] = value;
     }
@@ -521,7 +478,7 @@ function setAllArrayElements(array, value) {
  *                  `RNG.Next` method will be called. If `undefined` is provided, it will default to
  *                  a random seed.
  */
-function shuffleArray(originalArray, seedOrRNG) {
+export function shuffleArray(originalArray, seedOrRNG) {
     const array = copyArray(originalArray);
     shuffleArrayInPlace(array, seedOrRNG);
     return array;
@@ -539,11 +496,11 @@ function shuffleArray(originalArray, seedOrRNG) {
  *                  `RNG.Next` method will be called. If `undefined` is provided, it will default to
  *                  a random seed.
  */
-function shuffleArrayInPlace(
+export function shuffleArrayInPlace(
 // eslint-disable-next-line complete/prefer-readonly-parameter-types
 array, seedOrRNG) {
     let currentIndex = array.length;
-    const rng = (0, rng_1.isRNG)(seedOrRNG) ? seedOrRNG : (0, rng_1.newRNG)(seedOrRNG);
+    const rng = isRNG(seedOrRNG) ? seedOrRNG : newRNG(seedOrRNG);
     while (currentIndex > 0) {
         currentIndex--;
         const randomIndex = getRandomArrayIndex(array, rng);
@@ -551,13 +508,13 @@ array, seedOrRNG) {
     }
 }
 /** Helper function to sum every value in an array together. */
-function sumArray(array) {
+export function sumArray(array) {
     return array.reduce((accumulator, element) => accumulator + element, 0);
 }
 /**
  * Helper function to swap two different array elements. (The elements will be swapped in-place.)
  */
-function swapArrayElements(
+export function swapArrayElements(
 // eslint-disable-next-line complete/prefer-readonly-parameter-types
 array, i, j) {
     const value1 = array[i]; // eslint-disable-line @typescript-eslint/no-non-null-assertion
@@ -565,3 +522,17 @@ array, i, j) {
     array[i] = value2;
     array[j] = value1;
 }
+/** Mutates the `all` array in-place. */
+function addCombinations(n, src, got, 
+// eslint-disable-next-line complete/prefer-readonly-parameter-types
+all) {
+    if (n === 0) {
+        if (got.length > 0) {
+            all[all.length] = got;
+        }
+        return;
+    }
+    for (const [i, element] of src.entries()) {
+        addCombinations(n - 1, src.slice(i + 1), [...got, element], all);
+    }
+}

package/dist/functions/array.lua

@@ -3,16 +3,13 @@ local __TS__ArrayEvery = ____lualib.__TS__ArrayEvery
 local __TS__New = ____lualib.__TS__New
 local __TS__ArrayIndexOf = ____lualib.__TS__ArrayIndexOf
 local __TS__ArraySplice = ____lualib.__TS__ArraySplice
-local __TS__ArrayPushArray = ____lualib.__TS__ArrayPushArray
 local __TS__ArrayEntries = ____lualib.__TS__ArrayEntries
 local __TS__Iterator = ____lualib.__TS__Iterator
 local __TS__ArrayFilter = ____lualib.__TS__ArrayFilter
+local __TS__ArrayPushArray = ____lualib.__TS__ArrayPushArray
 local __TS__ArrayMap = ____lualib.__TS__ArrayMap
+local __TS__ArraySetLength = ____lualib.__TS__ArraySetLength
 local __TS__ArrayUnshift = ____lualib.__TS__ArrayUnshift
-local __TS__ArraySlice = ____lualib.__TS__ArraySlice
-local __TS__SparseArrayNew = ____lualib.__TS__SparseArrayNew
-local __TS__SparseArrayPush = ____lualib.__TS__SparseArrayPush
-local __TS__SparseArraySpread = ____lualib.__TS__SparseArraySpread
 local Set = ____lualib.Set
 local __TS__Spread = ____lualib.__TS__Spread
 local __TS__ArrayToSorted = ____lualib.__TS__ArrayToSorted
@@ -20,6 +17,10 @@ local __TS__ArrayIncludes = ____lualib.__TS__ArrayIncludes
 local __TS__ObjectKeys = ____lualib.__TS__ObjectKeys
 local __TS__ArraySome = ____lualib.__TS__ArraySome
 local __TS__ArrayReduce = ____lualib.__TS__ArrayReduce
+local __TS__ArraySlice = ____lualib.__TS__ArraySlice
+local __TS__SparseArrayNew = ____lualib.__TS__SparseArrayNew
+local __TS__SparseArrayPush = ____lualib.__TS__SparseArrayPush
+local __TS__SparseArraySpread = ____lualib.__TS__SparseArraySpread
 local ____exports = {}
 local addCombinations
 local ____ReadonlySet = require("types.ReadonlySet")
@@ -37,30 +38,6 @@ local isTable = ____types.isTable
 local ____utils = require("functions.utils")
 local assertDefined = ____utils.assertDefined
 local eRange = ____utils.eRange
-function addCombinations(self, n, src, got, all)
-    if n == 0 then
-        if #got > 0 then
-            all[#all + 1] = got
-        end
-        return
-    end
-    for ____, ____value in __TS__Iterator(__TS__ArrayEntries(src)) do
-        local i = ____value[1]
-        local element = ____value[2]
-        local ____addCombinations_3 = addCombinations
-        local ____temp_1 = n - 1
-        local ____TS__ArraySlice_result_2 = __TS__ArraySlice(src, i + 1)
-        local ____array_0 = __TS__SparseArrayNew(table.unpack(got))
-        __TS__SparseArrayPush(____array_0, element)
-        ____addCombinations_3(
-            nil,
-            ____temp_1,
-            ____TS__ArraySlice_result_2,
-            {__TS__SparseArraySpread(____array_0)},
-            all
-        )
-    end
-end
 --- Helper function to get a random index from the provided array.
 -- 
 -- If you want to get an unseeded index, you must explicitly pass `undefined` to the `seedOrRNG`
@@ -114,6 +91,30 @@ function ____exports.swapArrayElements(self, array, i, j)
     array[i + 1] = value2
     array[j + 1] = value1
 end
+function addCombinations(self, n, src, got, all)
+    if n == 0 then
+        if #got > 0 then
+            all[#all + 1] = got
+        end
+        return
+    end
+    for ____, ____value in __TS__Iterator(__TS__ArrayEntries(src)) do
+        local i = ____value[1]
+        local element = ____value[2]
+        local ____addCombinations_3 = addCombinations
+        local ____temp_1 = n - 1
+        local ____TS__ArraySlice_result_2 = __TS__ArraySlice(src, i + 1)
+        local ____array_0 = __TS__SparseArrayNew(table.unpack(got))
+        __TS__SparseArrayPush(____array_0, element)
+        ____addCombinations_3(
+            nil,
+            ____temp_1,
+            ____TS__ArraySlice_result_2,
+            {__TS__SparseArraySpread(____array_0)},
+            all
+        )
+    end
+end
 --- Helper function for determining if two arrays contain the exact same elements. Note that this
 -- only performs a shallow comparison.
 function ____exports.arrayEquals(self, array1, array2)
@@ -173,28 +174,6 @@ function ____exports.arrayRemoveAllInPlace(self, array, ...)
     end
     return removedOneOrMoreElements
 end
---- Removes the specified element(s) from the array. If the specified element(s) are not found in the
--- array, this function will do nothing.
--- 
--- This function is variadic, meaning that you can specify N arguments to remove N elements.
--- 
--- If there is more than one matching element in the array, this function will only remove the first
--- matching element. If you want to remove all of the elements, use the `arrayRemoveAllInPlace`
--- function instead.
--- 
--- @returns The removed elements. This will be an empty array if no elements were removed.
-function ____exports.arrayRemoveInPlace(self, array, ...)
-    local elementsToRemove = {...}
-    local removedElements = {}
-    for ____, element in ipairs(elementsToRemove) do
-        local index = __TS__ArrayIndexOf(array, element)
-        if index ~= -1 then
-            local removedElement = __TS__ArraySplice(array, index, 1)
-            __TS__ArrayPushArray(removedElements, removedElement)
-        end
-    end
-    return removedElements
-end
 --- Shallow copies and removes the elements at the specified indexes from the array. Returns the
 -- copied array. If the specified indexes are not found in the array, it will simply return a
 -- shallow copy of the array.
@@ -233,15 +212,41 @@ function ____exports.arrayRemoveIndexInPlace(self, array, ...)
     do
         local i = #array - 1
         while i >= 0 do
-            if legalIndexesSet:has(i) then
+            do
+                if not legalIndexesSet:has(i) then
+                    goto __continue22
+                end
                 local removedElement = __TS__ArraySplice(array, i, 1)
                 __TS__ArrayPushArray(removedElements, removedElement)
             end
+            ::__continue22::
             i = i - 1
         end
     end
     return removedElements
 end
+--- Removes the specified element(s) from the array. If the specified element(s) are not found in the
+-- array, this function will do nothing.
+-- 
+-- This function is variadic, meaning that you can specify N arguments to remove N elements.
+-- 
+-- If there is more than one matching element in the array, this function will only remove the first
+-- matching element. If you want to remove all of the elements, use the `arrayRemoveAllInPlace`
+-- function instead.
+-- 
+-- @returns The removed elements. This will be an empty array if no elements were removed.
+function ____exports.arrayRemoveInPlace(self, array, ...)
+    local elementsToRemove = {...}
+    local removedElements = {}
+    for ____, element in ipairs(elementsToRemove) do
+        local index = __TS__ArrayIndexOf(array, element)
+        if index ~= -1 then
+            local removedElement = __TS__ArraySplice(array, index, 1)
+            __TS__ArrayPushArray(removedElements, removedElement)
+        end
+    end
+    return removedElements
+end
 function ____exports.arrayToString(self, array)
     if #array == 0 then
         return "[]"
@@ -289,7 +294,7 @@ function ____exports.copyArray(self, oldArray, numElements)
 end
 --- Helper function to remove all of the elements in an array in-place.
 function ____exports.emptyArray(self, array)
-    __TS__ArraySplice(array, 0)
+    __TS__ArraySetLength(array, 0)
 end
 --- Helper function to perform a filter and a map at the same time. Similar to `Array.map`, provide a
 -- function that transforms a value, but return `undefined` if the value should be skipped. (Thus,

package/dist/functions/arrayLua.js

@@ -1,4 +1,3 @@
-"use strict";
 /**
  * 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.
@@ -8,21 +7,13 @@
  *
  * @module
  */
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.every = every;
-exports.filter = filter;
-exports.find = find;
-exports.forEach = forEach;
-exports.join = join;
-exports.map = map;
-exports.some = some;
 /**
  * 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`.
  */
-function every(array, func) {
+export function every(array, func) {
     return array.every(func);
 }
 /**
@@ -31,7 +22,7 @@ function every(array, func) {
  *
  * Internally, this just calls `Array.filter`.
  */
-function filter(array, func) {
+export function filter(array, func) {
     return array.filter(func);
 }
 /**
@@ -39,7 +30,7 @@ function filter(array, func) {
  *
  * Internally, this just calls `Array.find`.
  */
-function find(array, func) {
+export function find(array, func) {
     return array.find(func);
 }
 /**
@@ -47,8 +38,8 @@ function find(array, func) {
  *
  * Internally, this just calls `Array.forEach`.
  */
-function forEach(array, func) {
-    array.forEach(func); // eslint-disable-line unicorn/no-array-for-each
+export function forEach(array, func) {
+    array.forEach(func); // eslint-disable-line unicorn/no-for-each
 }
 // `includes` is not included since there is a normal array helper function of that name.
 /**
@@ -57,7 +48,7 @@ function forEach(array, func) {
  *
  * Internally, this just calls `Array.join`.
  */
-function join(array, separator) {
+export function join(array, separator) {
     return array.join(separator);
 }
 /**
@@ -66,7 +57,7 @@ function join(array, separator) {
  *
  * Internally, this just calls `Array.map`.
  */
-function map(array, func) {
+export function map(array, func) {
     return array.map(func);
 }
 /**
@@ -75,6 +66,6 @@ function map(array, func) {
  *
  * Internally, this just calls `Array.some`.
  */
-function some(array, func) {
+export function some(array, func) {
     return array.some(func);
 }