{"id":11311,"library":"micromark-util-decode-numeric-character-reference","title":"micromark Numeric Character Reference Decoder","description":"micromark-util-decode-numeric-character-reference is a focused utility within the micromark ecosystem designed to safely decode numeric character references found in markdown (e.g., `A` for 'A'). The current stable major version is `2.x.x`, with `2.0.2` being the latest patch. As part of the unified collective, it follows a regular release cadence, often aligned with broader micromark updates. A key differentiator is its robust handling of non-characters and control characters, ensuring safe output by replacing them with the Unicode replacement character. This package is ESM-only and ships with full TypeScript type definitions, making it suitable for modern JavaScript and TypeScript environments, and is compatible with Node.js 16+.","status":"active","version":"2.0.2","language":"javascript","source_language":"en","source_url":"https://github.com/micromark/micromark#main","tags":["javascript","micromark","util","utility","decode","numeric","number","character","reference","typescript"],"install":[{"cmd":"npm install micromark-util-decode-numeric-character-reference","lang":"bash","label":"npm"},{"cmd":"yarn add micromark-util-decode-numeric-character-reference","lang":"bash","label":"yarn"},{"cmd":"pnpm add micromark-util-decode-numeric-character-reference","lang":"bash","label":"pnpm"}],"dependencies":[],"imports":[{"note":"This package is ESM-only since v1 and cannot be imported with `require()`.","wrong":"const { decodeNumericCharacterReference } = require('micromark-util-decode-numeric-character-reference')","symbol":"decodeNumericCharacterReference","correct":"import { decodeNumericCharacterReference } from 'micromark-util-decode-numeric-character-reference'"},{"note":"TypeScript types are included, use `import type` for type-only imports.","symbol":"decodeNumericCharacterReference (Type)","correct":"import type { decodeNumericCharacterReference } from 'micromark-util-decode-numeric-character-reference'"}],"quickstart":{"code":"import { decodeNumericCharacterReference } from 'micromark-util-decode-numeric-character-reference';\n\n// Example 1: Basic ASCII character decoding from hexadecimal\nconst charA_hex = decodeNumericCharacterReference('41', 16);\nconsole.log(`Hex '41' (16-base) decodes to: '${charA_hex}'`); // Expected: 'A'\n\n// Example 2: Basic ASCII character decoding from decimal\nconst charA_dec = decodeNumericCharacterReference('65', 10);\nconsole.log(`Dec '65' (10-base) decodes to: '${charA_dec}'`); // Expected: 'A'\n\n// Example 3: Decoding a newline character (common in references)\nconst newline_hex = decodeNumericCharacterReference('A', 16);\nconsole.log(`Hex 'A' (16-base) decodes to: '${JSON.stringify(newline_hex)}' (newline)`); // Expected: '\\n'\n\n// Example 4: Handling control characters (these are replaced with a replacement character)\nconst controlChar_hex = decodeNumericCharacterReference('7F', 16); // DEL character\nconsole.log(`Hex '7F' (16-base) decodes to: '${controlChar_hex}'`); // Expected: '�' (replacement character)\n\n// Example 5: Handling out-of-range Unicode code points\nconst outOfRange_hex = decodeNumericCharacterReference('110000', 16); // Beyond U+10FFFF\nconsole.log(`Hex '110000' (16-base) decodes to: '${outOfRange_hex}'`); // Expected: '�' (replacement character)\n\nconsole.log(\"\\nThis utility ensures safe decoding, replacing invalid or control characters with the Unicode replacement character.\");","lang":"typescript","description":"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."},"warnings":[{"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.","message":"This package is ESM-only and no longer supports CommonJS `require()`. Applications must use ES modules.","severity":"breaking","affected_versions":">=1.0.0"},{"fix":"Upgrade your Node.js environment to version 16 or newer to ensure compatibility.","message":"The package requires Node.js version 16 or higher.","severity":"breaking","affected_versions":">=2.0.0"},{"fix":"Ensure your `micromark` core package is at version `3.x.x` to guarantee full compatibility and expected behavior.","message":"This utility is designed for compatibility with `micromark@3`. While it might work with other versions, compatibility is only guaranteed with `micromark@3`.","severity":"gotcha","affected_versions":">=2.0.0"}],"env_vars":null,"last_verified":"2026-04-19T00:00:00.000Z","next_check":"2026-07-18T00:00:00.000Z","problems":[{"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`).","cause":"Attempting to import an ESM-only package using CommonJS `require()` syntax.","error":"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."},{"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.","cause":"Incorrectly importing the named export `decodeNumericCharacterReference` without destructuring in CommonJS, or a typo in the import.","error":"ReferenceError: decodeNumericCharacterReference is not defined"}],"ecosystem":"npm"}