# ent

> Encode and decode HTML entities

Latest version **2.2.2** (published 2024-12-16) · MIT license · 0 weekly downloads

## Install

```sh
npm install ent
pnpm add ent
yarn add ent
bun add ent
```

## Health

**Score 33/100 (F)** — status: maintenance-mode.

Positive: has types package; no vulnerabilities; high quality score.

Warnings: low downloads; no esm support.

Negative: stale; low maintenance score.

## Facts

| | |
|---|---|
| Version | 2.2.2 |
| Published | 2024-12-16 |
| First published | 2011-02-16 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | separate (@types/ent) |
| Module format | CommonJS |
| Node | >= 0.4 |
| Dependencies | 4 |
| Unpacked size | 112.3 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 1 |
| Author | James Halliday |
| Maintainers | tootallnate, ljharb |
| Keywords | entities, entitify, entity, html, encode, decode |

## Links

- npm: https://www.npmjs.com/package/ent
- Repository: https://github.com/ljharb/ent
- Homepage: https://github.com/ljharb/ent#readme
- Issues: https://github.com/ljharb/ent/issues
- npm.io page: https://npm.io/package/ent

## Dependencies (4)

- [punycode](https://npm.io/package/punycode.md) ^1.4.1
- [es-errors](https://npm.io/package/es-errors.md) ^1.3.0
- [call-bound](https://npm.io/package/call-bound.md) ^1.0.3
- [safe-regex-test](https://npm.io/package/safe-regex-test.md) ^1.1.0

## Alternatives

- [@tsparticles/shape-image](https://npm.io/package/@tsparticles/shape-image.md) — 303.7K weekly downloads
- [@tsparticles/shape-line](https://npm.io/package/@tsparticles/shape-line.md) — 233.7K weekly downloads
- [stringify-attributes](https://npm.io/package/stringify-attributes.md) — 58.6K weekly downloads
- [mobile-drag-drop](https://npm.io/package/mobile-drag-drop.md) — 46.3K weekly downloads
- [@comunica/actor-rdf-parse-html](https://npm.io/package/@comunica/actor-rdf-parse-html.md) — 29.2K weekly downloads

## Recent versions

- 2.2.2 (latest) — 2024-12-16
- 0.0.8 (v0-backport) — 2024-06-21
- 2.2.1 — 2024-06-20
- 2.2.0 — 2015-01-16
- 2.1.1 — 2015-01-14
- 2.1.0 — 2015-01-14
- 2.0.0 — 2014-04-10
- 1.0.0 — 2014-04-10
- 0.1.0 — 2013-07-29
- 0.0.7 — 2013-07-29
- 0.0.6 — 2013-07-17
- 0.0.5 — 2012-12-12
- 0.0.4 — 2011-06-09
- 0.0.3 — 2011-06-09
- 0.0.2 — 2011-02-24
- … 1 more at https://npm.io/package/ent/versions

## README

# ent <sup>[![Version Badge][npm-version-svg]][package-url]</sup>

[![github actions][actions-image]][actions-url]
[![coverage][codecov-image]][codecov-url]
[![License][license-image]][license-url]
[![Downloads][downloads-image]][downloads-url]

[![npm badge][npm-badge-png]][package-url]

Encode and decode HTML entities

# example

``` js
var ent = require('ent');
console.log(ent.encode('<span>©moo</span>'))
console.log(ent.decode('&pi; &amp; &rho;'));
```

```
&#60;span&#62;&#169;moo&#60;/span&#62;
π & ρ
```

![ent](https://web.archive.org/web/20170823120015if_/http://substack.net/images/ent.png)

# methods

``` js
var ent = require('ent');
var encode = require('ent/encode');
var decode = require('ent/decode');
```

## encode(str, opts={})

Escape unsafe characters in `str` with html entities.

By default, entities are encoded with numeric decimal codes.

If `opts.numeric` is false or `opts.named` is true, encoding will used named
codes like `&pi;`.

If `opts.special` is set to an Object, the key names will be forced
to be encoded (defaults to forcing: `<>'"&`). For example:

``` js
console.log(encode('hello', { special: { l: true } }));
```

```
he&#108;&#108;o
```

## decode(str)

Convert html entities in `str` back to raw text.

# credits

HTML entity tables are from the official
[`entities.json`](https://html.spec.whatwg.org/entities.json) file for
the [whatwg HTML
specification](https://html.spec.whatwg.org/multipage/syntax.html#named-character-references).

# install

With [npm](https://npmjs.org) do:

```
npm install ent
```

# license

MIT

[package-url]: https://npmjs.org/package/ent
[npm-version-svg]: https://versionbadg.es/ljharb/ent.svg
[deps-svg]: https://david-dm.org/ljharb/ent.svg
[deps-url]: https://david-dm.org/ljharb/ent
[dev-deps-svg]: https://david-dm.org/ljharb/ent/dev-status.svg
[dev-deps-url]: https://david-dm.org/ljharb/ent#info=devDependencies
[npm-badge-png]: https://nodei.co/npm/ent.png?downloads=true&stars=true
[license-image]: https://img.shields.io/npm/l/ent.svg
[license-url]: LICENSE
[downloads-image]: https://img.shields.io/npm/dm/ent.svg
[downloads-url]: https://npm-stat.com/charts.html?package=ent
[codecov-image]: https://codecov.io/gh/ljharb/ent/branch/main/graphs/badge.svg
[codecov-url]: https://app.codecov.io/gh/ljharb/ent/
[actions-image]: https://img.shields.io/endpoint?url=https://github-actions-badge-u3jn4tfpocch.runkit.sh/ljharb/ent
[actions-url]: https://github.com/ljharb/ent/actions

---
_Source: https://npm.io/package/ent · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._