@js-utils-kit/array 0.1.0

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2025 Sriman
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/dist/index.cjs

@@ -0,0 +1 @@
+function e(e,t=1){if(t<=0)throw RangeError(`chunk size must be greater than 0`);return Array.from({length:Math.ceil(e.length/t)},(n,r)=>e.slice(r*t,r*t+t))}function t(e){return e.filter(e=>!!e&&!Number.isNaN(e))}function n(e){return e.at(-1)}function r(e,{sort:t=!1,compareFn:n}={}){let r=[...new Set(e)];return t?n?r.sort(n):r.sort():r}exports.chunk=e,exports.compact=t,exports.lastElement=n,exports.unique=r;var i=require(`@js-utils-kit/types`);Object.keys(i).forEach(function(e){e!==`default`&&!Object.prototype.hasOwnProperty.call(exports,e)&&Object.defineProperty(exports,e,{enumerable:!0,get:function(){return i[e]}})});

package/dist/index.d.cts

@@ -0,0 +1,123 @@
+import { Falsy } from "@js-utils-kit/types";
+export * from "@js-utils-kit/types";
+
+//#region src/chunk.d.ts
+
+/**
+ * Splits an array into chunks of a specified size.
+ *
+ * @returns list of grouped chunks
+ *
+ * @example
+ * ```ts
+ * chunk([1, 2, 3, 4], 2);
+ * // [[1, 2], [3, 4]]
+ *
+ * chunk(['a', 'b', 'c'], 1);
+ * // [['a'], ['b'], ['c']]
+ * ```
+ */
+declare function chunk<T>(
+/**
+ * List of elements.
+ */
+array: readonly T[],
+/**
+ * Length of each chunk to group.
+ */
+size?: number): T[][];
+//#endregion
+//#region src/compact.d.ts
+/**
+ * Removes all falsy values from an array.
+ *
+ * Falsy values include: `false`, `null`, `0`, `""`, `undefined`, and `NaN`.
+ *
+ * @returns A new array with all falsy values removed
+ *
+ * @example
+ * ```ts
+ * compact([0, 1, false, 2, '', 3, null]);
+ * // [1, 2, 3]
+ *
+ * compact(['a', '', 'b', undefined]);
+ * // ['a', 'b']
+ * ```
+ */
+declare function compact<T>(
+/**
+ * A list of elements to compact
+ */
+array: readonly T[]): Exclude<T, Falsy>[];
+//#endregion
+//#region src/lastElement.d.ts
+/**
+ * Returns the last element of an array.
+ *
+ * @returns The last element, or `undefined` if the array is empty
+ *
+ * @example
+ * lastElement([1, 2, 3]);
+ * // 3
+ *
+ * lastElement([]);
+ * // undefined
+ */
+declare function lastElement<T>(
+/**
+ * A list of elements.
+ */
+array: readonly T[]): T | undefined;
+//#endregion
+//#region src/unique.d.ts
+/**
+ * Returns a new array with duplicate values removed.
+ *
+ * Uniqueness is determined using `Set`, meaning object uniqueness is based on reference equality.
+ *
+ * @example
+ * ```ts
+ * unique([3, 1, 2, 1]);
+ * // [3, 1, 2]
+ *
+ * unique([3, 1, 2, 1], { sort: true });
+ * // [1, 2, 3]
+ *
+ * const user1 = { id: 1, name: 'Alice' };
+ * const user2 = { id: 2, name: 'Bob' };
+ * const user3 = { id: 3, name: 'Charlie' };
+ * const users = [user3, user1, user2, user1];
+ *
+ * unique(users, {
+ *   sort: true,
+ *   compareFn: (a, b) => a.id - b.id,
+ * });
+ *
+ * // [
+ * //   { id: 1, name: 'Alice' },
+ * //   { id: 2, name: 'Bob' },
+ * //   { id: 3, name: 'Charlie' }
+ * // ]
+ * ```
+ */
+declare function unique<T>(
+/**
+ * The source array.
+ */
+array: readonly T[], {
+  sort,
+  compareFn
+}?: {
+  /**
+   * Whether to sort the result.
+   *
+   * @default false
+   */
+  sort?: boolean;
+  /**
+   * Custom compare function for sorting.
+   */
+  compareFn?: (a: T, b: T) => number;
+}): T[];
+//#endregion
+export { chunk, compact, lastElement, unique };

package/dist/index.d.mts

@@ -0,0 +1,123 @@
+import { Falsy } from "@js-utils-kit/types";
+export * from "@js-utils-kit/types";
+
+//#region src/chunk.d.ts
+
+/**
+ * Splits an array into chunks of a specified size.
+ *
+ * @returns list of grouped chunks
+ *
+ * @example
+ * ```ts
+ * chunk([1, 2, 3, 4], 2);
+ * // [[1, 2], [3, 4]]
+ *
+ * chunk(['a', 'b', 'c'], 1);
+ * // [['a'], ['b'], ['c']]
+ * ```
+ */
+declare function chunk<T>(
+/**
+ * List of elements.
+ */
+array: readonly T[],
+/**
+ * Length of each chunk to group.
+ */
+size?: number): T[][];
+//#endregion
+//#region src/compact.d.ts
+/**
+ * Removes all falsy values from an array.
+ *
+ * Falsy values include: `false`, `null`, `0`, `""`, `undefined`, and `NaN`.
+ *
+ * @returns A new array with all falsy values removed
+ *
+ * @example
+ * ```ts
+ * compact([0, 1, false, 2, '', 3, null]);
+ * // [1, 2, 3]
+ *
+ * compact(['a', '', 'b', undefined]);
+ * // ['a', 'b']
+ * ```
+ */
+declare function compact<T>(
+/**
+ * A list of elements to compact
+ */
+array: readonly T[]): Exclude<T, Falsy>[];
+//#endregion
+//#region src/lastElement.d.ts
+/**
+ * Returns the last element of an array.
+ *
+ * @returns The last element, or `undefined` if the array is empty
+ *
+ * @example
+ * lastElement([1, 2, 3]);
+ * // 3
+ *
+ * lastElement([]);
+ * // undefined
+ */
+declare function lastElement<T>(
+/**
+ * A list of elements.
+ */
+array: readonly T[]): T | undefined;
+//#endregion
+//#region src/unique.d.ts
+/**
+ * Returns a new array with duplicate values removed.
+ *
+ * Uniqueness is determined using `Set`, meaning object uniqueness is based on reference equality.
+ *
+ * @example
+ * ```ts
+ * unique([3, 1, 2, 1]);
+ * // [3, 1, 2]
+ *
+ * unique([3, 1, 2, 1], { sort: true });
+ * // [1, 2, 3]
+ *
+ * const user1 = { id: 1, name: 'Alice' };
+ * const user2 = { id: 2, name: 'Bob' };
+ * const user3 = { id: 3, name: 'Charlie' };
+ * const users = [user3, user1, user2, user1];
+ *
+ * unique(users, {
+ *   sort: true,
+ *   compareFn: (a, b) => a.id - b.id,
+ * });
+ *
+ * // [
+ * //   { id: 1, name: 'Alice' },
+ * //   { id: 2, name: 'Bob' },
+ * //   { id: 3, name: 'Charlie' }
+ * // ]
+ * ```
+ */
+declare function unique<T>(
+/**
+ * The source array.
+ */
+array: readonly T[], {
+  sort,
+  compareFn
+}?: {
+  /**
+   * Whether to sort the result.
+   *
+   * @default false
+   */
+  sort?: boolean;
+  /**
+   * Custom compare function for sorting.
+   */
+  compareFn?: (a: T, b: T) => number;
+}): T[];
+//#endregion
+export { chunk, compact, lastElement, unique };

package/dist/index.mjs

@@ -0,0 +1 @@
+export*from"@js-utils-kit/types";function e(e,t=1){if(t<=0)throw RangeError(`chunk size must be greater than 0`);return Array.from({length:Math.ceil(e.length/t)},(n,r)=>e.slice(r*t,r*t+t))}function t(e){return e.filter(e=>!!e&&!Number.isNaN(e))}function n(e){return e.at(-1)}function r(e,{sort:t=!1,compareFn:n}={}){let r=[...new Set(e)];return t?n?r.sort(n):r.sort():r}export{e as chunk,t as compact,n as lastElement,r as unique};

package/package.json

@@ -0,0 +1,44 @@
+{
+  "name": "@js-utils-kit/array",
+  "version": "0.1.0",
+  "description": "Array utilities",
+  "private": false,
+  "license": "MIT",
+  "author": {
+    "name": "Sriman",
+    "email": "136729116+TenEplaysOfficial@users.noreply.github.com",
+    "url": "https://tene.vercel.app"
+  },
+  "homepage": "https://js-utils.js.org",
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/teneplaysofficial/js-utils-kit",
+    "directory": "packages/array"
+  },
+  "bugs": {
+    "url": "https://github.com/teneplaysofficial/js-utils-kit/issues"
+  },
+  "files": [
+    "dist"
+  ],
+  "engines": {
+    "node": ">=22"
+  },
+  "type": "module",
+  "main": "./dist/index.cjs",
+  "module": "./dist/index.mjs",
+  "types": "./dist/index.d.cts",
+  "exports": {
+    ".": {
+      "require": "./dist/index.cjs",
+      "import": "./dist/index.mjs"
+    }
+  },
+  "dependencies": {
+    "@js-utils-kit/types": "1.1.0"
+  },
+  "scripts": {
+    "build": "tsdown",
+    "test": "vitest run"
+  }
+}