character-entities

What is character-entities?

The character-entities npm package provides a comprehensive list of character entity references (like & for an ampersand or < for a less-than sign) that can be used in HTML and XML. This package is particularly useful for encoding or decoding character entities in text processing, ensuring that special characters are correctly represented in web pages or XML documents.

What are character-entities's main functionalities?

Accessing Character Entities

This feature allows you to access the character entity for special characters like ampersand (&) and less-than (<) sign. The code sample demonstrates how to import the package and retrieve the character entities for ampersand and less-than sign.

"use strict";
const characterEntities = require('character-entities');
console.log(characterEntities.amp); // Output: '&'
console.log(characterEntities.lt); // Output: '<'

Other packages similar to character-entities

he

The 'he' package is a robust HTML entity encoder/decoder written in JavaScript. Unlike character-entities, which primarily provides a list of character entities, 'he' offers functions to encode and decode HTML entities, making it more versatile for handling HTML content.

entities

Similar to 'he', the 'entities' package offers encoding and decoding functionalities for HTML entities. It supports a wide range of entities and provides more comprehensive parsing and serialization options compared to character-entities, which is more focused on providing a list of entities.

README

character-entities

Map of named character references.

Contents

• 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 or stringify-entities.

Install

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

npm install character-entities

In Deno with esm.sh:

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

In browsers with esm.sh:

<script type="module">
  import {characterEntities} from 'https://esm.sh/character-entities@2?bundle'
</script>

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 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 — 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.

License

MIT © Titus Wormer