escapeXml.ts

import { requireNonEmptyString } from "../lang";

/**
 * Escapes special characters in a string for safe use within XML/HTML content.
 *
 * @param   {string} value - The string containing characters to be escaped for XML.
 * @returns {string} The escaped string, safe for use in XML/HTML text content or attribute values.
 * @throws  {@link EmptyStringException}
 * @see     {@link escapeHtml}
 * @see     {@link escapeRegExp}
 * @since   1.0.0
 * @version 1.1.0
 */
export function escapeXml(value: string): string {
  return requireNonEmptyString(value)
    .replace(/&/g, "&")
    .replace(/"/g, """)
    .replace(/'/g, "'")
    .replace(/</g, "&lt;")
    .replace(/>/g, "&gt;");
}