Options
All
  • Public
  • Public/Protected
  • All
Menu

Module escape

Index

References

Functions String

References

Renames and re-exports escape

String Functions

  • escape(string: string): string
  • Converts the characters "&", "<", ">", '"', and "'" in string to their corresponding HTML entities.

    Note: No other characters are escaped. To escape additional characters use a third-party library like he.

    Though the ">" character is escaped for symmetry, characters like ">" and "/" don't need escaping in HTML and have no special meaning unless they're part of a tag or unquoted attribute value. See Mathias Bynens's article (under "semi-related fun fact") for more details.

    When working with HTML you should always quote attribute values to reduce XSS vectors.

    since

    5.12.0

    see

    escapeRegExp, unescape

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

    Parameters

    • string: string

      The string to escape.

    Returns string

    Returns the escaped string.