npmpackage.info

Gathering detailed insights and metrics for escape-goat

Other packages similar to escape-goat

@cjsa/escape-goat

4.0.0-cjsa.0

Escape a string for use in HTML or the inverse

@types/escape-goat

2.0.3

Stub TypeScript definitions entry for escape-goat, which provides its own types definitions

fast-escape-html

1.1.0

Fastest HTML escape on Node.js, even faster than the Rust-based one!

Gathering detailed insights and metrics for escape-goat

escape-goat - 4.0.0 | npmpackage.info

escape-goat

&🐐; Escape a string for use in HTML or the inverse

4.0.0

535

MIT

JavaScript

4.4

Installations

npm install escape-goat

Developer Guide

BETA

Typescript

No

Module System

ESM

Min. Node Version

>=12

Node Version

14.16.1

NPM Version

6.14.10 Pull Requests

Open

0

Total

15

Closed

3

Merged

12

Issues

Open

0

Total

7

Closed

7

Releases

v4.0.0

Updated on Apr 16, 2021

v3.0.0

Updated on Jan 15, 2020

v2.1.1

Updated on Sep 23, 2019

v2.1.0

Updated on May 30, 2019

v2.0.0

Updated on Apr 17, 2019

View All 5 releases

Languages

JavaScript

TypeScript

JavaScript (87.04%)

TypeScript (12.96%)

Developer

sindresorhus

Download Statistics

Total Downloads

Last Day

Last Week

Last Month

Last Year

GitHub Statistics

MIT License

535 Stars

31 Commits

18 Forks

6 Watchers

1 Branches

9 Contributors

Updated on Jun 03, 2025

Sponsor this package

https://github.com/sponsors/sindresorhus

Maintainers

View All 9 Contributors

Package Meta Information

Latest Version

4.0.0

Package Id

escape-goat@4.0.0

Size

2.30 kB

NPM Version

6.14.10

Node Version

14.16.1

Published on

Apr 16, 2021

Total Downloads

Cumulative downloads

Total Downloads

NaN

Last Day

NaN

Compared to previous day

Last Week

NaN

Compared to previous week

Last Month

NaN

Compared to previous month

Last Year

NaN

Compared to previous year

Weekly Downloads

Monthly Downloads

Yearly Downloads

Dev Dependencies

ava tsd xo

Escape a string for use in HTML or the inverse

Install

$ npm install escape-goat

Usage

1import {htmlEscape, htmlUnescape} from 'escape-goat';
2
3htmlEscape('???? & ????');
4//=> '???? &amp; ????'
5
6htmlUnescape('???? &amp; ????');
7//=> '???? & ????'
8
9htmlEscape('Hello <em>World</em>');
10//=> 'Hello &lt;em&gt;World&lt;/em&gt;'
11
12const url = 'https://sindresorhus.com?x="????"';
13
14htmlEscape`<a href="${url}">Unicorn</a>`;
15//=> '<a href="https://sindresorhus.com?x=&quot;????&quot;">Unicorn</a>'
16
17const escapedUrl = 'https://sindresorhus.com?x=&quot;????&quot;';
18
19htmlUnescape`URL from HTML: ${escapedUrl}`;
20//=> '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 methods.

Branch-Protection

Determines if the default and release branches are protected with GitHub's branch protection settings.

0

SAST

Determines if the project uses static code analysis.

Score

4.4

/10

Last Scanned on 2025-06-30

The Open Source Security Foundation is a cross-industry collaboration to improve the security of open source software (OSS). The Scorecard provides security health metrics for open source projects.

Learn More