site/node_modules/character-reference-invalid/readme.md
2024-10-14 08:09:33 +02:00

4.2 KiB
Raw Permalink Blame History

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 thats used for 0x80 in Windows 1252.

When should I use this?

Probably never, unless youre 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 12.20+, 14.14+, or 16.0+), install with npm:

npm install character-reference-invalid

In Deno with Skypack:

import {characterReferenceInvalid} from 'https://cdn.skypack.dev/character-reference-invalid@2?dts'

In browsers with Skypack:

<script type="module">
  import {characterReferenceInvalid} from 'https://cdn.skypack.dev/character-reference-invalid@2?min'
</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 following identifiers: characterReferenceInvalid. There is no default export.

characterReferenceInvalid

Record<number, string> — mapping between invalid numeric character reference codes to replacements characters.

Source

See html.spec.whatwg.org.

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+, and 16.0+. It also works in Deno and modern browsers.

Security

This package is safe.

Contribute

Yes please! See How to Contribute to Open Source.

License

MIT © Titus Wormer