nhb-toolbox 0.9.1 → 0.9.2

package/dist/string/index.d.ts

@@ -1,4 +1,4 @@
-import type { CapitalizeOptions } from './types';
+import type { CapitalizeOptions, RandomIDOptions } from './types';
 /**
  * Utility to convert the first letter of any string to uppercase and the rest lowercase (unless specified).
  * Handles surrounding symbols like quotes or parentheses.
@@ -10,9 +10,17 @@ import type { CapitalizeOptions } from './types';
 export declare const capitalizeString: (string: string, options?: CapitalizeOptions) => string;
 /**
  * Utility to truncate a string to a specified length.
+ *
  * @param string The string to truncate.
  * @param maxLength The maximum length of the truncated string.
  * @returns Truncated string;
  */
 export declare const truncateString: (string: string, maxLength: number) => string;
+/**
+ * Generates a unique ID string composed of an optional `prefix`, `suffix`, a `timestamp`, `separator`, and a random alphanumeric string, separated by a customizable separator.
+ *
+ * @param options Configuration options for random ID generation.
+ * @returns The generated ID string composed of the prefix, timestamp, random alphanumeric string, and suffix, separated by the specified separator.
+ */
+export declare const generateRandomID: (options?: RandomIDOptions) => string;
 //# sourceMappingURL=index.d.ts.map

package/dist/string/index.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/string/index.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,iBAAiB,EAAE,MAAM,SAAS,CAAC;AAEjD;;;;;;;GAOG;AACH,eAAO,MAAM,gBAAgB,WACpB,MAAM,YACJ,iBAAiB,KACzB,MA0CF,CAAC;AAEF;;;;;GAKG;AACH,eAAO,MAAM,cAAc,WAAY,MAAM,aAAa,MAAM,KAAG,MAYlE,CAAC"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/string/index.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,iBAAiB,EAAE,eAAe,EAAE,MAAM,SAAS,CAAC;AAElE;;;;;;;GAOG;AACH,eAAO,MAAM,gBAAgB,WACpB,MAAM,YACJ,iBAAiB,KACzB,MA0CF,CAAC;AAEF;;;;;;GAMG;AACH,eAAO,MAAM,cAAc,WAAY,MAAM,aAAa,MAAM,KAAG,MAYlE,CAAC;AAEF;;;;;GAKG;AACH,eAAO,MAAM,gBAAgB,aAAc,eAAe,KAAG,MAkC5D,CAAC"}

package/dist/string/index.js

@@ -1,6 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.truncateString = exports.capitalizeString = void 0;
+exports.generateRandomID = exports.truncateString = exports.capitalizeString = void 0;
 /**
  * Utility to convert the first letter of any string to uppercase and the rest lowercase (unless specified).
  * Handles surrounding symbols like quotes or parentheses.
@@ -42,6 +42,7 @@ const capitalizeString = (string, options) => {
 exports.capitalizeString = capitalizeString;
 /**
  * Utility to truncate a string to a specified length.
+ *
  * @param string The string to truncate.
  * @param maxLength The maximum length of the truncated string.
  * @returns Truncated string;
@@ -59,3 +60,34 @@ const truncateString = (string, maxLength) => {
     return trimmedString.slice(0, maxLength).concat('...');
 };
 exports.truncateString = truncateString;
+/**
+ * Generates a unique ID string composed of an optional `prefix`, `suffix`, a `timestamp`, `separator`, and a random alphanumeric string, separated by a customizable separator.
+ *
+ * @param options Configuration options for random ID generation.
+ * @returns The generated ID string composed of the prefix, timestamp, random alphanumeric string, and suffix, separated by the specified separator.
+ */
+const generateRandomID = (options) => {
+    const { prefix = '', suffix = '', timeStamp = true, length = 13, separator = '.', caseOption = null, } = options || {};
+    // generate timestamp
+    const date = timeStamp ? Date.now() : '';
+    // Generate a random string of alphanumeric characters
+    const randomString = Array.from({ length }, () => Math.random().toString(36).slice(2, 3)).join('');
+    const ID = [
+        prefix && prefix.trim(),
+        date,
+        randomString,
+        suffix && suffix.trim(),
+    ]
+        .filter(Boolean)
+        .join(separator);
+    if (caseOption === 'upper') {
+        return ID.toUpperCase();
+    }
+    else if (caseOption === 'lower') {
+        return ID.toLowerCase();
+    }
+    else {
+        return ID;
+    }
+};
+exports.generateRandomID = generateRandomID;

package/dist/string/types.d.ts

@@ -1,3 +1,4 @@
+/** Options for capitalizeString function. */
 export interface CapitalizeOptions {
     /** If true, capitalizes the first letter of each word (space separated). Defaults to `false`. */
     capitalizeEachFirst?: boolean;
@@ -6,4 +7,19 @@ export interface CapitalizeOptions {
     /** If true, ensures that the rest of the string is lowercase. Defaults to `true`. */
     lowerCaseRest?: boolean;
 }
+/** Configuration options for ID generation. */
+export interface RandomIDOptions {
+    /** A string to prepend to the ID. Default is an empty string. */
+    prefix?: string;
+    /** A string to append to the ID. Default is an empty string.*/
+    suffix?: string;
+    /** Whether to include the current timestamp in the ID. Default is `true`. */
+    timeStamp?: boolean;
+    /** The length of the random alphanumeric string. Default is `13`. */
+    length?: number;
+    /** The separator to use between parts of the ID. Default is a `period (.)`. */
+    separator?: string;
+    /** Specifies the case for the random alphanumeric string. */
+    caseOption?: 'upper' | 'lower' | null;
+}
 //# sourceMappingURL=types.d.ts.map

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

@@ -1 +1 @@
-{"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../../src/string/types.ts"],"names":[],"mappings":"AAAA,MAAM,WAAW,iBAAiB;IACjC,iGAAiG;IACjG,mBAAmB,CAAC,EAAE,OAAO,CAAC;IAC9B,kFAAkF;IAClF,aAAa,CAAC,EAAE,OAAO,CAAC;IACxB,qFAAqF;IACrF,aAAa,CAAC,EAAE,OAAO,CAAC;CACxB"}
+{"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../../src/string/types.ts"],"names":[],"mappings":"AAAA,6CAA6C;AAC7C,MAAM,WAAW,iBAAiB;IACjC,iGAAiG;IACjG,mBAAmB,CAAC,EAAE,OAAO,CAAC;IAC9B,kFAAkF;IAClF,aAAa,CAAC,EAAE,OAAO,CAAC;IACxB,qFAAqF;IACrF,aAAa,CAAC,EAAE,OAAO,CAAC;CACxB;AAED,+CAA+C;AAC/C,MAAM,WAAW,eAAe;IAC/B,iEAAiE;IACjE,MAAM,CAAC,EAAE,MAAM,CAAC;IAEhB,+DAA+D;IAC/D,MAAM,CAAC,EAAE,MAAM,CAAC;IAEhB,6EAA6E;IAC7E,SAAS,CAAC,EAAE,OAAO,CAAC;IAEpB,qEAAqE;IACrE,MAAM,CAAC,EAAE,MAAM,CAAC;IAEhB,+EAA+E;IAC/E,SAAS,CAAC,EAAE,MAAM,CAAC;IAEnB,6DAA6D;IAC7D,UAAU,CAAC,EAAE,OAAO,GAAG,OAAO,GAAG,IAAI,CAAC;CACtC"}

package/package.json

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