stringzy/dist/transformations/truncateText.d.ts

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

/**
 * Truncates a string to a specified maximum length and appends a suffix if truncated.
 *
 * If the text length is less than or equal to `maxLength`, the original text is returned.
 * Otherwise, the text is cut off so that the total length including the suffix does not exceed `maxLength`.
 *
 * Throws a `TypeError` if input types are invalid or if `maxLength` is negative.
 *
 * @param {string} text - The input string to truncate.
 * @param {number} maxLength - The maximum allowed length of the returned string including suffix.
 * @param {string} [suffix='...'] - The string to append if truncation occurs.
 * @returns {string} The truncated string with suffix if applicable.
 * @throws {TypeError} If `text` is not a string.
 * @throws {Error} If `maxLength` is not a non-negative number.
 * @throws {TypeError} If `suffix` is not a string.
 *
 * @example
 * truncateText("Hello World", 8); // "Hello..."
 *
 * @example
 * truncateText("Short text", 20); // "Short text"
 *
 * @example
 * truncateText("Custom suffix example", 10, "---"); // "Custom---"
 */
export declare function truncateText(text: string, maxLength: number, suffix?: string): string;