nhb-toolbox 0.8.9 → 0.9.1

package/dist/string/index.d.ts

@@ -8,4 +8,11 @@ import type { CapitalizeOptions } from './types';
  * @returns Capitalized string.
  */
 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;
 //# 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,YACL,iBAAiB,KAKxB,MA2CF,CAAC"}
+{"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"}

package/dist/string/index.js

@@ -1,6 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.capitalizeString = void 0;
+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.
@@ -9,19 +9,13 @@ exports.capitalizeString = void 0;
  * @param options Options to customize the capitalization.
  * @returns Capitalized string.
  */
-const capitalizeString = (string, options = {
-    capitalizeAll: false,
-    capitalizeEachFirst: false,
-    lowerCaseRest: true,
-}) => {
-    if (typeof string !== 'string' || !string.trim())
-        return '';
-    if (!string)
+const capitalizeString = (string, options) => {
+    if (typeof string !== 'string' || !string)
         return '';
     const trimmedString = string.trim();
     if (!trimmedString)
         return '';
-    const { capitalizeAll, capitalizeEachFirst, lowerCaseRest } = options;
+    const { capitalizeAll = false, capitalizeEachFirst = false, lowerCaseRest = true, } = options || {};
     if (capitalizeAll) {
         return trimmedString.toUpperCase();
     }
@@ -34,10 +28,9 @@ const capitalizeString = (string, options = {
     const matchArray = trimmedString.match(/^(\W*)(\w)(.*)$/);
     if (matchArray && matchArray.length === 4) {
         const [_, leadingSymbols, firstLetter, rest] = matchArray;
-        return (leadingSymbols +
-            firstLetter
-                .toUpperCase()
-                .concat(lowerCaseRest ? rest.toLowerCase() : rest));
+        return leadingSymbols
+            .concat(firstLetter.toUpperCase())
+            .concat(lowerCaseRest ? rest.toLowerCase() : rest);
     }
     return trimmedString
         .charAt(0)
@@ -47,3 +40,22 @@ const capitalizeString = (string, options = {
         : trimmedString.slice(1));
 };
 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;
+ */
+const truncateString = (string, maxLength) => {
+    if (typeof string !== 'string' || !string)
+        return '';
+    const trimmedString = string.trim();
+    if (!trimmedString)
+        return '';
+    if (!trimmedString)
+        return '';
+    if (trimmedString.length <= maxLength)
+        return trimmedString;
+    return trimmedString.slice(0, maxLength).concat('...');
+};
+exports.truncateString = truncateString;

package/dist/string/types.d.ts

@@ -1,9 +1,9 @@
 export interface CapitalizeOptions {
-    /** If true, capitalizes the first letter of each word (space separated). Defaults to `false` */
+    /** If true, capitalizes the first letter of each word (space separated). Defaults to `false`. */
     capitalizeEachFirst?: boolean;
-    /** If true, ensures that the whole string is capitalized. Defaults to `false` */
+    /** If true, ensures that the whole string is capitalized. Defaults to `false`. */
     capitalizeAll?: boolean;
-    /** If true, ensures that the rest of the string is lowercase. Defaults to `true` */
+    /** If true, ensures that the rest of the string is lowercase. Defaults to `true`. */
     lowerCaseRest?: boolean;
 }
 //# 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,gGAAgG;IAChG,mBAAmB,CAAC,EAAE,OAAO,CAAC;IAC9B,iFAAiF;IACjF,aAAa,CAAC,EAAE,OAAO,CAAC;IACxB,oFAAoF;IACpF,aAAa,CAAC,EAAE,OAAO,CAAC;CACxB"}
+{"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"}

package/package.json

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