nhb-toolbox 3.1.1 → 3.1.3

package/dist/array/sort.d.ts

@@ -1,16 +1,22 @@
 import type { GenericObject } from '../object/types';
-import type { SortOptions } from './types';
+import type { OrderOption, SortByOption } from './types';
 /**
- * * Sorts an array of strings, numbers, booleans, or objects based on the provided options.
+ * * Sorts an array of objects.
  *
- * - If the array contains strings, it sorts them alphabetically.
- * - If the array contains numbers, it sorts them numerically.
- * - If the array contains booleans, it sorts them by their boolean value.
- * - If the array contains objects, it sorts them by the specified field in the options `sortByField`.
+ * - Sorts array by the specified field.
  *
- * @param array - The array to sort.
- * @param options - Sorting options for objects.
+ * @template T - The type of objects in the array.
+ * @param array - The array of objects to sort.
+ * @param options - Sorting options.
  * @returns The sorted array.
  */
-export declare function sortAnArray<T extends number | string | boolean | GenericObject>(array: T[], options?: SortOptions<T>): T[];
+export declare function sortAnArray<T extends GenericObject>(array: T[], options: SortByOption<T>): T[];
+/**
+ * * Sorts an array of `strings`, `numbers` or `boolean`.
+ *
+ * @param array - The array of `strings`, `numbers` or `boolean` to sort.
+ * @param options - Sorting options.
+ * @returns  The sorted array.
+ */
+export declare function sortAnArray<T extends string | number | boolean>(array: T[], options?: OrderOption): T[];
 //# sourceMappingURL=sort.d.ts.map

package/dist/array/sort.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"sort.d.ts","sourceRoot":"","sources":["../../src/array/sort.ts"],"names":[],"mappings":"AAMA,OAAO,KAAK,EAAE,aAAa,EAAE,MAAM,iBAAiB,CAAC;AACrD,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,SAAS,CAAC;AAE3C;;;;;;;;;;;GAWG;AACH,wBAAgB,WAAW,CAC1B,CAAC,SAAS,MAAM,GAAG,MAAM,GAAG,OAAO,GAAG,aAAa,EAClD,KAAK,EAAE,CAAC,EAAE,EAAE,OAAO,CAAC,EAAE,WAAW,CAAC,CAAC,CAAC,GAAG,CAAC,EAAE,CAyE3C"}
+{"version":3,"file":"sort.d.ts","sourceRoot":"","sources":["../../src/array/sort.ts"],"names":[],"mappings":"AAMA,OAAO,KAAK,EAAE,aAAa,EAAE,MAAM,iBAAiB,CAAC;AACrD,OAAO,KAAK,EAAE,WAAW,EAAE,YAAY,EAAe,MAAM,SAAS,CAAC;AAEtE;;;;;;;;;GASG;AACH,wBAAgB,WAAW,CAAC,CAAC,SAAS,aAAa,EAClD,KAAK,EAAE,CAAC,EAAE,EACV,OAAO,EAAE,YAAY,CAAC,CAAC,CAAC,GACtB,CAAC,EAAE,CAAC;AAEP;;;;;;GAMG;AACH,wBAAgB,WAAW,CAAC,CAAC,SAAS,MAAM,GAAG,MAAM,GAAG,OAAO,EAC9D,KAAK,EAAE,CAAC,EAAE,EACV,OAAO,CAAC,EAAE,WAAW,GACnB,CAAC,EAAE,CAAC"}

package/dist/array/sort.js

@@ -34,14 +34,13 @@ export function sortAnArray(array, options) {
     // Handle array of objects
     if (isArrayOfType(array, isObject) && options && 'sortByField' in options) {
         return [...array].sort((a, b) => {
-            // const key = options.sortByField as keyof T;
-            // const keyA = (a as T)[key];
-            // const keyB = (b as T)[key];
-            const getKeyValue = (obj, path) => path
-                .split('.')
-                .reduce((acc, key) => acc?.[key], obj);
-            const keyA = getKeyValue(a, options?.sortByField);
-            const keyB = getKeyValue(b, options?.sortByField);
+            const _getKeyValue = (obj, path) => {
+                return path
+                    .split('.')
+                    .reduce((acc, key) => acc?.[key], obj);
+            };
+            const keyA = _getKeyValue(a, options?.sortByField);
+            const keyB = _getKeyValue(b, options?.sortByField);
             if (keyA == null || keyB == null) {
                 return keyA == null ? 1 : -1;
             }

package/dist/array/types.d.ts

@@ -7,7 +7,7 @@ import type { PrimitiveKey } from '../types';
  *  */
 export type Flattened<T> = T extends (infer U)[] ? Flattened<U> : T;
 /**
- * - Configuration for `createOptionsArray`.
+ * * Configuration for `createOptionsArray`.
  * - Defines the mapping between keys in the input objects and the keys in the output options.
  *
  * @typeParam T - The type of the objects in the input array.
@@ -52,5 +52,6 @@ export interface SortByOption<T extends GenericObject> extends OrderOption {
     /** The field by which to sort the objects in the array. */
     sortByField: NestedPrimitiveKey<T>;
 }
+/** * Options for sorting array. */
 export type SortOptions<T> = T extends GenericObject ? SortByOption<T> : OrderOption;
 //# sourceMappingURL=types.d.ts.map

package/dist/array/types.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../../src/array/types.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,aAAa,EAAE,kBAAkB,EAAE,MAAM,iBAAiB,CAAC;AACzE,OAAO,KAAK,EAAE,YAAY,EAAE,MAAM,UAAU,CAAC;AAE7C;;;;MAIM;AACN,MAAM,MAAM,SAAS,CAAC,CAAC,IAAI,CAAC,SAAS,CAAC,MAAM,CAAC,CAAC,EAAE,GAAG,SAAS,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC;AAEpE;;;;;;;GAOG;AACH,MAAM,WAAW,aAAa,CAAC,CAAC,EAAE,EAAE,EAAE,EAAE;IACvC;;;OAGG;IACH,aAAa,EAAE,YAAY,CAAC,CAAC,CAAC,CAAC;IAE/B;;;OAGG;IACH,cAAc,EAAE,YAAY,CAAC,CAAC,CAAC,CAAC;IAEhC;;;;OAIG;IACH,cAAc,CAAC,EAAE,EAAE,CAAC;IAEpB;;;;OAIG;IACH,eAAe,CAAC,EAAE,EAAE,CAAC;CACrB;AAED,kCAAkC;AAClC,MAAM,WAAW,WAAW;IAC3B;;;;OAIG;IACH,SAAS,CAAC,EAAE,KAAK,GAAG,MAAM,CAAC;CAC3B;AAED,yEAAyE;AACzE,MAAM,WAAW,YAAY,CAAC,CAAC,SAAS,aAAa,CAAE,SAAQ,WAAW;IACzE,2DAA2D;IAC3D,WAAW,EAAE,kBAAkB,CAAC,CAAC,CAAC,CAAC;CACnC;AAED,MAAM,MAAM,WAAW,CAAC,CAAC,IACxB,CAAC,SAAS,aAAa,GAAG,YAAY,CAAC,CAAC,CAAC,GAAG,WAAW,CAAC"}
+{"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../../src/array/types.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,aAAa,EAAE,kBAAkB,EAAE,MAAM,iBAAiB,CAAC;AACzE,OAAO,KAAK,EAAE,YAAY,EAAE,MAAM,UAAU,CAAC;AAE7C;;;;MAIM;AACN,MAAM,MAAM,SAAS,CAAC,CAAC,IAAI,CAAC,SAAS,CAAC,MAAM,CAAC,CAAC,EAAE,GAAG,SAAS,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC;AAEpE;;;;;;;GAOG;AACH,MAAM,WAAW,aAAa,CAAC,CAAC,EAAE,EAAE,EAAE,EAAE;IACvC;;;OAGG;IACH,aAAa,EAAE,YAAY,CAAC,CAAC,CAAC,CAAC;IAE/B;;;OAGG;IACH,cAAc,EAAE,YAAY,CAAC,CAAC,CAAC,CAAC;IAEhC;;;;OAIG;IACH,cAAc,CAAC,EAAE,EAAE,CAAC;IAEpB;;;;OAIG;IACH,eAAe,CAAC,EAAE,EAAE,CAAC;CACrB;AAED,kCAAkC;AAClC,MAAM,WAAW,WAAW;IAC3B;;;;OAIG;IACH,SAAS,CAAC,EAAE,KAAK,GAAG,MAAM,CAAC;CAC3B;AAED,yEAAyE;AACzE,MAAM,WAAW,YAAY,CAAC,CAAC,SAAS,aAAa,CAAE,SAAQ,WAAW;IACzE,2DAA2D;IAC3D,WAAW,EAAE,kBAAkB,CAAC,CAAC,CAAC,CAAC;CACnC;AAED,mCAAmC;AACnC,MAAM,MAAM,WAAW,CAAC,CAAC,IACxB,CAAC,SAAS,aAAa,GAAG,YAAY,CAAC,CAAC,CAAC,GAAG,WAAW,CAAC"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "nhb-toolbox",
-  "version": "3.1.1",
+  "version": "3.1.3",
   "description": "A versatile collection of smart, efficient, and reusable utility functions for everyday development needs.",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",