escape

string

Converts the characters "&", "<", ">", '"', and "'" in string to their corresponding HTML entities.

Installation

Import

import { escape } from '@tulx/utils';

Source Code

Implementation

/**
 * Converts the characters "&", "<", ">", '"', and "'" in string to their corresponding HTML entities.
 *
 * @param string - The string to escape.
 * @returns Returns the escaped string.
 *
 * @example
 * ```ts
 * escape('fred, barney, & pebbles'); // 'fred, barney, &amp; pebbles'
 * ```
 */
export function escape(string: string): string {
  const map: Record<string, string> = {
    '&': '&amp;',
    '<': '&lt;',
    '>': '&gt;',
    '"': '&quot;',
    "'": '&#39;',
  };

  return string.replace(/[&<>"']/g, (char) => map[char]);
}

Example

import { escape } from '@tulx/utils';

escape('fred, barney, & pebbles'); // 'fred, barney, &amp; pebbles'

Related Functions

camelCase

Converts string to camel case.

capitalize

Converts the first character of string to upper case and the remaining to lower case.

deburr

Deburrs string by converting Latin-1 Supplement and Latin Extended-A letters to basic Latin letters and removing combining diacritical marks.

endsWith

Checks if string ends with the given target string.

escapeRegExp

Escapes the RegExp special characters "^", "$", "\", ".", "*", "+", "?", "(", ")", "[", "]", "{", "}", and "|" in string.

kebabCase

Converts string to kebab case.