@catbee/utils/build/src/utils/string.utils.d.ts

A modular, production-grade utility toolkit for Node.js and TypeScript, designed for robust, scalable applications (including Express-based services). All utilities are tree-shakable and can be imported independently.

/**
 * Capitalizes the first character of a string.
 *
 * @param {string} str - The input string.
 * @returns {string} The string with the first character in uppercase.
 */
export declare function capitalize(str: string): string;
/**
 * Converts a string to kebab-case (e.g., "FooBar test" → "foo-bar-test").
 *
 * @param {string} str - The input string.
 * @returns {string} The kebab-cased string.
 */
export declare function toKebabCase(str: string): string;
/**
 * Converts a kebab-case or snake_case string to camelCase.
 *
 * @param {string} str - The input string.
 * @returns {string} The camelCased string.
 */
export declare function toCamelCase(str: string): string;
/**
 * Converts a string to a URL-friendly slug (lowercase, dashes, alphanumeric).
 *
 * @param {string} str - The input string.
 * @returns {string} The slugified string.
 */
export declare function slugify(str: string): string;
/**
 * Truncates a string to a specific length, appending '...' if truncated.
 *
 * @param {string} str - The input string.
 * @param {number} len - The maximum length.
 * @returns {string} The truncated string.
 */
export declare function truncate(str: string, len: number): string;
/**
 * Converts a string to PascalCase (e.g., "foo-bar" → "FooBar").
 *
 * @param {string} str - The input string.
 * @returns {string} The PascalCased string.
 */
export declare function toPascalCase(str: string): string;
/**
 * Converts a string to snake_case (e.g., "FooBar test" → "foo_bar_test").
 *
 * @param {string} str - The input string.
 * @returns {string} The snake_cased string.
 */
export declare function toSnakeCase(str: string): string;
/**
 * Masks a string by replacing characters with a mask character.
 * Useful for hiding sensitive information like credit cards or passwords.
 *
 * @param {string} str - The string to mask.
 * @param {number} [visibleStart=0] - Number of characters to show at start.
 * @param {number} [visibleEnd=0] - Number of characters to show at end.
 * @param {string} [maskChar="*"] - Character to use for masking.
 * @returns {string} The masked string.
 */
export declare function mask(str: string, visibleStart?: number, visibleEnd?: number, maskChar?: string): string;
/**
 * Removes all HTML tags from a string.
 *
 * @param {string} str - The HTML string to process.
 * @returns {string} The string with HTML tags removed.
 */
export declare function stripHtml(str: string): string;
/**
 * Performs case-insensitive string comparison.
 *
 * @param {string} a - First string.
 * @param {string} b - Second string.
 * @returns {boolean} True if the strings are equal ignoring case.
 */
export declare function equalsIgnoreCase(a: string, b: string): boolean;
/**
 * Reverses a string.
 *
 * @param {string} str - The string to reverse.
 * @returns {string} The reversed string.
 */
export declare function reverse(str: string): string;
/**
 * Counts occurrences of a substring within a string.
 *
 * @param {string} str - The source string.
 * @param {string} substring - The substring to count.
 * @param {boolean} [caseSensitive=true] - Whether to perform case-sensitive counting.
 * @returns {number} Number of occurrences.
 */
export declare function countOccurrences(str: string, substring: string, caseSensitive?: boolean): number;
//# sourceMappingURL=string.utils.d.ts.map