nhb-toolbox 1.1.3 → 1.1.4

package/dist/object/sanitize.d.ts

@@ -1,27 +1,34 @@
 import type { GenericObject, SanitizeOptions } from './types';
 /**
- * * Processes an object by ignoring specified keys and trimming string values based on options provided.
+ * * Sanitizes an object by ignoring specified keys and trimming string values based on options provided.
  * * Also excludes nullish values (null, undefined) if specified. Always ignores empty nested object(s).
  *
- * @param object - The object to process.
+ * @param object - The object to sanitize.
  * @param options - Options that define which keys to ignore, whether to trim string values, and whether to exclude nullish values.
  * @returns A new object with the specified modifications.
  */
-export declare function sanitizeData<T extends GenericObject>(object: T, options?: SanitizeOptions<T>): T;
+export declare function sanitizeData<T extends GenericObject>(object: T, options?: SanitizeOptions<T>): GenericObject;
 /**
- * * Processes an array of objects by ignoring specified keys and trimming string values based on options provided.
+ * * Sanitizes an array of objects by ignoring specified keys and trimming string values based on options provided.
  * * Also excludes nullish values (null, undefined) if specified. Always ignores empty nested object(s).
  *
- * @param object - The object to process.
+ * @param object - The object to sanitize.
  * @param options - Options that define which keys to ignore, whether to trim string values, and whether to exclude nullish values.
  * @returns A new array of objects with the specified modifications.
  */
-export declare function sanitizeData<T extends GenericObject>(array: T[], options?: SanitizeOptions<T>): T[];
+export declare function sanitizeData<T extends GenericObject>(array: T[], options?: SanitizeOptions<T>): GenericObject[];
 /**
- * * Trims all the words in a string or an array of strings.
+ * * Trims all the words in a string.
  *
- * @param input String or array of strings.
- * @returns Trimmed string or array of strings.
+ * @param input String to sanitize.
+ * @returns Sanitized string .
  */
-export declare function sanitizeData(input: string | string[]): string | string[];
+export declare function sanitizeData(input: string): string;
+/**
+ * * Trims all the words in an array of strings.
+ *
+ * @param input Array of strings to sanitize.
+ * @returns Sanitized array of strings.
+ */
+export declare function sanitizeData(input: string[]): string[];
 //# sourceMappingURL=sanitize.d.ts.map

package/dist/object/sanitize.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"sanitize.d.ts","sourceRoot":"","sources":["../../src/object/sanitize.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EAAkB,aAAa,EAAE,eAAe,EAAE,MAAM,SAAS,CAAC;AAE9E;;;;;;;GAOG;AACH,wBAAgB,YAAY,CAAC,CAAC,SAAS,aAAa,EACnD,MAAM,EAAE,CAAC,EACT,OAAO,CAAC,EAAE,eAAe,CAAC,CAAC,CAAC,GAC1B,CAAC,CAAC;AAEL;;;;;;;GAOG;AACH,wBAAgB,YAAY,CAAC,CAAC,SAAS,aAAa,EACnD,KAAK,EAAE,CAAC,EAAE,EACV,OAAO,CAAC,EAAE,eAAe,CAAC,CAAC,CAAC,GAC1B,CAAC,EAAE,CAAC;AAEP;;;;;GAKG;AACH,wBAAgB,YAAY,CAAC,KAAK,EAAE,MAAM,GAAG,MAAM,EAAE,GAAG,MAAM,GAAG,MAAM,EAAE,CAAC"}
+{"version":3,"file":"sanitize.d.ts","sourceRoot":"","sources":["../../src/object/sanitize.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EAAkB,aAAa,EAAE,eAAe,EAAE,MAAM,SAAS,CAAC;AAE9E;;;;;;;GAOG;AACH,wBAAgB,YAAY,CAAC,CAAC,SAAS,aAAa,EACnD,MAAM,EAAE,CAAC,EACT,OAAO,CAAC,EAAE,eAAe,CAAC,CAAC,CAAC,GAC1B,aAAa,CAAC;AAEjB;;;;;;;GAOG;AACH,wBAAgB,YAAY,CAAC,CAAC,SAAS,aAAa,EACnD,KAAK,EAAE,CAAC,EAAE,EACV,OAAO,CAAC,EAAE,eAAe,CAAC,CAAC,CAAC,GAC1B,aAAa,EAAE,CAAC;AAEnB;;;;;GAKG;AACH,wBAAgB,YAAY,CAAC,KAAK,EAAE,MAAM,GAAG,MAAM,CAAC;AAEpD;;;;;GAKG;AACH,wBAAgB,YAAY,CAAC,KAAK,EAAE,MAAM,EAAE,GAAG,MAAM,EAAE,CAAC"}

package/dist/object/sanitize.js

@@ -4,15 +4,15 @@ exports.sanitizeData = sanitizeData;
 const index_1 = require("./index");
 const string_1 = require("../string");
 /**
- * * Processes a string, array of strings, an object or array of objects by ignoring specified keys and trimming string values.
+ * * Sanitizes a string, array of strings, an object or array of objects by ignoring specified keys and trimming string values.
  * * Also excludes nullish values (null, undefined) if specified. Always ignores empty nested object(s).
  *
- * @param input - The object or array of objects to process.
+ * @param input - The string, object or array of strings or objects to sanitize.
  * @param options - Options for processing.
- * @returns A new string, array of strings, object or array of objects with the specified modifications.
+ * @returns A new string, object or array of strings or objects with the specified modifications.
  */
 function sanitizeData(input, options) {
-    const { ignoreKeys = [], trimStrings = true, ignoreNullish = false, } = options || {};
+    const { keysToIgnore: ignoreKeys = [], trimStrings = true, ignoreNullish = false, } = options || {};
     // Flatten the object keys and use the keys for comparison
     const ignoreKeySet = new Set(ignoreKeys);
     /**

package/dist/object/types.d.ts

@@ -7,7 +7,7 @@ export type DotNotationKey<T> = T extends object ? {
 /** - Options for `sanitizeData` */
 export interface SanitizeOptions<T extends GenericObject> {
     /** Keys to ignore */
-    ignoreKeys?: DotNotationKey<T>[];
+    keysToIgnore?: DotNotationKey<T>[];
     /** Whether to trim string values. Defaults to `true` */
     trimStrings?: boolean;
     /** Whether to exclude nullish (null or undefined) values. Defaults to `false` */

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

@@ -1 +1 @@
-{"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../../src/object/types.ts"],"names":[],"mappings":"AAAA,4BAA4B;AAC5B,MAAM,MAAM,aAAa,GAAG,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;AAEpD,yEAAyE;AACzE,MAAM,MAAM,cAAc,CAAC,CAAC,IAAI,CAAC,SAAS,MAAM,GAC7C;KACC,CAAC,IAAI,MAAM,CAAC,GAAG,MAAM,GAAG,CAAC,CAAC,CAAC,CAAC,SAAS,MAAM,GACzC,CAAC,GAAG,GAAG,CAAC,IAAI,cAAc,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,EAAE,GAClC,CAAC;CACJ,CAAC,MAAM,CAAC,GAAG,MAAM,CAAC,GAClB,KAAK,CAAC;AAET,mCAAmC;AACnC,MAAM,WAAW,eAAe,CAAC,CAAC,SAAS,aAAa;IACvD,qBAAqB;IACrB,UAAU,CAAC,EAAE,cAAc,CAAC,CAAC,CAAC,EAAE,CAAC;IACjC,wDAAwD;IACxD,WAAW,CAAC,EAAE,OAAO,CAAC;IACtB,iFAAiF;IACjF,aAAa,CAAC,EAAE,OAAO,CAAC;CACxB"}
+{"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../../src/object/types.ts"],"names":[],"mappings":"AAAA,4BAA4B;AAC5B,MAAM,MAAM,aAAa,GAAG,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;AAEpD,yEAAyE;AACzE,MAAM,MAAM,cAAc,CAAC,CAAC,IAAI,CAAC,SAAS,MAAM,GAC7C;KACC,CAAC,IAAI,MAAM,CAAC,GAAG,MAAM,GAAG,CAAC,CAAC,CAAC,CAAC,SAAS,MAAM,GACzC,CAAC,GAAG,GAAG,CAAC,IAAI,cAAc,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,EAAE,GAClC,CAAC;CACJ,CAAC,MAAM,CAAC,GAAG,MAAM,CAAC,GAClB,KAAK,CAAC;AAET,mCAAmC;AACnC,MAAM,WAAW,eAAe,CAAC,CAAC,SAAS,aAAa;IACvD,qBAAqB;IACrB,YAAY,CAAC,EAAE,cAAc,CAAC,CAAC,CAAC,EAAE,CAAC;IACnC,wDAAwD;IACxD,WAAW,CAAC,EAAE,OAAO,CAAC;IACtB,iFAAiF;IACjF,aAAa,CAAC,EAAE,OAAO,CAAC;CACxB"}

package/package.json

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