3.9 KiB
character-entities
Map of named character references.
Contents
- What is this?
- When should I use this?
- Install
- Use
- API
- 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 referenceswooorm/stringify-entities— serialize (encode) character referenceswooorm/character-entities-html4— info on named character references in HTML 4character-reference-invalid— info on invalid numeric character referencescharacter-entities-legacy— info on legacy named character references
Contribute
Yes please! See How to Contribute to Open Source.