escape-goat

WebJar for escape-goat

License	MIT
GroupId	org.webjars.npm
ArtifactId	escape-goat
Last Version	2.1.1
Release Date	Aug 19, 2020
Type	jar
Description	escape-goat WebJar for escape-goat
Project URL	https://www.webjars.org
Source Code Management	https://github.com/sindresorhus/escape-goat

Download escape-goat

Filename	Size
escape-goat-2.1.1.pom
escape-goat-2.1.1.jar	5 KB
escape-goat-2.1.1-sources.jar	22 bytes
escape-goat-2.1.1-javadoc.jar	22 bytes

How to add to project

Apache Maven

<!-- https://jarcasting.com/artifacts/org.webjars.npm/escape-goat/ -->
<dependency>
    <groupId>org.webjars.npm</groupId>
    <artifactId>escape-goat</artifactId>
    <version>2.1.1</version>
</dependency>

Gradle Groovy

// https://jarcasting.com/artifacts/org.webjars.npm/escape-goat/
implementation 'org.webjars.npm:escape-goat:2.1.1'

Gradle Kotlin

// https://jarcasting.com/artifacts/org.webjars.npm/escape-goat/
implementation ("org.webjars.npm:escape-goat:2.1.1")

Apache Buildr

'org.webjars.npm:escape-goat:jar:2.1.1'

Apache Ivy

<dependency org="org.webjars.npm" name="escape-goat" rev="2.1.1">
  <artifact name="escape-goat" type="jar" />
</dependency>

Groovy Grape

@Grapes(
@Grab(group='org.webjars.npm', module='escape-goat', version='2.1.1')
)

Scala SBT

libraryDependencies += "org.webjars.npm" % "escape-goat" % "2.1.1"

Leiningen

[org.webjars.npm/escape-goat "2.1.1"]

Dependencies

There are no dependencies for this project. It is a standalone project that does not depend on any other jars.

Project Modules

There are no modules declared in this project.

Escape a string for use in HTML or the inverse

Install

$ npm install escape-goat

Usage

const {htmlEscape, htmlUnescape} = require('escape-goat');

htmlEscape('🦄 & 🐐');
//=> '🦄 & 🐐'

htmlUnescape('🦄 & 🐐');
//=> '🦄 & 🐐'

htmlEscape('Hello <em>World</em>');
//=> 'Hello &lt;em&gt;World&lt;/em&gt;'

const url = 'https://sindresorhus.com?x="🦄"';

htmlEscape`<a href="${url}">Unicorn</a>`;
//=> '<a href="https://sindresorhus.com?x=&quot;🦄&quot;">Unicorn</a>'

const escapedUrl = 'https://sindresorhus.com?x=&quot;🦄&quot;';

htmlUnescape`URL from HTML: ${escapedUrl}`;
//=> 'URL from HTML: https://sindresorhus.com?x="🦄"'

API

htmlEscape(string)

Escapes the following characters in the given string argument: & < > " '

The function also works as a tagged template literal that escapes interpolated values.

htmlUnescape(htmlString)

Unescapes the following HTML entities in the given htmlString argument: & < > " '

The function also works as a tagged template literal that unescapes interpolated values.

Tip

Ensure you always quote your HTML attributes to prevent possible XSS.

FAQ

Why yet another HTML escaping package?

I couldn't find one I liked that was tiny, well-tested, and had both .escape() and .unescape().

Versions

Version
2.1.1 Aug 19, 2020