character-entities

[![Build][build-badge]][build] [![Coverage][coverage-badge]][coverage] [![Downloads][downloads-badge]][downloads] [![Size][size-badge]][size]

Map of named character references.

* What is this? * When should I use this? * Install * Use * API * characterEntities * Types * Compatibility * Security * Related * Contribute * License

What is this?

This is a map of named character references in HTML (latest) to the characters they represent.

When should I use this?

Maybe when you’re writing an HTML parser or minifier, but otherwise probably never! Even then, it might be better to use [parse-entities][parse-entities] or [stringify-entities][stringify-entities].

Install

This package is [ESM only][esm]. In Node.js (version 12.20+, 14.14+, 16.0+, 18.0+), install with [npm][]:

npm install character-entities

In Deno with [esm.sh][esmsh]:

import {characterEntities} from 'https://esm.sh/character-entities@2'

In browsers with [esm.sh][esmsh]:

Use

import {characterEntities} from 'character-entities'console.log(characterEntities.AElig) // => 'Æ'
console.log(characterEntities.aelig) // => 'æ'
console.log(characterEntities.amp) // => '&'

API

This package exports the identifier characterEntities. There is no default export.

characterEntities

Mapping between (case-sensitive) character entity names to replacements. See [html.spec.whatwg.org][html] for more info.

Types

This package is fully typed with [TypeScript][].

Compatibility

This package is at least compatible with all maintained versions of Node.js. As of now, that is Node.js 12.20+, 14.14+, 16.0+, and 18.0+. It also works in Deno and modern browsers.

Security

This package is safe.

* wooorm/parse-entities — parse (decode) character references * wooorm/stringify-entities — serialize (encode) character references * wooorm/character-entities-html4 — info on named character references in HTML 4 * character-reference-invalid — info on invalid numeric character references * character-entities-legacy — info on legacy named character references

Contribute

Yes please! See [How to Contribute to Open Source][contribute].

License

[MIT][license] © [Titus Wormer][author]

[build-badge]: https://github.com/wooorm/character-entities/workflows/main/badge.svg

[build]: https://github.com/wooorm/character-entities/actions

[coverage-badge]: https://img.shields.io/codecov/c/github/wooorm/character-entities.svg

[coverage]: https://codecov.io/github/wooorm/character-entities

[downloads-badge]: https://img.shields.io/npm/dm/character-entities.svg

[downloads]: https://www.npmjs.com/package/character-entities

[size-badge]: https://img.shields.io/bundlephobia/minzip/character-entities.svg

[size]: https://bundlephobia.com/result?p=character-entities

[npm]: https://docs.npmjs.com/cli/install

[esmsh]: https://esm.sh

[license]: license

[author]: https://wooorm.com

[esm]: https://gist.github.com/sindresorhus/a39789f98801d908bbc7ff3ecc99d99c

[typescript]: https://www.typescriptlang.org

[contribute]: https://opensource.guide/how-to-contribute/

[parse-entities]: https://github.com/wooorm/parse-entities

[stringify-entities]: https://github.com/wooorm/stringify-entities

[html]: https://html.spec.whatwg.org/multipage/syntax.html#named-character-references

📄 readme.md