stringzy/dist/transformations/capitalizeWords.js

A versatile string manipulation library providing a range of text utilities for JavaScript and Node.js applications.

"use strict";
Object.defineProperty(exports, "__esModule", { value: true });
exports.capitalizeWords = capitalizeWords;
/**
 * Capitalizes the first letter of every word in a given string.
 *
 * A word is identified by word boundaries (`\b`), and only the first character
 * of each word is converted to uppercase. The rest of the characters remain unchanged.
 *
 * Throws an error if the input is not a string.
 *
 * @param {string} text - The input string whose words will be capitalized.
 * @returns {string} A new string with each word's first character in uppercase.
 * @throws {Error} If the input is not a string.
 *
 * @example
 * capitalizeWords("hello world"); // "Hello World"
 *
 * @example
 * capitalizeWords("javaScript is fun!"); // "JavaScript Is Fun!"
 *
 * @example
 * capitalizeWords(""); // ""
 */
function capitalizeWords(text) {
    if (typeof text !== 'string') {
        throw new Error('Invalid argument. Expected a string.');
    }
    return text.replace(/\b\w/g, (char) => char.toUpperCase());
}