character-entities-legacy

List of legacy HTML named character references that don’t need a trailing semicolon.

Contents

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

What is this?

This is a list of certain named character references, that due to legacy reasons, don’t need a trailing semicolon in HTML. For example, &copy is perfectly fine for ©!

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 14.14+, 16.0+), install with npm:

npm install character-entities-legacy

In Deno with esm.sh:

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

In browsers with esm.sh:

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

Use

import {characterEntitiesLegacy} from 'character-entities-legacy'

console.log(characterEntitiesLegacy.includes('copy')) // => true
console.log(characterEntitiesLegacy.includes('frac34')) // => true
console.log(characterEntitiesLegacy.includes('sup1')) // => true

API

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

characterEntitiesLegacy

List of (case sensitive) legacy character entity names (Array<string>).

wooorm/character-entities holds their decoded values. See whatwg/html for more info.

Types

This package is fully typed with TypeScript. It exports no additional types.

Compatibility

This package is at least compatible with all maintained versions of Node.js. As of now, that is Node.js 14.14+ and 16.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 — info on character entities
• wooorm/character-entities-html4 — info on HTML4 character entities
• wooorm/character-reference-invalid — info on invalid numeric character references

Contribute

Yes please! See How to Contribute to Open Source.

License

MIT © Titus Wormer