html-encodings

Info on HTML character encodings.

Contents

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

What is this?

This package contains info on HTML character encoding labels. These are defined by the Encoding spec.

When should I use this?

Maybe when you’re writing an HTML parser, minifier, or formatter, otherwise probably never!

Install

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

npm install html-encodings

In Deno with Skypack:

import * as htmlEncodings from 'https://cdn.skypack.dev/html-encodings@3?dts'

In browsers with Skypack:

<script type="module">
  import * as htmlEncodings from 'https://cdn.skypack.dev/html-encodings@3?min'
</script>

Use

import {list, groups} from 'html-encodings'

console.log(list.slice(0, 10))
console.log(groups['UTF-8'])

Yields:

[
  'utf8',
  'utf-8',
  'unicode11utf8',
  'unicode20utf8',
  'x-unicode20utf8',
  'unicode-1-1-utf-8',
  '866',
  'cp866',
  'ibm866',
  'csibm866'
]
[
  'utf8',
  'utf-8',
  'unicode11utf8',
  'unicode20utf8',
  'x-unicode20utf8',
  'unicode-1-1-utf-8'
]

API

This package exports the following identifiers: list and groups. There is no default export.

list

List of all encodings (Array<string>).

groups

Map of group labels to lists of synonymous encodings (Record<string, Array<string>>).

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.

Related

• wooorm/html-dangerous-encodings — list of dangerous HTML character encoding labels

Contribute

Yes please! See How to Contribute to Open Source.

License

MIT © Titus Wormer