@alextheman/utility 3.5.4 → 3.5.6

package/dist/index.cjs

@@ -46,6 +46,16 @@ var appendSemicolon_default = appendSemicolon;
 
 //#endregion
 //#region src/functions/arrayHelpers/fillArray.ts
+/**
+* Creates a new array where each element is the result of the provided callback.
+*
+* If the callback returns at least one Promise, the entire result will be wrapped
+* in a `Promise` and resolved with `Promise.all`. Otherwise, a plain array is returned.
+* @template ItemType
+* @param callback - A function invoked with the current index. May return a value or a Promise.
+* @param [length] - The desired length of the resulting array.
+* @returns An array of the callback results, or a Promise resolving to one if the callback is async.
+*/
 function fillArray(callback, length = 1) {
 	const outputArray = new Array(length).fill(null).map((_, index) => {
 		return callback(index);
@@ -59,6 +69,17 @@ var fillArray_default = fillArray;
 
 //#endregion
 //#region src/functions/arrayHelpers/paralleliseArrays.ts
+/**
+* Creates a new array of tuples, each containing the item at the given index from both arrays.
+*
+* If `secondArray` is shorter than `firstArray`, the second position in the tuple
+* will be `undefined`. Iteration always uses the length of the first array.
+* @template FirstArrayItem
+* @template SecondArrayItem
+* @param firstArray - The first array. Each item in this will take up the first tuple spot.
+* @param secondArray - The second array. Each item in this will take up the second tuple spot.
+* @returns An array of `[firstItem, secondItem]` tuples for each index in `firstArray`.
+*/
 function paralleliseArrays(firstArray, secondArray) {
 	const outputArray = [];
 	for (let i = 0; i < firstArray.length; i++) outputArray.push([firstArray[i], secondArray[i]]);
@@ -451,10 +472,12 @@ var APIError_default = APIError;
 var DataError = class extends Error {
 	data;
 	code;
-	/** @param data - The data that caused the error. */
-	/** @param message - A human-readable error message (e.g. The data provided is invalid). */
-	/** @param code - A standardised code (e.g. UNEXPECTED_DATA). */
-	/** @param options - Extra options to pass to super Error constructor. */
+	/**
+	* @param data - The data that caused the error.
+	* @param message  - A human-readable error message (e.g. The data provided is invalid).
+	* @param code - A standardised code (e.g. UNEXPECTED_DATA).
+	* @param options - Extra options to pass to super Error constructor.
+	*/
 	constructor(data, message = "The data provided is invalid", code = "INVALID_DATA", options) {
 		super(message, options);
 		if (Error.captureStackTrace) Error.captureStackTrace(this, new.target);

package/dist/index.d.cts

@@ -7,12 +7,43 @@ declare const NAMESPACE_EXPORT_REGEX = "export\\s+\\*\\s+from";
 declare function appendSemicolon(stringToAppendTo: string): string;
 //#endregion
 //#region src/functions/arrayHelpers/fillArray.d.ts
-declare function fillArray<T>(callback: (index: number) => Promise<T>, length?: number): Promise<T[]>;
-declare function fillArray<T>(callback: (index: number) => T, length?: number): T[];
+/**
+ * Creates a new array where each element is the resolved result of the provided asynchronous callback.
+ *
+ * The callback will be invoked once for each index from `0` to `length - 1`.
+ * If no length is provided, a single-element array will be produced.
+ * @template ItemType
+ * @param callback - An asynchronous function invoked with the current index.
+ * @param [length] - The desired length of the resulting array.
+ * @returns A Promise resolving to an array of the callback results.
+ */
+declare function fillArray<ItemType$1>(callback: (index: number) => Promise<ItemType$1>, length?: number): Promise<ItemType$1[]>;
+/**
+ * Creates a new array where each element is the result of the provided synchronous callback.
+ *
+ * The callback will be invoked once for each index from `0` to `length - 1`.
+ * If no length is provided, a single-element array will be produced.
+ * @template ItemType
+ * @param callback - A synchronous function invoked with the current index.
+ * @param [length] - The desired length of the resulting array.
+ * @returns An array of the callback results.
+ */
+declare function fillArray<ItemType$1>(callback: (index: number) => ItemType$1, length?: number): ItemType$1[];
 //#endregion
 //#region src/functions/arrayHelpers/paralleliseArrays.d.ts
 type ParallelTuple<A, B> = [A, B | undefined];
-declare function paralleliseArrays<FirstArrayItem, SecondArrayItem>(firstArray: FirstArrayItem[] | readonly FirstArrayItem[], secondArray: SecondArrayItem[] | readonly SecondArrayItem[]): ParallelTuple<FirstArrayItem, SecondArrayItem>[];
+/**
+ * Creates a new array of tuples, each containing the item at the given index from both arrays.
+ *
+ * If `secondArray` is shorter than `firstArray`, the second position in the tuple
+ * will be `undefined`. Iteration always uses the length of the first array.
+ * @template FirstArrayItem
+ * @template SecondArrayItem
+ * @param firstArray - The first array. Each item in this will take up the first tuple spot.
+ * @param secondArray - The second array. Each item in this will take up the second tuple spot.
+ * @returns An array of `[firstItem, secondItem]` tuples for each index in `firstArray`.
+ */
+declare function paralleliseArrays<FirstArrayItem, SecondArrayItem>(firstArray: readonly FirstArrayItem[], secondArray: readonly SecondArrayItem[]): ParallelTuple<FirstArrayItem, SecondArrayItem>[];
 //#endregion
 //#region src/functions/arrayHelpers/randomiseArray.d.ts
 declare function randomiseArray<T>(array: T[]): T[];
@@ -39,10 +70,12 @@ declare class APIError extends Error {
 declare class DataError extends Error {
   data: unknown;
   code: string;
-  /** @param data - The data that caused the error. */
-  /** @param message - A human-readable error message (e.g. The data provided is invalid). */
-  /** @param code - A standardised code (e.g. UNEXPECTED_DATA). */
-  /** @param options - Extra options to pass to super Error constructor. */
+  /**
+   * @param data - The data that caused the error.
+   * @param message  - A human-readable error message (e.g. The data provided is invalid).
+   * @param code - A standardised code (e.g. UNEXPECTED_DATA).
+   * @param options - Extra options to pass to super Error constructor.
+   */
   constructor(data: unknown, message?: string, code?: string, options?: ErrorOptions);
   static check(input: unknown): input is DataError;
 }
@@ -205,9 +238,16 @@ interface RemoveIndentsOptions {
   preserveTabs?: boolean;
 }
 type RemoveIndentsFunction = (strings: TemplateStringsArray, ...interpolations: unknown[]) => string;
-/** @deprecated This function has been renamed to normaliseIndents */
+/**
+ * @param options
+ * @deprecated This function has been renamed to normaliseIndents
+ */
 declare function removeIndents(options: RemoveIndentsOptions): RemoveIndentsFunction;
-/** @deprecated This function has been renamed to normaliseIndents */
+/**
+ * @param strings
+ * @param interpolations
+ * @deprecated This function has been renamed to normaliseIndents
+ */
 declare function removeIndents(strings: TemplateStringsArray, ...interpolations: unknown[]): string;
 //#endregion
 //#region src/functions/truncate.d.ts

package/dist/index.d.ts

@@ -7,12 +7,43 @@ declare const NAMESPACE_EXPORT_REGEX = "export\\s+\\*\\s+from";
 declare function appendSemicolon(stringToAppendTo: string): string;
 //#endregion
 //#region src/functions/arrayHelpers/fillArray.d.ts
-declare function fillArray<T>(callback: (index: number) => Promise<T>, length?: number): Promise<T[]>;
-declare function fillArray<T>(callback: (index: number) => T, length?: number): T[];
+/**
+ * Creates a new array where each element is the resolved result of the provided asynchronous callback.
+ *
+ * The callback will be invoked once for each index from `0` to `length - 1`.
+ * If no length is provided, a single-element array will be produced.
+ * @template ItemType
+ * @param callback - An asynchronous function invoked with the current index.
+ * @param [length] - The desired length of the resulting array.
+ * @returns A Promise resolving to an array of the callback results.
+ */
+declare function fillArray<ItemType$1>(callback: (index: number) => Promise<ItemType$1>, length?: number): Promise<ItemType$1[]>;
+/**
+ * Creates a new array where each element is the result of the provided synchronous callback.
+ *
+ * The callback will be invoked once for each index from `0` to `length - 1`.
+ * If no length is provided, a single-element array will be produced.
+ * @template ItemType
+ * @param callback - A synchronous function invoked with the current index.
+ * @param [length] - The desired length of the resulting array.
+ * @returns An array of the callback results.
+ */
+declare function fillArray<ItemType$1>(callback: (index: number) => ItemType$1, length?: number): ItemType$1[];
 //#endregion
 //#region src/functions/arrayHelpers/paralleliseArrays.d.ts
 type ParallelTuple<A, B> = [A, B | undefined];
-declare function paralleliseArrays<FirstArrayItem, SecondArrayItem>(firstArray: FirstArrayItem[] | readonly FirstArrayItem[], secondArray: SecondArrayItem[] | readonly SecondArrayItem[]): ParallelTuple<FirstArrayItem, SecondArrayItem>[];
+/**
+ * Creates a new array of tuples, each containing the item at the given index from both arrays.
+ *
+ * If `secondArray` is shorter than `firstArray`, the second position in the tuple
+ * will be `undefined`. Iteration always uses the length of the first array.
+ * @template FirstArrayItem
+ * @template SecondArrayItem
+ * @param firstArray - The first array. Each item in this will take up the first tuple spot.
+ * @param secondArray - The second array. Each item in this will take up the second tuple spot.
+ * @returns An array of `[firstItem, secondItem]` tuples for each index in `firstArray`.
+ */
+declare function paralleliseArrays<FirstArrayItem, SecondArrayItem>(firstArray: readonly FirstArrayItem[], secondArray: readonly SecondArrayItem[]): ParallelTuple<FirstArrayItem, SecondArrayItem>[];
 //#endregion
 //#region src/functions/arrayHelpers/randomiseArray.d.ts
 declare function randomiseArray<T>(array: T[]): T[];
@@ -39,10 +70,12 @@ declare class APIError extends Error {
 declare class DataError extends Error {
   data: unknown;
   code: string;
-  /** @param data - The data that caused the error. */
-  /** @param message - A human-readable error message (e.g. The data provided is invalid). */
-  /** @param code - A standardised code (e.g. UNEXPECTED_DATA). */
-  /** @param options - Extra options to pass to super Error constructor. */
+  /**
+   * @param data - The data that caused the error.
+   * @param message  - A human-readable error message (e.g. The data provided is invalid).
+   * @param code - A standardised code (e.g. UNEXPECTED_DATA).
+   * @param options - Extra options to pass to super Error constructor.
+   */
   constructor(data: unknown, message?: string, code?: string, options?: ErrorOptions);
   static check(input: unknown): input is DataError;
 }
@@ -205,9 +238,16 @@ interface RemoveIndentsOptions {
   preserveTabs?: boolean;
 }
 type RemoveIndentsFunction = (strings: TemplateStringsArray, ...interpolations: unknown[]) => string;
-/** @deprecated This function has been renamed to normaliseIndents */
+/**
+ * @param options
+ * @deprecated This function has been renamed to normaliseIndents
+ */
 declare function removeIndents(options: RemoveIndentsOptions): RemoveIndentsFunction;
-/** @deprecated This function has been renamed to normaliseIndents */
+/**
+ * @param strings
+ * @param interpolations
+ * @deprecated This function has been renamed to normaliseIndents
+ */
 declare function removeIndents(strings: TemplateStringsArray, ...interpolations: unknown[]): string;
 //#endregion
 //#region src/functions/truncate.d.ts

package/dist/index.js

@@ -17,6 +17,16 @@ var appendSemicolon_default = appendSemicolon;
 
 //#endregion
 //#region src/functions/arrayHelpers/fillArray.ts
+/**
+* Creates a new array where each element is the result of the provided callback.
+*
+* If the callback returns at least one Promise, the entire result will be wrapped
+* in a `Promise` and resolved with `Promise.all`. Otherwise, a plain array is returned.
+* @template ItemType
+* @param callback - A function invoked with the current index. May return a value or a Promise.
+* @param [length] - The desired length of the resulting array.
+* @returns An array of the callback results, or a Promise resolving to one if the callback is async.
+*/
 function fillArray(callback, length = 1) {
 	const outputArray = new Array(length).fill(null).map((_, index) => {
 		return callback(index);
@@ -30,6 +40,17 @@ var fillArray_default = fillArray;
 
 //#endregion
 //#region src/functions/arrayHelpers/paralleliseArrays.ts
+/**
+* Creates a new array of tuples, each containing the item at the given index from both arrays.
+*
+* If `secondArray` is shorter than `firstArray`, the second position in the tuple
+* will be `undefined`. Iteration always uses the length of the first array.
+* @template FirstArrayItem
+* @template SecondArrayItem
+* @param firstArray - The first array. Each item in this will take up the first tuple spot.
+* @param secondArray - The second array. Each item in this will take up the second tuple spot.
+* @returns An array of `[firstItem, secondItem]` tuples for each index in `firstArray`.
+*/
 function paralleliseArrays(firstArray, secondArray) {
 	const outputArray = [];
 	for (let i = 0; i < firstArray.length; i++) outputArray.push([firstArray[i], secondArray[i]]);
@@ -422,10 +443,12 @@ var APIError_default = APIError;
 var DataError = class extends Error {
 	data;
 	code;
-	/** @param data - The data that caused the error. */
-	/** @param message - A human-readable error message (e.g. The data provided is invalid). */
-	/** @param code - A standardised code (e.g. UNEXPECTED_DATA). */
-	/** @param options - Extra options to pass to super Error constructor. */
+	/**
+	* @param data - The data that caused the error.
+	* @param message  - A human-readable error message (e.g. The data provided is invalid).
+	* @param code - A standardised code (e.g. UNEXPECTED_DATA).
+	* @param options - Extra options to pass to super Error constructor.
+	*/
 	constructor(data, message = "The data provided is invalid", code = "INVALID_DATA", options) {
 		super(message, options);
 		if (Error.captureStackTrace) Error.captureStackTrace(this, new.target);

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@alextheman/utility",
-  "version": "3.5.4",
+  "version": "3.5.6",
   "description": "Helpful utility functions",
   "repository": {
     "type": "git",
@@ -19,14 +19,15 @@
     "zod": "^4.1.13"
   },
   "devDependencies": {
-    "@alextheman/eslint-plugin": "^4.3.0",
-    "@types/node": "^24.10.1",
+    "@alextheman/eslint-plugin": "^4.5.1",
+    "@types/node": "^25.0.1",
+    "dotenv-cli": "^11.0.0",
     "eslint": "^9.39.1",
     "globals": "^16.5.0",
     "husky": "^9.1.7",
-    "jsdom": "^27.2.0",
+    "jsdom": "^27.3.0",
     "prettier": "^3.7.4",
-    "tsdown": "^0.17.0",
+    "tsdown": "^0.17.3",
     "typescript": "^5.9.3",
     "vite-tsconfig-paths": "^5.1.4",
     "vitest": "^4.0.15"
@@ -48,10 +49,12 @@
     "lint-prettier-javascript": "prettier --check \"./**/*.js\"",
     "lint-prettier-typescript": "prettier --check --parser typescript \"./**/*.ts\"",
     "lint-tsc": "tsc --noEmit",
+    "prepare-live-eslint-plugin": "pnpm uninstall @alextheman/eslint-plugin && pnpm install --save-dev @alextheman/eslint-plugin",
+    "prepare-local-eslint-plugin": "dotenv -e .env -- sh -c 'ESLINT_PLUGIN_PATH=${LOCAL_ESLINT_PLUGIN_PATH:-../eslint-plugin}; pnpm --prefix \"$ESLINT_PLUGIN_PATH\" run build && pnpm uninstall @alextheman/eslint-plugin && pnpm install --save-dev file:\"$ESLINT_PLUGIN_PATH\"'",
     "test": "vitest run",
     "test-watch": "vitest",
     "update-dependencies": "pnpm update --latest && pnpm update",
-    "use-live-eslint-plugin": "pnpm uninstall @alextheman/eslint-plugin && pnpm install --save-dev @alextheman/eslint-plugin",
-    "use-local-eslint-plugin": "npm --prefix ../eslint-plugin run create-local-package && pnpm uninstall @alextheman/eslint-plugin && pnpm install --save-dev ../eslint-plugin/alextheman-eslint-plugin-*.tgz"
+    "use-live-eslint-plugin": "pnpm run prepare-live-eslint-plugin && pnpm run lint",
+    "use-local-eslint-plugin": "pnpm run prepare-local-eslint-plugin && pnpm run lint"
   }
 }