Skip to content

Latest commit

 

History

History
157 lines (104 loc) · 4.21 KB

readme.md

File metadata and controls

157 lines (104 loc) · 4.21 KB

character-reference-invalid

Build Coverage Downloads Size

Map of invalid numeric character references to their replacements, according to HTML.

Contents

What is this?

This is a map from the HTML spec of C1 ASCII/Unicode control characters (which are disallowed by HTML) to the characters those code points would have in Windows 1252. For example, U+0080 (Padding Character) maps to , because that’s used for 0x80 in Windows 1252.

When should I use this?

Probably never, unless you’re dealing with parsing HTML or similar XML-like things, or in a place where Unicode is not the primary encoding (it is in most places).

Install

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

npm install character-reference-invalid

In Deno with esm.sh:

import {characterReferenceInvalid} from 'https://esm.sh/character-reference-invalid@2'

In browsers with esm.sh:

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

Use

import {characterReferenceInvalid} from 'character-reference-invalid'

console.log(characterReferenceInvalid[0x80]) // => '€'
console.log(characterReferenceInvalid[0x89]) // => '‰'
console.log(characterReferenceInvalid[0x99]) // => '™'

API

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

characterReferenceInvalid

Map of invalid numeric character references to their replacements, according to HTML (Record<number, string>).

Data

See html.spec.whatwg.org.

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

Contribute

Yes please! See How to Contribute to Open Source.

License

MIT © Titus Wormer