# character-entities > Map of named character references Latest version **2.0.2** (published 2022-06-22) · MIT license · 0 weekly downloads ## Install ```sh npm install character-entities pnpm add character-entities yarn add character-entities bun add character-entities ``` ## Health **Score 30/100 (F)** — status: abandoned. Positive: has types; esm support; no vulnerabilities; high quality score. Warnings: low downloads. Negative: abandoned; low maintenance score. ## Facts | | | |---|---| | Version | 2.0.2 | | Published | 2022-06-22 | | First published | 2015-09-27 | | Weekly downloads | 0 | | License | MIT | | TypeScript types | bundled | | Module format | ESM + CommonJS | | Dependencies | 0 | | Unpacked size | 43.6 KB | | Known vulnerabilities | 0 | | Install scripts | no | | GitHub stars | 10 | | Author | Titus Wormer | | Maintainers | wooorm | | Keywords | html, entity, entities, character, reference, name, replacement | ## Links - npm: https://www.npmjs.com/package/character-entities - Repository: https://github.com/wooorm/character-entities - Homepage: https://github.com/wooorm/character-entities#readme - Issues: https://github.com/wooorm/character-entities/issues - Funding: https://github.com/sponsors/wooorm - npm.io page: https://npm.io/package/character-entities ## 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.0.2 (latest) — 2022-06-22 - 2.0.1 — 2021-10-29 - 2.0.0 — 2021-03-08 - 1.2.4 — 2020-01-24 - 1.2.3 — 2019-05-08 - 1.2.2 — 2018-04-18 - 1.2.1 — 2017-07-11 - 1.2.0 — 2016-11-04 - 1.1.0 — 2016-07-23 - 1.0.0 — 2015-09-27 ## README # character-entities [![Build][build-badge]][build] [![Coverage][coverage-badge]][coverage] [![Downloads][downloads-badge]][downloads] [![Size][size-badge]][size] Map of named character references. ## Contents * [What is this?](#what-is-this) * [When should I use this?](#when-should-i-use-this) * [Install](#install) * [Use](#use) * [API](#api) * [characterEntities](#characterentities) * [Types](#types) * [Compatibility](#compatibility) * [Security](#security) * [Related](#related) * [Contribute](#contribute) * [License](#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][]: ```sh npm install character-entities ``` In Deno with [`esm.sh`][esmsh]: ```js import {characterEntities} from 'https://esm.sh/character-entities@2' ``` In browsers with [`esm.sh`][esmsh]: ```html ``` ## Use ```js 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. ## Related * [`wooorm/parse-entities`](https://github.com/wooorm/parse-entities) — parse (decode) character references * [`wooorm/stringify-entities`](https://github.com/wooorm/stringify-entities) — serialize (encode) character references * [`wooorm/character-entities-html4`](https://github.com/wooorm/character-entities-html4) — info on named character references in HTML 4 * [`character-reference-invalid`](https://github.com/wooorm/character-reference-invalid) — info on invalid numeric character references * [`character-entities-legacy`](https://github.com/wooorm/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 --- _Source: https://npm.io/package/character-entities · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._