micromark Numeric Character Reference Decoder

Common errors

• Error [ERR_REQUIRE_ESM]: require() of ES module /path/to/node_modules/micromark-util-decode-numeric-character-reference/index.js from /path/to/your/file.js not supported.

  cause Attempting to import an ESM-only package using CommonJS `require()` syntax.
  fix Change your import statement to `import { decodeNumericCharacterReference } from 'micromark-util-decode-numeric-character-reference';` and ensure your environment supports ES modules (e.g., `"type": "module"` in `package.json`).

• ReferenceError: decodeNumericCharacterReference is not defined

  cause Incorrectly importing the named export `decodeNumericCharacterReference` without destructuring in CommonJS, or a typo in the import.
  fix If using ESM, ensure `import { decodeNumericCharacterReference } from '...'`. If you are stuck with CommonJS, you cannot directly import named exports this way for an ESM package; you must refactor to ESM.

Warnings

• breaking This package is ESM-only and no longer supports CommonJS `require()`. Applications must use ES modules.
  Fix: Migrate your project to ES modules (`import`/`export`) or use a tool like `esm` for CommonJS environments if absolutely necessary. Ensure your `package.json` includes `"type": "module"` if using `.js` files with ESM.
• breaking The package requires Node.js version 16 or higher.
  Fix: Upgrade your Node.js environment to version 16 or newer to ensure compatibility.
• gotcha This utility is designed for compatibility with `micromark@3`. While it might work with other versions, compatibility is only guaranteed with `micromark@3`.
  Fix: Ensure your `micromark` core package is at version `3.x.x` to guarantee full compatibility and expected behavior.

Install

• npm install micromark-util-decode-numeric-character-reference npm
• yarn add micromark-util-decode-numeric-character-reference yarn
• pnpm add micromark-util-decode-numeric-character-reference pnpm

Imports

• decodeNumericCharacterReference
  wrong:

  const { decodeNumericCharacterReference } = require('micromark-util-decode-numeric-character-reference')

  correct:

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

  This package is ESM-only since v1 and cannot be imported with `require()`.
• decodeNumericCharacterReference (Type)

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

  TypeScript types are included, use `import type` for type-only imports.

Quickstart

Demonstrates how to decode various numeric character references, including ASCII, control characters, and out-of-range Unicode points, showcasing the utility's safe decoding behavior.

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

// Example 1: Basic ASCII character decoding from hexadecimal
const charA_hex = decodeNumericCharacterReference('41', 16);
console.log(`Hex '41' (16-base) decodes to: '${charA_hex}'`); // Expected: 'A'

// Example 2: Basic ASCII character decoding from decimal
const charA_dec = decodeNumericCharacterReference('65', 10);
console.log(`Dec '65' (10-base) decodes to: '${charA_dec}'`); // Expected: 'A'

// Example 3: Decoding a newline character (common in references)
const newline_hex = decodeNumericCharacterReference('A', 16);
console.log(`Hex 'A' (16-base) decodes to: '${JSON.stringify(newline_hex)}' (newline)`); // Expected: '\n'

// Example 4: Handling control characters (these are replaced with a replacement character)
const controlChar_hex = decodeNumericCharacterReference('7F', 16); // DEL character
console.log(`Hex '7F' (16-base) decodes to: '${controlChar_hex}'`); // Expected: '�' (replacement character)

// Example 5: Handling out-of-range Unicode code points
const outOfRange_hex = decodeNumericCharacterReference('110000', 16); // Beyond U+10FFFF
console.log(`Hex '110000' (16-base) decodes to: '${outOfRange_hex}'`); // Expected: '�' (replacement character)

console.log("\nThis utility ensures safe decoding, replacing invalid or control characters with the Unicode replacement character.");