@nejs/basic-extensions 2.8.0 → 2.10.0

package/dist/cjs/string.extensions.js

@@ -12,292 +12,486 @@ const parenthesisPair = ['(', ')'];
  * utility functions.
  */
 exports.StringExtensions = new extension_1.Patch(String, {
-    /**
-     * The `isString` method does exactly what one would it expect. It returns
-     * true if the string matches typeof or instanceof as a string.
-     *
-     * @param {*} value checks to see if the `value` is a string
-     * @returns {boolean} `true` if it is a `String`, `false` otherwise
-     */
-    isString(value) {
-        return (value !== null && value !== undefined &&
-            (typeof value === 'string' || value instanceof String));
-    },
-    /**
-     * Conditionally returns a value based on whether the supplied
-     * `value` is a `String` or not. If the `value` is a `String`,
-     * the `thenValue` will be returned. If it is not a `String`,
-     * the `elseValue` will be returned instead.
-     *
-     * @param {any} value the value to check to determine if it is a
-     * `String`
-     * @param {any} thenValue the value to return if the supplied
-     * `value` is a `String`
-     * @param {any} elseValue the value to return if the supplied
-     * `value` is not a `String`
-     * @returns {any} either the `thenValue` or `elseValue` depending
-     * on if the supplied `value` is a `String`
-     *
-     * @example
-     * const str = 'hello'
-     * const num = 42
-     * ifString(str, 'is a string', 'not a string') // 'is a string'
-     * ifString(num, 'is a string', 'not a string') // 'not a string'
-     */
-    ifString(value, thenValue, elseValue) {
-        return isThenElse(this.isString(value), thenValue, elseValue);
-    },
-    /**
-     * A getter property that returns a pair of parentheses as an array.
-     * This property can be used when operations require a clear distinction
-     * between the opening and closing parentheses, such as parsing or
-     * matching balanced expressions in strings.
-     *
-     * @returns {[string, string]} An array containing a pair of strings: the
-     * opening parenthesis '(' as the first element, and the closing parenthesis
-     * ')' as the second element.
-     */
-    get parenthesisPair() {
-        return ['(', ')'];
-    },
-    /**
-     * A getter property that returns a pair of square brackets as an array.
-     * This property is particularly useful for operations that require a clear
-     * distinction between the opening and closing square brackets, such as
-     * parsing arrays in strings or matching balanced expressions within
-     * square brackets.
-     *
-     * @returns {[string, string]} An array containing a pair of strings: the
-     * opening square bracket '[' as the first element, and the closing square
-     * bracket ']' as the second element.
-     */
-    get squareBracketsPair() {
-        return ['[', ']'];
-    },
-    /**
-     * A getter property that returns a pair of curly brackets as an array.
-     * This property is particularly useful for operations that require a clear
-     * distinction between the opening and closing curly brackets, such as
-     * parsing objects in strings or matching balanced expressions within
-     * curly brackets. The returned array consists of the opening curly bracket
-     * '{' as the first element, and the closing curly bracket '}' as the
-     * second element.
-     *
-     * @returns {[string, string]} An array containing a pair of strings: the
-     * opening curly bracket '{' as the first element, and the closing curly
-     * bracket '}' as the second element.
-     */
-    get curlyBracketsPair() {
-        return ['{', '}'];
-    },
-    /**
-     * Generates a random string using base 36 (numbers and lowercase letters).
-     * This method is useful when you need a random string that includes both
-     * numbers and letters. The generated string does not include the leading
-     * '0.' that is part of the string representation of a random number in
-     * base 36.
-     *
-     * @returns {string} A random string of characters in base 36.
-     *
-     * @example
-     * const randomStr = StringExtensions.random36();
-     * console.log(randomStr); // Output: "3n5yzxjkf2o"
-     */
-    random36() {
-        return Math.random().toString(36).slice(2);
-    },
-    /**
-     * Generates a random string using base 16 (hexadecimal numbers).
-     * This method is useful when you need a random string that includes both
-     * numbers and letters in hexadecimal format. The generated string does not
-     * include the leading '0.' that is part of the string representation of a
-     * random number in base 16.
-     *
-     * @returns {string} A random string of characters in base 16.
-     *
-     * @example
-     * const randomStr = StringExtensions.random16();
-     * console.log(randomStr); // Output: "3a5f4c"
-     */
-    random16() {
-        return Math.random().toString(16).slice(2);
-    },
-    /**
-     * Generates a random RGB color code.
-     *
-     * This method generates a random hexadecimal number, slices off the
-     * leading '0.' and takes the first 6 characters. It then pads the
-     * end of the string with '0' until it is 6 characters long. The
-     * result is a string that can be used as a color code in CSS.
-     *
-     * @param {string} [prefix='#'] - The prefix to prepend to the color
-     * code. Defaults to '#'.
-     *
-     * @returns {string} A random RGB color code.
-     *
-     * @example
-     * const randomColor = StringExtensions.randomRGB();
-     * console.log(randomColor); // Output: "#3a5f4c"
-     */
-    randomRGBHex(prefix = '#') {
-        const hex = Math.random().toString(16).slice(2).substring(0, 6);
-        return `${prefix}${hex.padEnd(6, '0')}`;
-    },
-    /**
-     * Generates a random ARGB color code.
-     *
-     * This method generates a random hexadecimal number, slices off the
-     * leading '0.' and takes the first 8 characters. It then pads the
-     * start of the string with '0' until it is 6 characters long and the
-     * end of the string with '0' until it is 8 characters long. The
-     * result is a string that can be used as a color code in CSS.
-     *
-     * @param {string} [prefix='#'] - The prefix to prepend to the color
-     * code. Defaults to '#'.
-     *
-     * @returns {string} A random ARGB color code.
-     *
-     * @example
-     * const randomColor = StringExtensions.randomARGB();
-     * console.log(randomColor); // Output: "#3a5f4c00"
-     */
-    randomARGBHex(prefix = '#') {
-        const hex = Math.random().toString(16).slice(2).substring(0, 8);
-        return `${prefix}${hex.padStart(6, '0').padEnd(8, '0')}`;
-    },
-    /**
-     * Generates a random RGBA color code.
-     *
-     * This method generates a random hexadecimal number, slices off the
-     * leading '0.' and takes the first 8 characters. It then pads the
-     * start of the string with '0' until it is 6 characters long and the
-     * end of the string with '0' until it is 8 characters long. The
-     * result is a string that can be used as a color code in CSS.
-     *
-     * @param {string} [prefix='#'] - The prefix to prepend to the color
-     * code. Defaults to '#'.
-     *
-     * @returns {string} A random RGBA color code.
-     *
-     * @example
-     * const randomColor = StringExtensions.randomRGBA();
-     * console.log(randomColor); // Output: "#3a5f4c00"
-     */
-    randomRGBAHex(prefix = '#') {
-        const hex = Math.random().toString(16).slice(2).substring(0, 8);
-        return `${prefix}${hex.padStart(6, '0').padStart(8, '0')}`;
-    },
-    /**
-     * Generates a random RGB color code.
-     *
-     * This method generates a random hexadecimal number, slices off the
-     * leading '0.' and pads the end of the string with '0' until it is
-     * 8 characters long. It then parses the first 6 characters into
-     * three separate 2-character strings, each representing a color
-     * component (red, green, blue) in hexadecimal format. These strings
-     * are then converted into decimal format and used to construct an
-     * RGB color code.
-     *
-     * @returns {string} A random RGB color code.
-     *
-     * @example
-     * const randomColor = StringExtensions.randomRGB();
-     * console.log(randomColor); // Output: "rgb(58,95,76)"
-     */
-    randomRGB() {
-        const hex = Math.random().toString(16).slice(2).padEnd(8, '0');
-        const red = parseInt(hex.substring(0, 2), 16);
-        const green = parseInt(hex.substring(2, 4), 16);
-        const blue = parseInt(hex.substring(4, 6), 16);
-        return `rgb(${red}, ${green}, ${blue})`;
-    },
-    /**
-     * Generates a random RGBA color code with optional forced color values.
-     *
-     * This method generates a random hexadecimal number, slices off the
-     * leading '0.' and pads the end of the string with '0' until it is
-     * 8 characters long. It then parses the first 8 characters into
-     * four separate 2-character strings, each representing a color
-     * component (red, green, blue, alpha) in hexadecimal format. These strings
-     * are then converted into decimal format and used to construct an
-     * RGBA color code.
-     *
-     * If a color component is provided in the `force` parameter, it will
-     * be used instead of a random value for that component.
-     *
-     * @param {Object} force - An object with properties for each color
-     * component (red, green, blue, alpha) that should be forced to a
-     * specific value. If a property is undefined or not provided, a
-     * random value will be used for that component.
-     * @param {number} force.red - The red component (0-255).
-     * @param {number} force.green - The green component (0-255).
-     * @param {number} force.blue - The blue component (0-255).
-     * @param {number} force.alpha - The alpha component (0.0-1.0).
-     *
-     * @returns {string} A random RGBA color code.
-     *
-     * @example
-     * const randomColor = StringExtensions.randomRGBA();
-     * console.log(randomColor); // Output: "rgba(58,95,76,0.50)"
-     *
-     * const forcedGreen = StringExtensions.randomRGBA({ green: 255 });
-     * console.log(forcedGreen); // Output: "rgba(58,255,76,0.50)"
-     */
-    randomRGBA(force = {
-        red: undefined,
-        green: undefined,
-        blue: undefined,
-        alpha: undefined
-    }) {
-        const hex = Math.random().toString(16).slice(2).padEnd(8, '0');
-        const red = force.red ?? parseInt(hex.substring(0, 2), 16);
-        const green = force.green ?? parseInt(hex.substring(2, 4), 16);
-        const blue = force.blue ?? parseInt(hex.substring(4, 6), 16);
-        const alpha = force.alpha ??
-            (parseInt(hex.substring(6, 8), 16) / 255.0) * 1.0;
-        return `rgba(${red}, ${green}, ${blue}, ${alpha.toFixed(2)})`;
-    },
-    wrap(object = globalThis, options = {
-        indent: 2,
-        separator: ', ',
-        indentCharacter: ' ',
-        lineEnding: '\n',
-        inspector: [Object, 'getOwnPropertyNames'],
-        mapValues: undefined,
-        mapLine: undefined,
-    }) {
-        const { indent = 2, separator = ', ', indentCharacter = ' ', lineEnding = '\n', inspector = [Object, 'getOwnPropertyNames'], mapValues, mapLine, } = options ?? {};
-        let tab = indent === 0 ? '' : indentCharacter.repeat(Number(indent) || 2);
-        let maxLen = 76 - tab.length;
-        let line = [];
-        let getElements = inspector[0][inspector[1]];
-        let values = Array.isArray(object) ? object : getElements(Object(object));
-        if (typeof mapValues === 'function') {
-            values = values.map(mapValues);
-        }
-        return values.reduce((acc, key, index, { length }) => {
-            const endOfLine = index < (length - 1) ? separator : '';
-            let ifCombined = [
-                tab, ...line.join(separator), key, endOfLine
-            ].join('').trim();
-            if (ifCombined.length < maxLen) {
-                line.push(key);
+    [extension_1.Patch.kMutablyHidden]: {
+        /**
+         * The `isString` method does exactly what one would it expect. It returns
+         * true if the string matches typeof or instanceof as a string.
+         *
+         * @param {*} value checks to see if the `value` is a string
+         * @returns {boolean} `true` if it is a `String`, `false` otherwise
+         */
+        isString(value) {
+            return (value !== null && value !== undefined &&
+                (typeof value === 'string' || value instanceof String));
+        },
+        /**
+         * Conditionally returns a value based on whether the supplied
+         * `value` is a `String` or not. If the `value` is a `String`,
+         * the `thenValue` will be returned. If it is not a `String`,
+         * the `elseValue` will be returned instead.
+         *
+         * @param {any} value the value to check to determine if it is a
+         * `String`
+         * @param {any} thenValue the value to return if the supplied
+         * `value` is a `String`
+         * @param {any} elseValue the value to return if the supplied
+         * `value` is not a `String`
+         * @returns {any} either the `thenValue` or `elseValue` depending
+         * on if the supplied `value` is a `String`
+         *
+         * @example
+         * const str = 'hello'
+         * const num = 42
+         * ifString(str, 'is a string', 'not a string') // 'is a string'
+         * ifString(num, 'is a string', 'not a string') // 'not a string'
+         */
+        ifString(value, thenValue, elseValue) {
+            return isThenElse(String.isString(value), thenValue, elseValue);
+        },
+        /**
+         * A getter property that returns a pair of parentheses as an array.
+         * This property can be used when operations require a clear distinction
+         * between the opening and closing parentheses, such as parsing or
+         * matching balanced expressions in strings.
+         *
+         * @returns {[string, string]} An array containing a pair of strings: the
+         * opening parenthesis '(' as the first element, and the closing parenthesis
+         * ')' as the second element.
+         */
+        get parenthesisPair() {
+            return ['(', ')'];
+        },
+        /**
+         * A getter property that returns a pair of square brackets as an array.
+         * This property is particularly useful for operations that require a clear
+         * distinction between the opening and closing square brackets, such as
+         * parsing arrays in strings or matching balanced expressions within
+         * square brackets.
+         *
+         * @returns {[string, string]} An array containing a pair of strings: the
+         * opening square bracket '[' as the first element, and the closing square
+         * bracket ']' as the second element.
+         */
+        get squareBracketsPair() {
+            return ['[', ']'];
+        },
+        /**
+         * A getter property that returns a pair of curly brackets as an array.
+         * This property is particularly useful for operations that require a clear
+         * distinction between the opening and closing curly brackets, such as
+         * parsing objects in strings or matching balanced expressions within
+         * curly brackets. The returned array consists of the opening curly bracket
+         * '{' as the first element, and the closing curly bracket '}' as the
+         * second element.
+         *
+         * @returns {[string, string]} An array containing a pair of strings: the
+         * opening curly bracket '{' as the first element, and the closing curly
+         * bracket '}' as the second element.
+         */
+        get curlyBracketsPair() {
+            return ['{', '}'];
+        },
+        /**
+         * Generates a random string using base 36 (numbers and lowercase letters).
+         * This method is useful when you need a random string that includes both
+         * numbers and letters. The generated string does not include the leading
+         * '0.' that is part of the string representation of a random number in
+         * base 36.
+         *
+         * @returns {string} A random string of characters in base 36.
+         *
+         * @example
+         * const randomStr = StringExtensions.random36();
+         * console.log(randomStr); // Output: "3n5yzxjkf2o"
+         */
+        random36() {
+            return Math.random().toString(36).slice(2);
+        },
+        /**
+         * Generates a random string using base 16 (hexadecimal numbers).
+         * This method is useful when you need a random string that includes both
+         * numbers and letters in hexadecimal format. The generated string does not
+         * include the leading '0.' that is part of the string representation of a
+         * random number in base 16.
+         *
+         * @returns {string} A random string of characters in base 16.
+         *
+         * @example
+         * const randomStr = StringExtensions.random16();
+         * console.log(randomStr); // Output: "3a5f4c"
+         */
+        random16() {
+            return Math.random().toString(16).slice(2);
+        },
+        /**
+         * Generates a random RGB color code.
+         *
+         * This method generates a random hexadecimal number, slices off the
+         * leading '0.' and takes the first 6 characters. It then pads the
+         * end of the string with '0' until it is 6 characters long. The
+         * result is a string that can be used as a color code in CSS.
+         *
+         * @param {string} [prefix='#'] - The prefix to prepend to the color
+         * code. Defaults to '#'.
+         *
+         * @returns {string} A random RGB color code.
+         *
+         * @example
+         * const randomColor = StringExtensions.randomRGB();
+         * console.log(randomColor); // Output: "#3a5f4c"
+         */
+        randomRGBHex(prefix = '#') {
+            const hex = Math.random().toString(16).slice(2).substring(0, 6);
+            return `${prefix}${hex.padEnd(6, '0')}`;
+        },
+        /**
+         * Generates a random ARGB color code.
+         *
+         * This method generates a random hexadecimal number, slices off the
+         * leading '0.' and takes the first 8 characters. It then pads the
+         * start of the string with '0' until it is 6 characters long and the
+         * end of the string with '0' until it is 8 characters long. The
+         * result is a string that can be used as a color code in CSS.
+         *
+         * @param {string} [prefix='#'] - The prefix to prepend to the color
+         * code. Defaults to '#'.
+         *
+         * @returns {string} A random ARGB color code.
+         *
+         * @example
+         * const randomColor = StringExtensions.randomARGB();
+         * console.log(randomColor); // Output: "#3a5f4c00"
+         */
+        randomARGBHex(prefix = '#') {
+            const hex = Math.random().toString(16).slice(2).substring(0, 8);
+            return `${prefix}${hex.padStart(6, '0').padEnd(8, '0')}`;
+        },
+        /**
+         * Generates a random RGBA color code.
+         *
+         * This method generates a random hexadecimal number, slices off the
+         * leading '0.' and takes the first 8 characters. It then pads the
+         * start of the string with '0' until it is 6 characters long and the
+         * end of the string with '0' until it is 8 characters long. The
+         * result is a string that can be used as a color code in CSS.
+         *
+         * @param {string} [prefix='#'] - The prefix to prepend to the color
+         * code. Defaults to '#'.
+         *
+         * @returns {string} A random RGBA color code.
+         *
+         * @example
+         * const randomColor = StringExtensions.randomRGBA();
+         * console.log(randomColor); // Output: "#3a5f4c00"
+         */
+        randomRGBAHex(prefix = '#') {
+            const hex = Math.random().toString(16).slice(2).substring(0, 8);
+            return `${prefix}${hex.padStart(6, '0').padStart(8, '0')}`;
+        },
+        /**
+         * Generates a random RGB color code.
+         *
+         * This method generates a random hexadecimal number, slices off the
+         * leading '0.' and pads the end of the string with '0' until it is
+         * 8 characters long. It then parses the first 6 characters into
+         * three separate 2-character strings, each representing a color
+         * component (red, green, blue) in hexadecimal format. These strings
+         * are then converted into decimal format and used to construct an
+         * RGB color code.
+         *
+         * @returns {string} A random RGB color code.
+         *
+         * @example
+         * const randomColor = StringExtensions.randomRGB();
+         * console.log(randomColor); // Output: "rgb(58,95,76)"
+         */
+        randomRGB() {
+            const hex = Math.random().toString(16).slice(2).padEnd(8, '0');
+            const red = parseInt(hex.substring(0, 2), 16);
+            const green = parseInt(hex.substring(2, 4), 16);
+            const blue = parseInt(hex.substring(4, 6), 16);
+            return `rgb(${red}, ${green}, ${blue})`;
+        },
+        /**
+         * Generates a random RGBA color code with optional forced color values.
+         *
+         * This method generates a random hexadecimal number, slices off the
+         * leading '0.' and pads the end of the string with '0' until it is
+         * 8 characters long. It then parses the first 8 characters into
+         * four separate 2-character strings, each representing a color
+         * component (red, green, blue, alpha) in hexadecimal format. These strings
+         * are then converted into decimal format and used to construct an
+         * RGBA color code.
+         *
+         * If a color component is provided in the `force` parameter, it will
+         * be used instead of a random value for that component.
+         *
+         * @param {Object} force - An object with properties for each color
+         * component (red, green, blue, alpha) that should be forced to a
+         * specific value. If a property is undefined or not provided, a
+         * random value will be used for that component.
+         * @param {number} force.red - The red component (0-255).
+         * @param {number} force.green - The green component (0-255).
+         * @param {number} force.blue - The blue component (0-255).
+         * @param {number} force.alpha - The alpha component (0.0-1.0).
+         *
+         * @returns {string} A random RGBA color code.
+         *
+         * @example
+         * const randomColor = StringExtensions.randomRGBA();
+         * console.log(randomColor); // Output: "rgba(58,95,76,0.50)"
+         *
+         * const forcedGreen = StringExtensions.randomRGBA({ green: 255 });
+         * console.log(forcedGreen); // Output: "rgba(58,255,76,0.50)"
+         */
+        randomRGBA(force = {
+            red: undefined,
+            green: undefined,
+            blue: undefined,
+            alpha: undefined
+        }) {
+            const hex = Math.random().toString(16).slice(2).padEnd(8, '0');
+            const red = force.red ?? parseInt(hex.substring(0, 2), 16);
+            const green = force.green ?? parseInt(hex.substring(2, 4), 16);
+            const blue = force.blue ?? parseInt(hex.substring(4, 6), 16);
+            const alpha = force.alpha ??
+                (parseInt(hex.substring(6, 8), 16) / 255.0) * 1.0;
+            return `rgba(${red}, ${green}, ${blue}, ${alpha.toFixed(2)})`;
+        },
+        /**
+         * Applies Select Graphic Rendition (SGR) parameters to a given message for
+         * styling in terminal environments. This function allows for the dynamic
+         * styling of text output using ANSI escape codes. It supports a variety of
+         * modes such as color, brightness, and text decorations like bold or underline.
+         *
+         * @param {string} message The message to be styled.
+         * @param {...string} useModes A series of strings representing the desired
+         * styling modes. Modes can include colors (e.g., 'red', 'blue'), brightness
+         * ('bright'), foreground/background ('fg', 'bg'), and text decorations
+         * ('bold', 'underline'). Modes can be combined in a single string using
+         * commas or passed as separate arguments.
+         *
+         * Colors:
+         * ```
+         * 'black', 'red', 'green', 'yellow', 'blue', 'magenta', 'cyan', 'white'
+         * ```
+         * Color Specifiers:
+         * ```
+         * 'fg' -> foreground   |  'bg' -> background  |  'bright' -> bright colors
+         * ```
+         *
+         * Modes:
+         * ```
+         * 'blink' or 'k' | 'conceal' or 'c' | 'italics' or 'i'  | 'strike' or 's'
+         * 'bold' or 'b'  | 'dim' or 'd'     | 'negative' or 'n' | 'underline' or 'u'
+         * ```
+         *
+         * Examples:
+         * - `sgr('Hello', 'red')` applies red color to 'Hello'.
+         * - `sgr('World', 'green,bold')` applies green color and bold styling
+         *   to 'World'.
+         * - `sgr('Example', 'bluebgbright')` applies bright blue
+         *   background color.
+         *
+         * Short hand syntax is also allowed:
+         * - `sgr('hello', 'biu')` applies bold, italics and underline
+         * - `sgr('hello', 'bi,redfg')` applies bold, italics and red foreground
+         *
+         * As a bonus, there is a secret getter applied to the return string that
+         * allows you to invoke `sgr(...).show` to automatically log the output to
+         * `console.log`. This is done by wrapping the output string in `Object()`
+         * to make it a `String` instance and then adding the property descriptor.
+         * A custom `Symbol` is applied to make it evaluate in nodejs as though it
+         * were a normal string. To strip the extras, wrap the output in `String()`
+         *
+         * @returns {string} The message wrapped in ANSI escape codes corresponding
+         * to the specified modes. The returned string, when printed to a terminal,
+         * displays the styled message. Additional properties are attached to the
+         * result for utility purposes, such as 'show' for immediate console output.
+         */
+        sgr(message, ...useModes) {
+            const colors = Object.assign(['black', 'red', 'green', 'yellow', 'blue', 'magenta', 'cyan', 'white'], {
+                isBG: a => !!/bg/i.exec(a),
+                isBright: a => !!/bright/i.exec(a),
+                isColor: a => {
+                    let color = colors.find(c => new RegExp(c, 'i').exec(a));
+                    return [!!color, colors.indexOf(color)];
+                },
+            });
+            const arrayifyString = s => {
+                if (Array.isArray(s)) {
+                    let results = [];
+                    for (const i of s) {
+                        results = [...results, ...arrayifyString(i)];
+                    }
+                    return results.flat().filter(i => i.length);
+                }
+                if (!s || typeof s !== 'string') {
+                    return [''];
+                }
+                else if (s.includes(',')) {
+                    return arrayifyString(s.split(','));
+                }
+                else {
+                    if (!colors.isColor(s)[0] && s.length > 1) {
+                        return [...s];
+                    }
+                    else
+                        return [s];
+                }
+            };
+            let modes = arrayifyString(useModes);
+            const sgrModes = {
+                blink: ['\x1b[5m', '\x1b[25m', 'k'],
+                bold: ['\x1b[1m', '\x1b[22m', 'b'],
+                conceal: ['\x1b[8m', '\x1b[28m', 'c'],
+                dim: ['\x1b[2m', '\x1b[22m', 'd'],
+                italics: ['\x1b[3m', '\x1b[23m', 'i'],
+                negative: ['\x1b[7m', '\x1b[27m', 'n'],
+                strike: ['\x1b[9m', '\x1b[29m', 's'],
+                underline: ['\x1b[4m', '\x1b[24m', 'u'],
+            };
+            Object.values(sgrModes).forEach(mode => sgrModes[mode[2]] = mode);
+            const codes = a => {
+                let open = '', close = '', mode = String(a).toLowerCase();
+                let [_isColor, colorIndex] = colors.isColor(mode);
+                if (_isColor) {
+                    open = colors.isBG(mode)
+                        ? `\x1b[${colors.isBright(mode) ? 10 : 4}${colorIndex}m`
+                        : `\x1b[${colors.isBright(mode) ? 9 : 3}${colorIndex}m`;
+                    close = colors.isBG(mode) ? '\x1b[49m' : `\x1b[39m`;
+                }
+                else if (sgrModes[mode]) {
+                    open = sgrModes[mode][0];
+                    close = sgrModes[mode][1];
+                }
+                return [open, close];
+            };
+            const onOrder = modes.map(key => codes(key)[0]).join('');
+            const offOrder = modes.map(key => codes(key)[1]).reverse().join('');
+            let result = Object(`${onOrder}${message}${offOrder}`);
+            Object.defineProperties(result, {
+                show: {
+                    get() { console.log(String(this)); return this; },
+                    enumerable: false,
+                },
+                [Symbol.for('nodejs.util.inspect.custom')]: {
+                    value(depth, options, inspect) { return String(this); },
+                    enumerable: false,
+                },
+                [Symbol.toStringTag]: {
+                    get() { return "SgrString"; },
+                    enumerable: false,
+                }
+            });
+            return result;
+        },
+        /**
+         * Wraps an object's properties into a formatted string.
+         *
+         * This method takes an object and a set of options to format the
+         * object's properties into a string. It allows customization of
+         * indentation, line endings, maximum line length, and more.
+         *
+         * @param {Object} [object=globalThis] - The object to wrap.
+         * @param {Object} [options={}] - The formatting options.
+         * @param {number} [options.indent=2] - The number of indentation
+         * characters to use.
+         * @param {string} [options.indentCharacter=' '] - The character to use
+         * for indentation.
+         * @param {Array} [options.inspector=[Object, 'getOwnPropertyNames']] -
+         * The inspector to use for retrieving object properties.
+         * @param {string} [options.lineEnding='\n'] - The line ending character.
+         * @param {number} [options.maxLen=78] - The maximum line length.
+         * @param {Function} [options.perLine=undefined] - A function to apply
+         * per line of output.
+         * @param {Function} [options.perLinePerProperty=undefined] - A function
+         * to apply per property per line of output.
+         * @param {Function} [options.preProcess=undefined] - A function to
+         * preprocess the object's properties.
+         * @param {Function} [options.preReturn=undefined] - A function to apply
+         * to the final output before returning.
+         * @param {string} [options.separator=', '] - The separator to use
+         * between properties.
+         *
+         * @returns {string} The formatted string representation of the object.
+         *
+         * @example
+         * const obj = { a: 1, b: 2, c: 3 }
+         * const wrapped = StringExtensions.wrap(obj, { maxLen: 20 })
+         * console.log(wrapped)
+         * // Output:
+         * // {
+         * //   a: 1,
+         * //   b: 2,
+         * //   c: 3
+         * // }
+         */
+        wrap(objectOrLines, options = {
+            colorProperties: undefined,
+            indent: 2,
+            indentCharacter: ' ',
+            inspector: [Object, 'getOwnPropertyNames'],
+            lineEnding: '\n',
+            maxLen: 78,
+            perLine: undefined,
+            perLinePerProperty: undefined,
+            preProcess: undefined,
+            preReturn: undefined,
+            separator: ', ',
+        }) {
+            let { colorProperties = undefined, indent = options?.indent ?? 2, indentCharacter = options?.indentCharacter ?? ' ', inspector = options?.inspector ?? [Object, 'getOwnPropertyNames'], lineEnding = options?.lineEnding ?? '\n', maxLen = options?.maxLen ?? 78, perLine = options?.perLine ?? undefined, perLinePerProperty = options?.perLinePerProperty ?? undefined, preProcess = options?.preProcess ?? undefined, preReturn = options?.preReturn ?? undefined, separator = options?.separator ?? ', ', } = options ?? {};
+            let tab = indent === 0 ? ''
+                : indentCharacter.repeat(Number(indent) || 2);
+            maxLen = 78 - tab.length;
+            const sgr = this.sgr;
+            const validMapper = f => typeof f === 'function';
+            let line = [];
+            let getElements = inspector[0][inspector[1]];
+            let values = Array.isArray(objectOrLines)
+                ? objectOrLines : getElements(Object(objectOrLines));
+            if (validMapper(preProcess)) {
+                values = preProcess(values);
             }
-            else {
-                let lineElements = [...line, key];
-                let debug = `<-- (len: ${[tab, ...line.join(separator), key, endOfLine].join('').trim().length})`;
-                if (typeof mapLine === 'function') {
-                    lineElements = lineElements.map(mapLine);
+            const context = { indent, indentCharacter, lineEnding, maxLen, tab, sgr };
+            let finalLines = values.reduce((acc, nextProp) => {
+                let ifCombined = [...line, nextProp].join(separator);
+                if ((tab.length + ifCombined.length) <= maxLen) {
+                    line.push(nextProp);
                 }
-                const completeLine = (tab +
-                    lineElements.slice(1).join(separator) +
-                    endOfLine).trim();
-                acc.push(completeLine + debug);
-                line = [];
+                else {
+                    let lineProps = [...line];
+                    if (validMapper(perLinePerProperty)) {
+                        lineProps = lineProps.map((value, index, array) => {
+                            return perLinePerProperty(value, index, array, context);
+                        });
+                    }
+                    if (colorProperties) {
+                        const sgrArgs = (Array.isArray(colorProperties)
+                            ? colorProperties
+                            : [colorProperties]);
+                        lineProps = lineProps.map(v => sgr(v, ...sgrArgs));
+                    }
+                    lineProps = [tab, lineProps.join(separator)].join('');
+                    if (validMapper(perLine)) {
+                        lineProps = perLine(lineProps[0], 0, lineProps)?.[0] ?? lineProps[0];
+                    }
+                    acc.push(lineProps);
+                    line = [];
+                }
+                return acc;
+            }, []);
+            if (validMapper(preReturn)) {
+                finalLines = finalLines.map((value, index, array) => {
+                    return preReturn(value, index, array, context);
+                });
+            }
+            Symbol.for(`@nejs.string.wrap ${JSON.stringify({ lines: finalLines })}`);
+            if (lineEnding) {
+                finalLines = finalLines.join(lineEnding);
             }
-            ;
-            return acc;
-        }, []).join(lineEnding);
+            return finalLines;
+        },
     },
 });
 const { isString: pIsString, ifString: pIfString } = exports.StringExtensions.patches;
@@ -458,6 +652,7 @@ exports.StringPrototypeExtensions = new extension_1.Patch(String.prototype, {
 // Object<->Function<->Global occurs. See original source in global.this.js
 // {@see globalThis.isThenElse}
 function isThenElse(bv, tv, ev) {
+    function isFunction(value) { typeof value === 'function'; }
     if (arguments.length > 1) {
         var _then = isFunction(tv) ? tv(bv) : tv;
         if (arguments.length > 2) {