@bemoje/array 0.3.2 → 1.0.0

package/README.md

@@ -1,34 +1,3 @@
-# @bemoje/array
+# @mono/array
 
-
-
-![npm (scoped)](https://img.shields.io/npm/v/%40bemoje/trie-map)
-![npm bundle size (scoped)](https://img.shields.io/bundlephobia/minzip/%40bemoje/array)
-![npm](https://img.shields.io/npm/dt/%40bemoje/array)
-![NPM](https://img.shields.io/npm/l/%40bemoje%2Farray)
-
-![GitHub last commit (by committer)](https://img.shields.io/github/last-commit/bemoje/tsmono)
-![GitHub closed pull requests](https://img.shields.io/github/issues-pr-closed/bemoje/tsmono)
-![GitHub top language](https://img.shields.io/github/languages/top/bemoje/tsmono)
-
-
-## Documentation
-[Documentation Website](https://bemoje.github.io/tsmono/modules/array.html)
-
-## Installation
-This library is published in the NPM registry and can be installed using any compatible package manager.
-
-#### NPM
-```sh
-npm install @bemoje/array
-```
-
-
-## Issues
-Please let me know of any bugs or [issues](https://github.com/bemoje/tsmono/issues).
-
-## Contribute
-Contributors are welcome to open a [pull request](https://github.com/bemoje/tsmono/pulls).
-
-## License
-Released under the [undefined License](./LICENSE).
+Array manipulation and table processing utilities.

package/{cjs/lib → dist}/arrAverage.d.ts

@@ -10,4 +10,3 @@
  * ```
  */
 export declare function arrAverage(array: number[]): number;
-//# sourceMappingURL=arrAverage.d.ts.map

package/{cjs/lib → dist}/arrEachToString.d.ts

@@ -10,4 +10,3 @@
  * ```
  */
 export declare function arrEachToString<T>(array: T[]): string[];
-//# sourceMappingURL=arrEachToString.d.ts.map

package/{cjs/lib → dist}/arrFindIndicesOf.d.ts

@@ -5,4 +5,3 @@
  * @returns An array of indices where the predicate function returns true.
  */
 export declare function arrFindIndicesOf<T>(input: Array<T>, predicate: (value: T) => boolean): number[];
-//# sourceMappingURL=arrFindIndicesOf.d.ts.map

package/dist/arrGetOrDefault.d.ts

@@ -0,0 +1,4 @@
+/**
+ * Get array element at index or create it using factory function if it doesn't exist.
+ */
+export declare function arrGetOrDefault<V>(array: V[], index: number, factory: (index: number) => V): V;

package/{cjs/lib → dist}/arrHasDuplicates.d.ts

@@ -5,4 +5,3 @@
  * @typeParam T - The type of elements in the array.
  */
 export declare function arrHasDuplicates<T>(arr: T[]): boolean;
-//# sourceMappingURL=arrHasDuplicates.d.ts.map

package/{cjs/lib → dist}/arrIndicesOf.d.ts

@@ -12,4 +12,3 @@
  *  ```
  */
 export declare function arrIndicesOf<T>(input: Array<T>, element: T): number[];
-//# sourceMappingURL=arrIndicesOf.d.ts.map

package/{cjs/lib → dist}/arrLast.d.ts

@@ -10,4 +10,3 @@
  * //=> 5
  */
 export declare function arrLast<T>(array: T[]): T;
-//# sourceMappingURL=arrLast.d.ts.map

package/{cjs/lib → dist}/arrMapMutable.d.ts

@@ -1,4 +1,3 @@
-import { ArrayValueCallback } from './types/ArrayValueCallback';
 /**
  * This function takes an array and a callback function as arguments. It applies the callback function to each element of the array, mutating the original array in the process.
  * @template T The type of elements in the input array.
@@ -6,9 +5,8 @@ import { ArrayValueCallback } from './types/ArrayValueCallback';
  * @param f The callback function to be applied to each element of the array. This function takes three arguments: the current element, its index, and the original array.
  * @returns The original array, mutated by the callback function.
  * @example ```ts
- * arrMapMutable([1, 2, 3], (value: number) => value * 2);;
+ * arrMapMutable([1, 2, 3], (value: number) => value * 2);
  * //=> [2, 4, 6]
  * ```
  */
-export declare function arrMapMutable<T>(input: Array<T>, f: ArrayValueCallback<T>): Array<T>;
-//# sourceMappingURL=arrMapMutable.d.ts.map
+export declare function arrMapMutable<T>(input: Array<T>, f: (value: T, index: number, array: T[]) => T): Array<T>;

package/{cjs/lib → dist}/arrObjectsToTable.d.ts

@@ -20,4 +20,3 @@ export declare function arrObjectsToTable<T, E>(objects: Record<string, T | unde
     headers?: string[];
     emptyCell?: E;
 }): Array<Array<string | T | E>>;
-//# sourceMappingURL=arrObjectsToTable.d.ts.map

package/{cjs/lib → dist}/arrObjectsUniqueKeys.d.ts

@@ -14,4 +14,3 @@
  * ```
  */
 export declare function arrObjectsUniqueKeys<T>(objects: Record<string, T>[]): string[];
-//# sourceMappingURL=arrObjectsUniqueKeys.d.ts.map

package/dist/arrRemove.d.ts

@@ -0,0 +1,4 @@
+/**
+ * Remove a given element from a copy of a given array and return the resulting array.
+ */
+export declare function arrRemove<T>(arr: T[], elementToRemove: T): T[];

package/{cjs/lib → dist}/arrRemoveDuplicates.d.ts

@@ -11,4 +11,3 @@
  * ```
  */
 export declare function arrRemoveDuplicates<T>(array: T[]): T[];
-//# sourceMappingURL=arrRemoveDuplicates.d.ts.map

package/dist/arrRemoveMutable.d.ts

@@ -0,0 +1,4 @@
+/**
+ * Remove elements in-place from an array.
+ */
+export declare function arrRemoveMutable<T>(arr: T[], elementToRemove: T): void;

package/{cjs/lib → dist}/arrShuffle.d.ts

@@ -11,4 +11,3 @@
  * ```
  */
 export declare function arrShuffle<T>(input: Array<T>): Array<T>;
-//# sourceMappingURL=arrShuffle.d.ts.map

package/{cjs/lib → dist}/arrSortNumeric.d.ts

@@ -12,4 +12,3 @@
  * ```
  */
 export declare function arrSortNumeric(input: Array<number | bigint | boolean>): Array<number | bigint | boolean>;
-//# sourceMappingURL=arrSortNumeric.d.ts.map

package/{cjs/lib → dist}/arrSortedInsertionIndex.d.ts

@@ -14,4 +14,3 @@
  * ```
  */
 export declare function arrSortedInsertionIndex<T>(array: readonly T[], value: T, comparator: (a: T, b: T) => number): number;
-//# sourceMappingURL=arrSortedInsertionIndex.d.ts.map

package/{cjs/lib → dist}/arrSum.d.ts

@@ -9,4 +9,3 @@
  * ```
  */
 export declare function arrSum(array: number[]): number;
-//# sourceMappingURL=arrSum.d.ts.map

package/{cjs/lib → dist}/arrSwap.d.ts

@@ -12,4 +12,3 @@
  * ```
  */
 export declare function arrSwap<T>(input: Array<T>, from: number, to: number): Array<T>;
-//# sourceMappingURL=arrSwap.d.ts.map

package/{cjs/lib → dist}/arrTableAssertRowsSameLength.d.ts

@@ -23,4 +23,3 @@
  *  ```
  */
 export declare function arrTableAssertRowsSameLength<T>(rows: T[][], headers?: string[]): void;
-//# sourceMappingURL=arrTableAssertRowsSameLength.d.ts.map

package/{cjs/lib → dist}/arrTableEachToString.d.ts

@@ -10,4 +10,3 @@
  * ```
  */
 export declare function arrTableEachToString<T>(table: T[][]): string[][];
-//# sourceMappingURL=arrTableEachToString.d.ts.map

package/dist/arrTableIterateAsObjects.d.ts

@@ -0,0 +1,4 @@
+/**
+ * Generator that iterates through a 2D array table, yielding objects with header keys and row values.
+ */
+export declare function arrTableIterateAsObjects<T>(rows: T[][], headers: string[], ignoreHeaders?: Set<string>): Generator<Record<string, T>, void, unknown>;

package/{cjs/lib → dist}/arrTableRemoveColumns.d.ts

@@ -5,4 +5,3 @@
  * @returns A new 2D array (table) with the specified columns removed.
  */
 export declare function arrTableRemoveColumns(table: string[][], ...removeColumnNames: string[]): string[][];
-//# sourceMappingURL=arrTableRemoveColumns.d.ts.map

package/{cjs/lib → dist}/arrTableToCsv.d.ts

@@ -18,4 +18,3 @@
  * ```
  */
 export declare function arrTableToCsv<T>(input: T[][], delimiter?: string, replaceLinebreakWith?: string): string;
-//# sourceMappingURL=arrTableToCsv.d.ts.map

package/{cjs/lib → dist}/arrTableToObjects.d.ts

@@ -20,4 +20,3 @@
  * ```
  */
 export declare function arrTableToObjects<T>(rows: T[][], headers?: string[], ignoreKeys?: Set<string>): Record<string, T>[];
-//# sourceMappingURL=arrTableToObjects.d.ts.map

package/dist/arrayToString.d.ts

@@ -0,0 +1,4 @@
+/**
+ * Short and condensed string representation of an array, easy to read for error outputs or similar.
+ */
+export declare function arrayToString<T>(array: T[]): string;

package/dist/index.d.ts

@@ -0,0 +1,56 @@
+export * from './arrAverage';
+export * from './arrEachToString';
+export * from './arrFindIndicesOf';
+export * from './arrGetOrDefault';
+export * from './arrHasDuplicates';
+export * from './arrIndicesOf';
+export * from './arrLast';
+export * from './arrMapMutable';
+export * from './arrObjectsToTable';
+export * from './arrObjectsUniqueKeys';
+export * from './arrRemove';
+export * from './arrRemoveDuplicates';
+export * from './arrRemoveMutable';
+export * from './arrShuffle';
+export * from './arrSortNumeric';
+export * from './arrSortedInsertionIndex';
+export * from './arrSum';
+export * from './arrSwap';
+export * from './arrTableAssertRowsSameLength';
+export * from './arrTableEachToString';
+export * from './arrTableIterateAsObjects';
+export * from './arrTableRemoveColumns';
+export * from './arrTableToCsv';
+export * from './arrTableToObjects';
+export * from './arrayToString';
+declare const _default: {
+    arrayToString<T>(array: T[]): string;
+    arrTableToObjects<T>(rows: T[][], headers?: string[], ignoreKeys?: Set<string>): Record<string, T>[];
+    arrTableToCsv<T>(input: T[][], delimiter?: string, replaceLinebreakWith?: string): string;
+    arrTableRemoveColumns(table: string[][], ...removeColumnNames: string[]): string[][];
+    arrTableIterateAsObjects<T>(rows: T[][], headers: string[], ignoreHeaders?: Set<string>): Generator<Record<string, T>, void, unknown>;
+    arrTableEachToString<T>(table: T[][]): string[][];
+    arrTableAssertRowsSameLength<T>(rows: T[][], headers?: string[]): void;
+    arrSwap<T>(input: Array<T>, from: number, to: number): Array<T>;
+    arrSum(array: number[]): number;
+    arrSortedInsertionIndex<T>(array: readonly T[], value: T, comparator: (a: T, b: T) => number): number;
+    arrSortNumeric(input: Array<number | bigint | boolean>): Array<number | bigint | boolean>;
+    arrShuffle<T>(input: Array<T>): Array<T>;
+    arrRemoveMutable<T>(arr: T[], elementToRemove: T): void;
+    arrRemoveDuplicates<T>(array: T[]): T[];
+    arrRemove<T>(arr: T[], elementToRemove: T): T[];
+    arrObjectsUniqueKeys<T>(objects: Record<string, T>[]): string[];
+    arrObjectsToTable<T, E>(objects: Record<string, T | undefined>[], options?: {
+        headers?: string[];
+        emptyCell?: E;
+    }): Array<Array<string | T | E>>;
+    arrMapMutable<T>(input: Array<T>, f: (value: T, index: number, array: T[]) => T): Array<T>;
+    arrLast<T>(array: T[]): T;
+    arrIndicesOf<T>(input: Array<T>, element: T): number[];
+    arrHasDuplicates<T>(arr: T[]): boolean;
+    arrGetOrDefault<V>(array: V[], index: number, factory: (index: number) => V): V;
+    arrFindIndicesOf<T>(input: Array<T>, predicate: (value: T) => boolean): number[];
+    arrEachToString<T>(array: T[]): string[];
+    arrAverage(array: number[]): number;
+};
+export default _default;