nhb-toolbox 4.20.11 → 4.20.16

package/CHANGELOG.md

@@ -6,6 +6,10 @@ All notable changes to the package will be documented here.
 
 ---
 
+## [4.20.16] - 2025-09-01
+
+- **Added** new method `string()` in `LogStyler` (also in `Stylog`) and **made** `applyStyles()` method _public_.
+
 ## [4.20.11] - 2025-09-01
 
 - **Added** new _Symbol_ methods in `Chronos`: `Symbol.isConcatSpreadable` and `Symbol.match`.

package/dist/cjs/utils/stylog.js

@@ -110,58 +110,108 @@ class LogStyler {
         return new LogStyler([...this.#styles, style]);
     }
     /**
-     * * Internal method to apply collected styles to the given input.
-     * @remarks Supports both ANSI (Node.js) and CSS (Browser).
+     * * Returns styled tuple `[format, cssList]` for Browser.
      *
-     * @param input Value to style (any type).
-     * @param stringify Whether to stringify the input using `JSON.stringify()`. Defaults to `false`.
-     * @returns Styled string for Node.js, or a tuple `[format, cssList]` for Browser.
+     * @remarks
+     * - This method is specifically designed for browser environments and returns a tuple containing the formatted string with `%c` placeholder and an array of CSS styles (`string[]`).
+     * - Use this when you need direct access to the CSS styling for custom browser output.
+     * - If you want to format with ANSI escape codes, consider using {@link https://toolbox.nazmul-nhb.dev/docs/classes/LogStyler#stringinput-stringify string} method.
+     *
+     * @param input - Value to style (any type).
+     * @param stringify - Whether to apply `JSON.stringify()` before styling. Defaults to `false`.
+     * @returns Tuple `[format, cssList]` where:
+     *   - `format`: String with `%c` placeholder for CSS styling
+     *   - `cssList`: Array of CSS style strings
+     *
+     * @example
+     * // Basic usage in browser
+     * const styler = new LogStyler(['red', 'bold']);
+     * const [format, cssList] = styler.applyStyles('Error message');
+     * // format: "%cError message"
+     * // cssList: ["color: #FF0000", "font-weight: bold"]
+     *
+     * @example
+     * // Custom browser output handling
+     * const styled = new LogStyler(['blue', 'bgYellow', 'italic']);
+     * const [format, styles] = styled.applyStyles('Warning', true);
+     *
+     * // Use with custom logging function
+     * function customLog(formatted: string, styles: string[]) {
+     *   const styleString = styles.join('; ');
+     *   console.log(formatted, styleString);
+     * }
+     * customLog(format, styles);
+     *
+     * @example
+     * // With object stringification
+     * const dataOutput = new LogStyler(['green']).applyStyles({ id: 123 }, true);
+     * // format: "%c{\"id\":123}"
+     * // cssList: ["color: #008000"]
      */
-    #applyStyles(input, stringify = false) {
+    applyStyles(input, stringify = false) {
         const stringified = stringify === true ? JSON.stringify(input) : input;
-        if ((0, specials_1.isBrowser)()) {
-            // Browser CSS
-            const cssList = [];
-            for (const style of this.#styles) {
-                if (isTextStyle(style)) {
-                    cssList.push(CSS_TEXT_STYLES[style]);
-                }
-                else if (isBGColor(style)) {
-                    const color = css_colors_1.CSS_COLORS[extractColorName(style)];
-                    cssList.push(`background: ${color}`);
-                }
-                else {
-                    const color = css_colors_1.CSS_COLORS[style];
-                    cssList.push(`color: ${color}`);
-                }
+        const cssList = [];
+        for (const style of this.#styles) {
+            if (isTextStyle(style)) {
+                cssList.push(CSS_TEXT_STYLES[style]);
+            }
+            else if (isBGColor(style)) {
+                const color = css_colors_1.CSS_COLORS[extractColorName(style)];
+                cssList.push(`background: ${color}`);
+            }
+            else {
+                const color = css_colors_1.CSS_COLORS[style];
+                cssList.push(`color: ${color}`);
             }
-            return [`%c${stringified}`, cssList];
         }
-        else {
-            // Node ANSI
-            let openSeq = '';
-            let closeSeq = '';
-            for (const style of this.#styles) {
-                if (isTextStyle(style)) {
-                    const [open, close] = ANSI_TEXT_STYLES[style];
-                    openSeq += open;
-                    closeSeq = close + closeSeq;
-                }
-                else if (isBGColor(style)) {
-                    const hex = css_colors_1.CSS_COLORS[extractColorName(style)];
-                    const [open, close] = hexToAnsi(hex, true);
-                    openSeq += open;
-                    closeSeq = close + closeSeq;
-                }
-                else {
-                    const hex = css_colors_1.CSS_COLORS[style];
-                    const [open, close] = hexToAnsi(hex, false);
-                    openSeq += open;
-                    closeSeq = close + closeSeq;
-                }
+        return [`%c${stringified}`, cssList];
+    }
+    /**
+     * * Returns the input as a styled string with ANSI escape codes.
+     *
+     * @remarks
+     * - This method returns ANSI-formatted strings suitable for environments that support ANSI escape codes (terminals, modern browser consoles, etc.).
+     * - For unsupported browsers, consider using the {@link https://toolbox.nazmul-nhb.dev/docs/classes/LogStyler#loginput-stringify log} method to print directly or {@link https://toolbox.nazmul-nhb.dev/docs/classes/LogStyler#applystylesinput-stringify applyStyles} to get styled tuple `[format, cssList]` for Browser.
+     *
+     * @param input - Value to style (any type).
+     * @param stringify - Whether to apply `JSON.stringify()` before styling. Defaults to `false`.
+     * @returns The styled string with ANSI escape codes.
+     *
+     * @example
+     * const styled = new LogStyler(['red', 'bold']);
+     * const errorMessage = styled.string('Error occurred, using LogStyler');
+     * // Or with Stylog
+     * const errorMessage = Stylog.red.bold.string('Error occurred, using Stylog');
+     * // Returns: "\x1b[31m\x1b[1mError occurred\xx1b[22m\x1b[39m"
+     *
+     * @example
+     * // Use in console (terminal or modern browser consoles)
+     * console.error(errorMessage);
+     * console.info(Stylog.red.bold.string('I support ANSI!'));
+     */
+    string(input, stringify = false) {
+        const stringified = stringify === true ? JSON.stringify(input) : input;
+        let openSeq = '', closeSeq = '';
+        for (const style of this.#styles) {
+            if (isTextStyle(style)) {
+                const [open, close] = ANSI_TEXT_STYLES[style];
+                openSeq += open;
+                closeSeq = close + closeSeq;
+            }
+            else if (isBGColor(style)) {
+                const hex = css_colors_1.CSS_COLORS[extractColorName(style)];
+                const [open, close] = hexToAnsi(hex, true);
+                openSeq += open;
+                closeSeq = close + closeSeq;
+            }
+            else {
+                const hex = css_colors_1.CSS_COLORS[style];
+                const [open, close] = hexToAnsi(hex, false);
+                openSeq += open;
+                closeSeq = close + closeSeq;
             }
-            return openSeq + stringified + closeSeq;
         }
+        return openSeq + stringified + closeSeq;
     }
     /**
      * * Print styled input to the console.
@@ -171,11 +221,11 @@ class LogStyler {
      */
     log(input, stringify = false) {
         if ((0, specials_1.isBrowser)()) {
-            const [fmt, cssList] = this.#applyStyles(input, stringify);
+            const [fmt, cssList] = this.applyStyles(input, stringify);
             console.log(fmt, cssList.join(';'));
         }
         else {
-            console.log(this.#applyStyles(input, stringify));
+            console.log(this.string(input, stringify));
         }
     }
 }

package/dist/dts/utils/stylog.d.ts

@@ -62,6 +62,70 @@ export declare class LogStyler {
      * @returns A new `LogStyler` instance with the additional style applied.
      */
     style(style: Styles): LogStyler;
+    /**
+     * * Returns styled tuple `[format, cssList]` for Browser.
+     *
+     * @remarks
+     * - This method is specifically designed for browser environments and returns a tuple containing the formatted string with `%c` placeholder and an array of CSS styles (`string[]`).
+     * - Use this when you need direct access to the CSS styling for custom browser output.
+     * - If you want to format with ANSI escape codes, consider using {@link https://toolbox.nazmul-nhb.dev/docs/classes/LogStyler#stringinput-stringify string} method.
+     *
+     * @param input - Value to style (any type).
+     * @param stringify - Whether to apply `JSON.stringify()` before styling. Defaults to `false`.
+     * @returns Tuple `[format, cssList]` where:
+     *   - `format`: String with `%c` placeholder for CSS styling
+     *   - `cssList`: Array of CSS style strings
+     *
+     * @example
+     * // Basic usage in browser
+     * const styler = new LogStyler(['red', 'bold']);
+     * const [format, cssList] = styler.applyStyles('Error message');
+     * // format: "%cError message"
+     * // cssList: ["color: #FF0000", "font-weight: bold"]
+     *
+     * @example
+     * // Custom browser output handling
+     * const styled = new LogStyler(['blue', 'bgYellow', 'italic']);
+     * const [format, styles] = styled.applyStyles('Warning', true);
+     *
+     * // Use with custom logging function
+     * function customLog(formatted: string, styles: string[]) {
+     *   const styleString = styles.join('; ');
+     *   console.log(formatted, styleString);
+     * }
+     * customLog(format, styles);
+     *
+     * @example
+     * // With object stringification
+     * const dataOutput = new LogStyler(['green']).applyStyles({ id: 123 }, true);
+     * // format: "%c{\"id\":123}"
+     * // cssList: ["color: #008000"]
+     */
+    applyStyles(input: any, stringify?: boolean): [string, string[]];
+    /**
+     * * Returns the input as a styled string with ANSI escape codes.
+     *
+     * @remarks
+     * - This method returns ANSI-formatted strings suitable for environments that support ANSI escape codes (terminals, modern browser consoles, etc.).
+     * - For unsupported browsers, consider using the {@link https://toolbox.nazmul-nhb.dev/docs/classes/LogStyler#loginput-stringify log} method to print directly or {@link https://toolbox.nazmul-nhb.dev/docs/classes/LogStyler#applystylesinput-stringify applyStyles} to get styled tuple `[format, cssList]` for Browser.
+     *
+     * @param input - Value to style (any type).
+     * @param stringify - Whether to apply `JSON.stringify()` before styling. Defaults to `false`.
+     * @returns The styled string with ANSI escape codes.
+     *
+     * @example
+     * const styled = new LogStyler(['red', 'bold']);
+     * const errorMessage = styled.string('Error occurred, using LogStyler');
+     * // Or with Stylog
+     * const errorMessage = Stylog.red.bold.string('Error occurred, using Stylog');
+     * // Returns: "\x1b[31m\x1b[1mError occurred\xx1b[22m\x1b[39m"
+     *
+     * @example
+     * // Use in console (terminal or modern browser consoles)
+     * console.error(errorMessage);
+     * console.info(Stylog.red.bold.string('I support ANSI!'));
+     */
+    string(input: any, stringify?: boolean): string;
     /**
      * * Print styled input to the console.
      *

package/dist/dts/utils/stylog.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"stylog.d.ts","sourceRoot":"","sources":["../../../src/utils/stylog.ts"],"names":[],"mappings":"AAIA,OAAO,KAAK,EAAE,QAAQ,EAAE,GAAG,EAAE,MAAM,iBAAiB,CAAC;AAErD,4BAA4B;AAC5B,MAAM,MAAM,SAAS,GAClB,MAAM,GACN,QAAQ,GACR,KAAK,GACL,QAAQ,GACR,WAAW,GACX,eAAe,GACf,SAAS,CAAC;AAEb,kEAAkE;AAClE,MAAM,MAAM,OAAO,GAAG,KAAK,UAAU,CAAC,QAAQ,CAAC,EAAE,CAAC;AAElD,iDAAiD;AACjD,MAAM,MAAM,MAAM,GAAG,QAAQ,GAAG,OAAO,GAAG,SAAS,CAAC;AAEpD;;;;;;GAMG;AACH,wBAAgB,SAAS,CAAC,GAAG,EAAE,GAAG,EAAE,IAAI,UAAQ,GAAG,CAAC,MAAM,EAAE,MAAM,CAAC,CAKlE;AAkCD,yDAAyD;AACzD,wBAAgB,UAAU,CAAC,KAAK,EAAE,MAAM,GAAG,KAAK,IAAI,QAAQ,CAE3D;AAED,0EAA0E;AAC1E,wBAAgB,SAAS,CAAC,KAAK,EAAE,MAAM,GAAG,KAAK,IAAI,OAAO,CAEzD;AAED,qEAAqE;AACrE,wBAAgB,WAAW,CAAC,KAAK,EAAE,MAAM,GAAG,KAAK,IAAI,SAAS,CAE7D;AAED;;;;;;;;;;;;;;;;GAgBG;AACH,qBAAa,SAAS;;IAGrB;;;;;;;;;;;;;;OAcG;gBACS,MAAM,GAAE,MAAM,EAAO;IAIjC;;;;;;OAMG;IACH,KAAK,CAAC,KAAK,EAAE,MAAM,GAAG,SAAS;IAuD/B;;;;;OAKG;IACI,GAAG,CAAC,KAAK,EAAE,GAAG,EAAE,SAAS,UAAQ,GAAG,IAAI;CAQ/C;AAED;;;;;;;;;;;;GAYG;AACH,MAAM,MAAM,WAAW,GAAG,SAAS,GAAG;KACpC,CAAC,IAAI,MAAM,GAAG,WAAW;CAC1B,CAAC;AA6BF;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA4BG;AACH,eAAO,MAAM,MAAM,EAAE,WAAgD,CAAC"}
+{"version":3,"file":"stylog.d.ts","sourceRoot":"","sources":["../../../src/utils/stylog.ts"],"names":[],"mappings":"AAIA,OAAO,KAAK,EAAE,QAAQ,EAAE,GAAG,EAAE,MAAM,iBAAiB,CAAC;AAErD,4BAA4B;AAC5B,MAAM,MAAM,SAAS,GAClB,MAAM,GACN,QAAQ,GACR,KAAK,GACL,QAAQ,GACR,WAAW,GACX,eAAe,GACf,SAAS,CAAC;AAEb,kEAAkE;AAClE,MAAM,MAAM,OAAO,GAAG,KAAK,UAAU,CAAC,QAAQ,CAAC,EAAE,CAAC;AAElD,iDAAiD;AACjD,MAAM,MAAM,MAAM,GAAG,QAAQ,GAAG,OAAO,GAAG,SAAS,CAAC;AAEpD;;;;;;GAMG;AACH,wBAAgB,SAAS,CAAC,GAAG,EAAE,GAAG,EAAE,IAAI,UAAQ,GAAG,CAAC,MAAM,EAAE,MAAM,CAAC,CAKlE;AAkCD,yDAAyD;AACzD,wBAAgB,UAAU,CAAC,KAAK,EAAE,MAAM,GAAG,KAAK,IAAI,QAAQ,CAE3D;AAED,0EAA0E;AAC1E,wBAAgB,SAAS,CAAC,KAAK,EAAE,MAAM,GAAG,KAAK,IAAI,OAAO,CAEzD;AAED,qEAAqE;AACrE,wBAAgB,WAAW,CAAC,KAAK,EAAE,MAAM,GAAG,KAAK,IAAI,SAAS,CAE7D;AAED;;;;;;;;;;;;;;;;GAgBG;AACH,qBAAa,SAAS;;IAGrB;;;;;;;;;;;;;;OAcG;gBACS,MAAM,GAAE,MAAM,EAAO;IAIjC;;;;;;OAMG;IACH,KAAK,CAAC,KAAK,EAAE,MAAM,GAAG,SAAS;IAI/B;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAsCG;IACI,WAAW,CAAC,KAAK,EAAE,GAAG,EAAE,SAAS,UAAQ,GAAG,CAAC,MAAM,EAAE,MAAM,EAAE,CAAC;IAmBrE;;;;;;;;;;;;;;;;;;;;;;OAsBG;IACI,MAAM,CAAC,KAAK,EAAE,GAAG,EAAE,SAAS,UAAQ,GAAG,MAAM;IAyBpD;;;;;OAKG;IACI,GAAG,CAAC,KAAK,EAAE,GAAG,EAAE,SAAS,UAAQ,GAAG,IAAI;CAQ/C;AAED;;;;;;;;;;;;GAYG;AACH,MAAM,MAAM,WAAW,GAAG,SAAS,GAAG;KACpC,CAAC,IAAI,MAAM,GAAG,WAAW;CAC1B,CAAC;AA6BF;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA4BG;AACH,eAAO,MAAM,MAAM,EAAE,WAAgD,CAAC"}

package/dist/esm/utils/stylog.js

@@ -103,58 +103,108 @@ export class LogStyler {
         return new LogStyler([...this.#styles, style]);
     }
     /**
-     * * Internal method to apply collected styles to the given input.
-     * @remarks Supports both ANSI (Node.js) and CSS (Browser).
+     * * Returns styled tuple `[format, cssList]` for Browser.
      *
-     * @param input Value to style (any type).
-     * @param stringify Whether to stringify the input using `JSON.stringify()`. Defaults to `false`.
-     * @returns Styled string for Node.js, or a tuple `[format, cssList]` for Browser.
+     * @remarks
+     * - This method is specifically designed for browser environments and returns a tuple containing the formatted string with `%c` placeholder and an array of CSS styles (`string[]`).
+     * - Use this when you need direct access to the CSS styling for custom browser output.
+     * - If you want to format with ANSI escape codes, consider using {@link https://toolbox.nazmul-nhb.dev/docs/classes/LogStyler#stringinput-stringify string} method.
+     *
+     * @param input - Value to style (any type).
+     * @param stringify - Whether to apply `JSON.stringify()` before styling. Defaults to `false`.
+     * @returns Tuple `[format, cssList]` where:
+     *   - `format`: String with `%c` placeholder for CSS styling
+     *   - `cssList`: Array of CSS style strings
+     *
+     * @example
+     * // Basic usage in browser
+     * const styler = new LogStyler(['red', 'bold']);
+     * const [format, cssList] = styler.applyStyles('Error message');
+     * // format: "%cError message"
+     * // cssList: ["color: #FF0000", "font-weight: bold"]
+     *
+     * @example
+     * // Custom browser output handling
+     * const styled = new LogStyler(['blue', 'bgYellow', 'italic']);
+     * const [format, styles] = styled.applyStyles('Warning', true);
+     *
+     * // Use with custom logging function
+     * function customLog(formatted: string, styles: string[]) {
+     *   const styleString = styles.join('; ');
+     *   console.log(formatted, styleString);
+     * }
+     * customLog(format, styles);
+     *
+     * @example
+     * // With object stringification
+     * const dataOutput = new LogStyler(['green']).applyStyles({ id: 123 }, true);
+     * // format: "%c{\"id\":123}"
+     * // cssList: ["color: #008000"]
      */
-    #applyStyles(input, stringify = false) {
+    applyStyles(input, stringify = false) {
         const stringified = stringify === true ? JSON.stringify(input) : input;
-        if (isBrowser()) {
-            // Browser CSS
-            const cssList = [];
-            for (const style of this.#styles) {
-                if (isTextStyle(style)) {
-                    cssList.push(CSS_TEXT_STYLES[style]);
-                }
-                else if (isBGColor(style)) {
-                    const color = CSS_COLORS[extractColorName(style)];
-                    cssList.push(`background: ${color}`);
-                }
-                else {
-                    const color = CSS_COLORS[style];
-                    cssList.push(`color: ${color}`);
-                }
+        const cssList = [];
+        for (const style of this.#styles) {
+            if (isTextStyle(style)) {
+                cssList.push(CSS_TEXT_STYLES[style]);
+            }
+            else if (isBGColor(style)) {
+                const color = CSS_COLORS[extractColorName(style)];
+                cssList.push(`background: ${color}`);
+            }
+            else {
+                const color = CSS_COLORS[style];
+                cssList.push(`color: ${color}`);
             }
-            return [`%c${stringified}`, cssList];
         }
-        else {
-            // Node ANSI
-            let openSeq = '';
-            let closeSeq = '';
-            for (const style of this.#styles) {
-                if (isTextStyle(style)) {
-                    const [open, close] = ANSI_TEXT_STYLES[style];
-                    openSeq += open;
-                    closeSeq = close + closeSeq;
-                }
-                else if (isBGColor(style)) {
-                    const hex = CSS_COLORS[extractColorName(style)];
-                    const [open, close] = hexToAnsi(hex, true);
-                    openSeq += open;
-                    closeSeq = close + closeSeq;
-                }
-                else {
-                    const hex = CSS_COLORS[style];
-                    const [open, close] = hexToAnsi(hex, false);
-                    openSeq += open;
-                    closeSeq = close + closeSeq;
-                }
+        return [`%c${stringified}`, cssList];
+    }
+    /**
+     * * Returns the input as a styled string with ANSI escape codes.
+     *
+     * @remarks
+     * - This method returns ANSI-formatted strings suitable for environments that support ANSI escape codes (terminals, modern browser consoles, etc.).
+     * - For unsupported browsers, consider using the {@link https://toolbox.nazmul-nhb.dev/docs/classes/LogStyler#loginput-stringify log} method to print directly or {@link https://toolbox.nazmul-nhb.dev/docs/classes/LogStyler#applystylesinput-stringify applyStyles} to get styled tuple `[format, cssList]` for Browser.
+     *
+     * @param input - Value to style (any type).
+     * @param stringify - Whether to apply `JSON.stringify()` before styling. Defaults to `false`.
+     * @returns The styled string with ANSI escape codes.
+     *
+     * @example
+     * const styled = new LogStyler(['red', 'bold']);
+     * const errorMessage = styled.string('Error occurred, using LogStyler');
+     * // Or with Stylog
+     * const errorMessage = Stylog.red.bold.string('Error occurred, using Stylog');
+     * // Returns: "\x1b[31m\x1b[1mError occurred\xx1b[22m\x1b[39m"
+     *
+     * @example
+     * // Use in console (terminal or modern browser consoles)
+     * console.error(errorMessage);
+     * console.info(Stylog.red.bold.string('I support ANSI!'));
+     */
+    string(input, stringify = false) {
+        const stringified = stringify === true ? JSON.stringify(input) : input;
+        let openSeq = '', closeSeq = '';
+        for (const style of this.#styles) {
+            if (isTextStyle(style)) {
+                const [open, close] = ANSI_TEXT_STYLES[style];
+                openSeq += open;
+                closeSeq = close + closeSeq;
+            }
+            else if (isBGColor(style)) {
+                const hex = CSS_COLORS[extractColorName(style)];
+                const [open, close] = hexToAnsi(hex, true);
+                openSeq += open;
+                closeSeq = close + closeSeq;
+            }
+            else {
+                const hex = CSS_COLORS[style];
+                const [open, close] = hexToAnsi(hex, false);
+                openSeq += open;
+                closeSeq = close + closeSeq;
             }
-            return openSeq + stringified + closeSeq;
         }
+        return openSeq + stringified + closeSeq;
     }
     /**
      * * Print styled input to the console.
@@ -164,11 +214,11 @@ export class LogStyler {
      */
     log(input, stringify = false) {
         if (isBrowser()) {
-            const [fmt, cssList] = this.#applyStyles(input, stringify);
+            const [fmt, cssList] = this.applyStyles(input, stringify);
             console.log(fmt, cssList.join(';'));
         }
         else {
-            console.log(this.#applyStyles(input, stringify));
+            console.log(this.string(input, stringify));
         }
     }
 }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "nhb-toolbox",
-  "version": "4.20.11",
+  "version": "4.20.16",
   "description": "A versatile collection of smart, efficient, and reusable utility functions and classes for everyday development needs.",
   "main": "dist/cjs/index.js",
   "module": "dist/esm/index.js",