@elyukai/utils 0.1.2

package/AUTHORS

@@ -0,0 +1 @@
+Lukas Obermann <lukas.obermann@icloud.com>

package/CHANGELOG.md

@@ -0,0 +1,46 @@
+# Changelog
+
+All notable changes to this project will be documented in this file. See [commit-and-tag-version](https://github.com/absolute-version/commit-and-tag-version) for commit guidelines.
+
+## [0.1.2](https://github.com/elyukai/ts-utils/compare/v0.1.1...v0.1.2) (2026-01-24)
+
+
+### Bug Fixes
+
+* slow types ([e16e7a8](https://github.com/elyukai/ts-utils/commit/e16e7a8092d0a9111744916e78799ac010b0175e))
+
+## [0.1.1](https://github.com/elyukai/ts-utils/compare/v0.1.0...v0.1.1) (2026-01-24)
+
+
+### Features
+
+* add function to identify duplicates in arrays ([8b49fff](https://github.com/elyukai/ts-utils/commit/8b49fffeaabe30dedb0015f2f94ae80737c4b210))
+
+## 0.1.0 (2026-01-24)
+
+
+### Features
+
+* add async wait function ([77ce70c](https://github.com/elyukai/ts-utils/commit/77ce70c5234d5181afb82b2a3cf558f9a8733ddc))
+* add classlist function ([cb552d2](https://github.com/elyukai/ts-utils/commit/cb552d26f5277e1ebc5358adbd1db0d8d6ea48c2))
+* add dictionary ([38b1af8](https://github.com/elyukai/ts-utils/commit/38b1af8c553e7ed7772e7b6eb2e7f6ff724016d7))
+* add functions for equality checks ([c86aa71](https://github.com/elyukai/ts-utils/commit/c86aa71dfab1be5ad03c69f72a6e2beb4546b28e))
+* add functions for ordering ([6ebe13b](https://github.com/elyukai/ts-utils/commit/6ebe13b74c3361ec5c21e50cc4c80e69826c839e))
+* add functions for working with arrays ([6cbd038](https://github.com/elyukai/ts-utils/commit/6cbd038f085f87faa4b56109de6ff136aeb35aef))
+* add functions for working with numbers ([8792558](https://github.com/elyukai/ts-utils/commit/8792558f9903f05e9e3688185d6cf63d343b9d85))
+* add lazy class ([edb27d2](https://github.com/elyukai/ts-utils/commit/edb27d29c9c7ab0b131f19f6cd40081b91c2a321))
+* add nullable functions ([010645f](https://github.com/elyukai/ts-utils/commit/010645ff66d74a094edebe4c5d7850d0d8d9b896))
+* add object functions ([67deaac](https://github.com/elyukai/ts-utils/commit/67deaac619227bee8d88137861c5104ea0f6f4d3))
+* add result and maybe types ([1b6987f](https://github.com/elyukai/ts-utils/commit/1b6987fdfa9e6e64eee55942cd75223d611b2753))
+* add roman numeral converter ([4dbc788](https://github.com/elyukai/ts-utils/commit/4dbc7888bfc851f1b18e6cf5393920acecbc1640))
+* add string functions ([5f4f190](https://github.com/elyukai/ts-utils/commit/5f4f190d73b7a2bb866726b995c4e8dc7159b968))
+* add string regex checks ([ba7cfe1](https://github.com/elyukai/ts-utils/commit/ba7cfe11c102e3169211a7f573744682c0bdc7e6))
+* add type safety functions ([5db4af4](https://github.com/elyukai/ts-utils/commit/5db4af4006d884c7bb4f92b851d51678492ce9a2))
+* functions for working with general functions and predicates ([f6fb48a](https://github.com/elyukai/ts-utils/commit/f6fb48a6e744dc74355630fccfddae522d894ae7))
+* functions for working with ranges ([e40d20f](https://github.com/elyukai/ts-utils/commit/e40d20f37554a32464ed1fbce86fe5fcdeb8077b))
+
+
+### Bug Fixes
+
+* slow types ([dcb096a](https://github.com/elyukai/ts-utils/commit/dcb096a5835ad07dbdb4c74bfcbdc9d97f51f329))
+* slow types ([261d56a](https://github.com/elyukai/ts-utils/commit/261d56abcb6ab35de6b92185dea0ddc4b6313500))

package/LICENSE

@@ -0,0 +1,373 @@
+Mozilla Public License Version 2.0
+==================================
+
+1. Definitions
+--------------
+
+1.1. "Contributor"
+    means each individual or legal entity that creates, contributes to
+    the creation of, or owns Covered Software.
+
+1.2. "Contributor Version"
+    means the combination of the Contributions of others (if any) used
+    by a Contributor and that particular Contributor's Contribution.
+
+1.3. "Contribution"
+    means Covered Software of a particular Contributor.
+
+1.4. "Covered Software"
+    means Source Code Form to which the initial Contributor has attached
+    the notice in Exhibit A, the Executable Form of such Source Code
+    Form, and Modifications of such Source Code Form, in each case
+    including portions thereof.
+
+1.5. "Incompatible With Secondary Licenses"
+    means
+
+    (a) that the initial Contributor has attached the notice described
+        in Exhibit B to the Covered Software; or
+
+    (b) that the Covered Software was made available under the terms of
+        version 1.1 or earlier of the License, but not also under the
+        terms of a Secondary License.
+
+1.6. "Executable Form"
+    means any form of the work other than Source Code Form.
+
+1.7. "Larger Work"
+    means a work that combines Covered Software with other material, in
+    a separate file or files, that is not Covered Software.
+
+1.8. "License"
+    means this document.
+
+1.9. "Licensable"
+    means having the right to grant, to the maximum extent possible,
+    whether at the time of the initial grant or subsequently, any and
+    all of the rights conveyed by this License.
+
+1.10. "Modifications"
+    means any of the following:
+
+    (a) any file in Source Code Form that results from an addition to,
+        deletion from, or modification of the contents of Covered
+        Software; or
+
+    (b) any new file in Source Code Form that contains any Covered
+        Software.
+
+1.11. "Patent Claims" of a Contributor
+    means any patent claim(s), including without limitation, method,
+    process, and apparatus claims, in any patent Licensable by such
+    Contributor that would be infringed, but for the grant of the
+    License, by the making, using, selling, offering for sale, having
+    made, import, or transfer of either its Contributions or its
+    Contributor Version.
+
+1.12. "Secondary License"
+    means either the GNU General Public License, Version 2.0, the GNU
+    Lesser General Public License, Version 2.1, the GNU Affero General
+    Public License, Version 3.0, or any later versions of those
+    licenses.
+
+1.13. "Source Code Form"
+    means the form of the work preferred for making modifications.
+
+1.14. "You" (or "Your")
+    means an individual or a legal entity exercising rights under this
+    License. For legal entities, "You" includes any entity that
+    controls, is controlled by, or is under common control with You. For
+    purposes of this definition, "control" means (a) the power, direct
+    or indirect, to cause the direction or management of such entity,
+    whether by contract or otherwise, or (b) ownership of more than
+    fifty percent (50%) of the outstanding shares or beneficial
+    ownership of such entity.
+
+2. License Grants and Conditions
+--------------------------------
+
+2.1. Grants
+
+Each Contributor hereby grants You a world-wide, royalty-free,
+non-exclusive license:
+
+(a) under intellectual property rights (other than patent or trademark)
+    Licensable by such Contributor to use, reproduce, make available,
+    modify, display, perform, distribute, and otherwise exploit its
+    Contributions, either on an unmodified basis, with Modifications, or
+    as part of a Larger Work; and
+
+(b) under Patent Claims of such Contributor to make, use, sell, offer
+    for sale, have made, import, and otherwise transfer either its
+    Contributions or its Contributor Version.
+
+2.2. Effective Date
+
+The licenses granted in Section 2.1 with respect to any Contribution
+become effective for each Contribution on the date the Contributor first
+distributes such Contribution.
+
+2.3. Limitations on Grant Scope
+
+The licenses granted in this Section 2 are the only rights granted under
+this License. No additional rights or licenses will be implied from the
+distribution or licensing of Covered Software under this License.
+Notwithstanding Section 2.1(b) above, no patent license is granted by a
+Contributor:
+
+(a) for any code that a Contributor has removed from Covered Software;
+    or
+
+(b) for infringements caused by: (i) Your and any other third party's
+    modifications of Covered Software, or (ii) the combination of its
+    Contributions with other software (except as part of its Contributor
+    Version); or
+
+(c) under Patent Claims infringed by Covered Software in the absence of
+    its Contributions.
+
+This License does not grant any rights in the trademarks, service marks,
+or logos of any Contributor (except as may be necessary to comply with
+the notice requirements in Section 3.4).
+
+2.4. Subsequent Licenses
+
+No Contributor makes additional grants as a result of Your choice to
+distribute the Covered Software under a subsequent version of this
+License (see Section 10.2) or under the terms of a Secondary License (if
+permitted under the terms of Section 3.3).
+
+2.5. Representation
+
+Each Contributor represents that the Contributor believes its
+Contributions are its original creation(s) or it has sufficient rights
+to grant the rights to its Contributions conveyed by this License.
+
+2.6. Fair Use
+
+This License is not intended to limit any rights You have under
+applicable copyright doctrines of fair use, fair dealing, or other
+equivalents.
+
+2.7. Conditions
+
+Sections 3.1, 3.2, 3.3, and 3.4 are conditions of the licenses granted
+in Section 2.1.
+
+3. Responsibilities
+-------------------
+
+3.1. Distribution of Source Form
+
+All distribution of Covered Software in Source Code Form, including any
+Modifications that You create or to which You contribute, must be under
+the terms of this License. You must inform recipients that the Source
+Code Form of the Covered Software is governed by the terms of this
+License, and how they can obtain a copy of this License. You may not
+attempt to alter or restrict the recipients' rights in the Source Code
+Form.
+
+3.2. Distribution of Executable Form
+
+If You distribute Covered Software in Executable Form then:
+
+(a) such Covered Software must also be made available in Source Code
+    Form, as described in Section 3.1, and You must inform recipients of
+    the Executable Form how they can obtain a copy of such Source Code
+    Form by reasonable means in a timely manner, at a charge no more
+    than the cost of distribution to the recipient; and
+
+(b) You may distribute such Executable Form under the terms of this
+    License, or sublicense it under different terms, provided that the
+    license for the Executable Form does not attempt to limit or alter
+    the recipients' rights in the Source Code Form under this License.
+
+3.3. Distribution of a Larger Work
+
+You may create and distribute a Larger Work under terms of Your choice,
+provided that You also comply with the requirements of this License for
+the Covered Software. If the Larger Work is a combination of Covered
+Software with a work governed by one or more Secondary Licenses, and the
+Covered Software is not Incompatible With Secondary Licenses, this
+License permits You to additionally distribute such Covered Software
+under the terms of such Secondary License(s), so that the recipient of
+the Larger Work may, at their option, further distribute the Covered
+Software under the terms of either this License or such Secondary
+License(s).
+
+3.4. Notices
+
+You may not remove or alter the substance of any license notices
+(including copyright notices, patent notices, disclaimers of warranty,
+or limitations of liability) contained within the Source Code Form of
+the Covered Software, except that You may alter any license notices to
+the extent required to remedy known factual inaccuracies.
+
+3.5. Application of Additional Terms
+
+You may choose to offer, and to charge a fee for, warranty, support,
+indemnity or liability obligations to one or more recipients of Covered
+Software. However, You may do so only on Your own behalf, and not on
+behalf of any Contributor. You must make it absolutely clear that any
+such warranty, support, indemnity, or liability obligation is offered by
+You alone, and You hereby agree to indemnify every Contributor for any
+liability incurred by such Contributor as a result of warranty, support,
+indemnity or liability terms You offer. You may include additional
+disclaimers of warranty and limitations of liability specific to any
+jurisdiction.
+
+4. Inability to Comply Due to Statute or Regulation
+---------------------------------------------------
+
+If it is impossible for You to comply with any of the terms of this
+License with respect to some or all of the Covered Software due to
+statute, judicial order, or regulation then You must: (a) comply with
+the terms of this License to the maximum extent possible; and (b)
+describe the limitations and the code they affect. Such description must
+be placed in a text file included with all distributions of the Covered
+Software under this License. Except to the extent prohibited by statute
+or regulation, such description must be sufficiently detailed for a
+recipient of ordinary skill to be able to understand it.
+
+5. Termination
+--------------
+
+5.1. The rights granted under this License will terminate automatically
+if You fail to comply with any of its terms. However, if You become
+compliant, then the rights granted under this License from a particular
+Contributor are reinstated (a) provisionally, unless and until such
+Contributor explicitly and finally terminates Your grants, and (b) on an
+ongoing basis, if such Contributor fails to notify You of the
+non-compliance by some reasonable means prior to 60 days after You have
+come back into compliance. Moreover, Your grants from a particular
+Contributor are reinstated on an ongoing basis if such Contributor
+notifies You of the non-compliance by some reasonable means, this is the
+first time You have received notice of non-compliance with this License
+from such Contributor, and You become compliant prior to 30 days after
+Your receipt of the notice.
+
+5.2. If You initiate litigation against any entity by asserting a patent
+infringement claim (excluding declaratory judgment actions,
+counter-claims, and cross-claims) alleging that a Contributor Version
+directly or indirectly infringes any patent, then the rights granted to
+You by any and all Contributors for the Covered Software under Section
+2.1 of this License shall terminate.
+
+5.3. In the event of termination under Sections 5.1 or 5.2 above, all
+end user license agreements (excluding distributors and resellers) which
+have been validly granted by You or Your distributors under this License
+prior to termination shall survive termination.
+
+************************************************************************
+*                                                                      *
+*  6. Disclaimer of Warranty                                           *
+*  -------------------------                                           *
+*                                                                      *
+*  Covered Software is provided under this License on an "as is"       *
+*  basis, without warranty of any kind, either expressed, implied, or  *
+*  statutory, including, without limitation, warranties that the       *
+*  Covered Software is free of defects, merchantable, fit for a        *
+*  particular purpose or non-infringing. The entire risk as to the     *
+*  quality and performance of the Covered Software is with You.        *
+*  Should any Covered Software prove defective in any respect, You     *
+*  (not any Contributor) assume the cost of any necessary servicing,   *
+*  repair, or correction. This disclaimer of warranty constitutes an   *
+*  essential part of this License. No use of any Covered Software is   *
+*  authorized under this License except under this disclaimer.         *
+*                                                                      *
+************************************************************************
+
+************************************************************************
+*                                                                      *
+*  7. Limitation of Liability                                          *
+*  --------------------------                                          *
+*                                                                      *
+*  Under no circumstances and under no legal theory, whether tort      *
+*  (including negligence), contract, or otherwise, shall any           *
+*  Contributor, or anyone who distributes Covered Software as          *
+*  permitted above, be liable to You for any direct, indirect,         *
+*  special, incidental, or consequential damages of any character      *
+*  including, without limitation, damages for lost profits, loss of    *
+*  goodwill, work stoppage, computer failure or malfunction, or any    *
+*  and all other commercial damages or losses, even if such party      *
+*  shall have been informed of the possibility of such damages. This   *
+*  limitation of liability shall not apply to liability for death or   *
+*  personal injury resulting from such party's negligence to the       *
+*  extent applicable law prohibits such limitation. Some               *
+*  jurisdictions do not allow the exclusion or limitation of           *
+*  incidental or consequential damages, so this exclusion and          *
+*  limitation may not apply to You.                                    *
+*                                                                      *
+************************************************************************
+
+8. Litigation
+-------------
+
+Any litigation relating to this License may be brought only in the
+courts of a jurisdiction where the defendant maintains its principal
+place of business and such litigation shall be governed by laws of that
+jurisdiction, without reference to its conflict-of-law provisions.
+Nothing in this Section shall prevent a party's ability to bring
+cross-claims or counter-claims.
+
+9. Miscellaneous
+----------------
+
+This License represents the complete agreement concerning the subject
+matter hereof. If any provision of this License is held to be
+unenforceable, such provision shall be reformed only to the extent
+necessary to make it enforceable. Any law or regulation which provides
+that the language of a contract shall be construed against the drafter
+shall not be used to construe this License against a Contributor.
+
+10. Versions of the License
+---------------------------
+
+10.1. New Versions
+
+Mozilla Foundation is the license steward. Except as provided in Section
+10.3, no one other than the license steward has the right to modify or
+publish new versions of this License. Each version will be given a
+distinguishing version number.
+
+10.2. Effect of New Versions
+
+You may distribute the Covered Software under the terms of the version
+of the License under which You originally received the Covered Software,
+or under the terms of any subsequent version published by the license
+steward.
+
+10.3. Modified Versions
+
+If you create software not governed by this License, and you want to
+create a new license for such software, you may create and use a
+modified version of this License if you rename the license and remove
+any references to the name of the license steward (except to note that
+such modified license differs from this License).
+
+10.4. Distributing Source Code Form that is Incompatible With Secondary
+Licenses
+
+If You choose to distribute Source Code Form that is Incompatible With
+Secondary Licenses under the terms of this version of the License, the
+notice described in Exhibit B of this License must be attached.
+
+Exhibit A - Source Code Form License Notice
+-------------------------------------------
+
+  This Source Code Form is subject to the terms of the Mozilla Public
+  License, v. 2.0. If a copy of the MPL was not distributed with this
+  file, You can obtain one at http://mozilla.org/MPL/2.0/.
+
+If it is not possible or desirable to put the notice in a particular
+file, then You may include the notice in a location (such as a LICENSE
+file in a relevant directory) where a recipient would be likely to look
+for such a notice.
+
+You may add additional accurate notices of copyright ownership.
+
+Exhibit B - "Incompatible With Secondary Licenses" Notice
+---------------------------------------------------------
+
+  This Source Code Form is "Incompatible With Secondary Licenses", as
+  defined by the Mozilla Public License, v. 2.0.

package/README.md

@@ -0,0 +1 @@
+# General TypeScript Helpers

package/dist/array/filters.d.ts

@@ -0,0 +1,14 @@
+/**
+ * Filters out duplicate values from an array. Objects are not supported, since
+ * they don’t provide value equality semantics.
+ */
+export declare const unique: <T extends number | boolean | string | symbol | null | undefined>(arr: T[]) => T[];
+/**
+ * Checks if there are any duplicate elements in the array.
+ */
+export declare const anySame: <T>(arr: T[], equalityCheck?: (a: T, b: T) => boolean) => boolean;
+/**
+ * Checks if there are any duplicate elements in the array and returns an array
+ * of found duplicates where the values are the indices of these values.
+ */
+export declare const anySameIndices: <T>(arr: T[], equalityCheck?: (a: T, b: T) => boolean) => number[][];

package/dist/array/filters.js

@@ -0,0 +1,24 @@
+/**
+ * Filters out duplicate values from an array. Objects are not supported, since
+ * they don’t provide value equality semantics.
+ */
+export const unique = (arr) => Array.from(new Set(arr));
+/**
+ * Checks if there are any duplicate elements in the array.
+ */
+export const anySame = (arr, equalityCheck = (a, b) => a === b) => arr.some((item, index) => arr.findIndex((other) => equalityCheck(item, other)) !== index);
+/**
+ * Checks if there are any duplicate elements in the array and returns an array
+ * of found duplicates where the values are the indices of these values.
+ */
+export const anySameIndices = (arr, equalityCheck = (a, b) => a === b) => arr.reduce((acc, item, index) => {
+    const firstIndex = arr.findIndex((other) => equalityCheck(item, other));
+    if (firstIndex === index) {
+        return acc;
+    }
+    const accIndex = acc.findIndex((accElem) => accElem[0] === firstIndex);
+    return accIndex === -1
+        ? [...acc, [firstIndex, index]]
+        : // eslint-disable-next-line @typescript-eslint/no-non-null-assertion -- The index must exist according to the findIndex above
+            acc.with(accIndex, [...acc[accIndex], index]);
+}, []);

package/dist/array/generators.d.ts

@@ -0,0 +1,9 @@
+/**
+ * Returns the possibilities of all the combinations of nested array values.
+ *
+ * @example
+ *
+ * flatCombine([["a", "b"], ["c"]]) // [["a", "c"], ["b", "c"]]
+ * flatCombine([["a", "b"], ["c", "d"]]) // [["a", "c"], ["b", "c"], ["a", "d"], ["b", "d"]]
+ */
+export declare const flatCombine: <T>(arr: T[][]) => T[][];

package/dist/array/generators.js

@@ -0,0 +1,13 @@
+/**
+ * Returns the possibilities of all the combinations of nested array values.
+ *
+ * @example
+ *
+ * flatCombine([["a", "b"], ["c"]]) // [["a", "c"], ["b", "c"]]
+ * flatCombine([["a", "b"], ["c", "d"]]) // [["a", "c"], ["b", "c"], ["a", "d"], ["b", "d"]]
+ */
+export const flatCombine = (arr) => arr.length === 0
+    ? []
+    : arr.slice(1).reduce((acc, elem) => elem.flatMap((elemInner) => acc.map((accElem) => [...accElem, elemInner])), 
+    // eslint-disable-next-line @typescript-eslint/no-non-null-assertion -- it is checked before if the array is empty
+    arr[0].map((elem) => [elem]));

package/dist/array/groups.d.ts

@@ -0,0 +1,24 @@
+import type { Equality } from "../equality.ts";
+/**
+ * Partitions an array into two arrays based on a predicate.
+ * @param arr The array to split.
+ * @param predicate The function to apply to each element in the array.
+ * @returns An array with two elements, the first one containing all elements
+ * that satisfy the predicate, the second one containing all elements that do
+ * not satisfy the predicate.
+ */
+export declare function partition<T, T1 extends T>(arr: T[], predicate: (value: T) => value is T1): [pos: T1[], neg: T[]];
+export declare function partition<T>(arr: T[], predicate: (value: T) => boolean): [pos: T[], neg: T[]];
+/**
+ * Returns a new array, where adjacent elements that are considered equal by the
+ * given equality function are grouped together. Calling the `flat` method on
+ * the result will return the original array.
+ */
+export declare const groupBy: <T>(arr: T[], equal: Equality<T>) => T[][];
+/**
+ * Splits an array into chunks of a specified size.
+ * @param arr The array to be chunked.
+ * @param size The size of each chunk.
+ * @returns An array of chunks, where each chunk is an array of elements. The last chunk may be smaller than the specified size if there are not enough elements left.
+ */
+export declare const chunk: <T>(arr: T[], size: number) => T[][];

package/dist/array/groups.js

@@ -0,0 +1,45 @@
+/**
+ * Partitions an array into two arrays based on a predicate.
+ * @param arr The array to split.
+ * @param predicate The function to apply to each element in the array.
+ * @returns An array with two elements, the first one containing all elements
+ * that satisfy the predicate, the second one containing all elements that do
+ * not satisfy the predicate.
+ */
+export function partition(arr, predicate) {
+    return arr.reduce((acc, value) => {
+        acc[predicate(value) ? 0 : 1].push(value);
+        return acc;
+    }, [[], []]);
+}
+/**
+ * Returns a new array, where adjacent elements that are considered equal by the
+ * given equality function are grouped together. Calling the `flat` method on
+ * the result will return the original array.
+ */
+export const groupBy = (arr, equal) => arr.reduce((acc, value) => {
+    const lastGroup = acc[acc.length - 1];
+    if (lastGroup?.[0] !== undefined && equal(lastGroup[0], value)) {
+        lastGroup.push(value);
+    }
+    else {
+        acc.push([value]);
+    }
+    return acc;
+}, []);
+/**
+ * Splits an array into chunks of a specified size.
+ * @param arr The array to be chunked.
+ * @param size The size of each chunk.
+ * @returns An array of chunks, where each chunk is an array of elements. The last chunk may be smaller than the specified size if there are not enough elements left.
+ */
+export const chunk = (arr, size) => {
+    if (size <= 0) {
+        throw new RangeError(`size must be a positive integer, got ${size.toString()}`);
+    }
+    return arr.reduce((chunks, item, index) => {
+        const chunkIndex = Math.floor(index / size);
+        (chunks[chunkIndex] ??= []).push(item);
+        return chunks;
+    }, []);
+};

package/dist/array/modify.d.ts

@@ -0,0 +1,21 @@
+/**
+ * Moves an element from one position to another within the array.
+ */
+export declare const reorder: <T>(arr: T[], sourceIndex: number, targetIndex: number) => T[];
+/**
+ * Returns a new array with all elements from the original array except for the
+ * given index.
+ *
+ * This function does not modify the original array.
+ *
+ * @throws {RangeError} Index is out of bounds.
+ */
+export declare const removeAt: <T>(arr: T[], index: number) => T[];
+/**
+ * Inserts an element at a given position in an array and returns a new array with the result of the operation.
+ *
+ * This function does not modify the original array. The index given can be a valid index in the current array or the length of the array to append the item at the end.
+ *
+ * @throws {RangeError} Index is out of bounds.
+ */
+export declare const insertAt: <T>(arr: T[], index: number, item: T) => T[];

package/dist/array/modify.js

@@ -0,0 +1,57 @@
+/**
+ * Moves an element from one position to another within the array.
+ */
+export const reorder = (arr, sourceIndex, targetIndex) => {
+    if (sourceIndex < 0 || sourceIndex >= arr.length) {
+        throw new RangeError(`source index ${sourceIndex.toString()} is out of bounds for array of length ${arr.length.toString()}`);
+    }
+    if (targetIndex < 0 || targetIndex >= arr.length) {
+        throw new RangeError(`target index ${targetIndex.toString()} is out of bounds for array of length ${arr.length.toString()}`);
+    }
+    if (sourceIndex === targetIndex) {
+        return arr;
+    }
+    if (sourceIndex < targetIndex) {
+        return [
+            ...arr.slice(0, sourceIndex),
+            ...arr.slice(sourceIndex + 1, targetIndex + 1),
+            // eslint-disable-next-line @typescript-eslint/no-non-null-assertion
+            arr[sourceIndex],
+            ...arr.slice(targetIndex + 1),
+        ];
+    }
+    return [
+        ...arr.slice(0, targetIndex),
+        // eslint-disable-next-line @typescript-eslint/no-non-null-assertion
+        arr[sourceIndex],
+        ...arr.slice(targetIndex, sourceIndex),
+        ...arr.slice(sourceIndex + 1),
+    ];
+};
+/**
+ * Returns a new array with all elements from the original array except for the
+ * given index.
+ *
+ * This function does not modify the original array.
+ *
+ * @throws {RangeError} Index is out of bounds.
+ */
+export const removeAt = (arr, index) => {
+    if (index < 0 || index >= arr.length) {
+        throw new RangeError(`index ${index.toString()} is out of bounds for array of length ${arr.length.toString()}`);
+    }
+    return [...arr.slice(0, index), ...arr.slice(index + 1)];
+};
+/**
+ * Inserts an element at a given position in an array and returns a new array with the result of the operation.
+ *
+ * This function does not modify the original array. The index given can be a valid index in the current array or the length of the array to append the item at the end.
+ *
+ * @throws {RangeError} Index is out of bounds.
+ */
+export const insertAt = (arr, index, item) => {
+    if (index < 0 || index > arr.length) {
+        throw new RangeError(`index ${index.toString()} is out of bounds for array of length ${arr.length.toString()}`);
+    }
+    return [...arr.slice(0, index), item, ...arr.slice(index)];
+};

package/dist/array/nonEmpty.d.ts

@@ -0,0 +1,23 @@
+/**
+ * Types and functions to check for non-empty arrays.
+ */
+/**
+ * The empty array type.
+ */
+export type EmptyArray = [];
+/**
+ * A type representing a non-empty array, i.e., an array with at least one element.
+ */
+export type NonEmptyArray<T> = [T, ...T[]];
+/**
+ * Checks if the array is empty.
+ */
+export declare const isEmpty: (arr: unknown[]) => arr is EmptyArray;
+/**
+ * Checks if the array is not empty, i.e., contains at least one element.
+ */
+export declare const isNotEmpty: <T>(arr: T[]) => arr is NonEmptyArray<T>;
+/**
+ * Returns `undefined` if the array is empty, otherwise the non-empty array.
+ */
+export declare const ensureNonEmpty: <T>(arr: T[]) => NonEmptyArray<T> | undefined;