site/node_modules/micromark-util-decode-numeric-character-reference/readme.md

micromark-util-decode-numeric-character-reference

micromark utility to decode numeric character references.

Contents

• What is this?
• When should I use this?
• Install
• Use
• API
  • decodeNumericCharacterReference(value, base)
• Types
• Compatibility
• Security
• Contribute
• License

What is this?

This package exposes an algorithm to decode numeric character references.

When should I use this?

This package might be useful when you are making your own micromark extensions.

Install

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

npm install micromark-util-decode-numeric-character-reference

In Deno with esm.sh:

import {decodeNumericCharacterReference} from 'https://esm.sh/micromark-util-decode-numeric-character-reference@1'

In browsers with esm.sh:

<script type="module">
  import {decodeNumericCharacterReference} from 'https://esm.sh/micromark-util-decode-numeric-character-reference@1?bundle'
</script>

Use

import {decodeNumericCharacterReference} from 'micromark-util-decode-numeric-character-reference'

decodeNumericCharacterReference('41', 16) // 'A'
decodeNumericCharacterReference('65', 10) // 'A'
decodeNumericCharacterReference('A', 16) // '\n'
decodeNumericCharacterReference('7F', 16) // '<27>' - Control
decodeNumericCharacterReference('110000', 16) // '<27>' - Out of range

API

This module exports the identifier: decodeNumericCharacterReference. There is no default export.

decodeNumericCharacterReference(value, base)

Turn the number (in string form as either hexa- or plain decimal) coming from a numeric character reference into a character.

Sort of like String.fromCodePoint(Number.parseInt(value, base)), but makes non-characters and control characters safe.

Parameters

• value (string) — value to decode
• base (number, probably 10 or 16) — numeric base

Returns

Character (string).

Types

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

Compatibility

Projects maintained by the unified collective are compatible with maintained versions of Node.js.

When we cut a new major release, we drop support for unmaintained versions of Node. This means we try to keep the current release line, micromark-util-decode-numeric-character-reference@^2, compatible with Node.js 16. This package works with micromark@^3.

Security

This package is safe. See security.md in micromark/.github for how to submit a security report.

Contribute

See contributing.md in micromark/.github for ways to get started. See support.md for ways to get help.

This project has a code of conduct. By interacting with this repository, organisation, or community you agree to abide by its terms.

License

MIT © Titus Wormer