Awesome

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

npm install html-encodings

In Deno with esm.sh:

import {list, groups} from 'https://esm.sh/html-encodings@3'

In browsers with esm.sh:

<script type="module">
  import {list, groups} from 'https://esm.sh/html-encodings@3?bundle'
</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 identifier list and groups. There is no default export.

list

List of all encodings (lowercase) (Array<string>).

groups

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

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/html-dangerous-encodings — list of dangerous HTML character encoding labels

Contribute

Yes please! See How to Contribute to Open Source.

License

MIT © Titus Wormer