micromark-util-decode-string

What is micromark-util-decode-string?

The micromark-util-decode-string package is a utility for decoding HTML entities and character references in strings. It is commonly used in the context of parsing and processing Markdown or HTML content.

What are micromark-util-decode-string's main functionalities?

Decode HTML Entities

This feature allows you to decode HTML entities in a string. For example, it converts '&' to '&'.

const decodeString = require('micromark-util-decode-string');
const decoded = decodeString('Hello & World');
console.log(decoded); // 'Hello & World'

Decode Numeric Character References

This feature decodes numeric character references in a string. For example, it converts '&' to '&'.

const decodeString = require('micromark-util-decode-string');
const decoded = decodeString('Hello & World');
console.log(decoded); // 'Hello & World'

Decode Hexadecimal Character References

This feature decodes hexadecimal character references in a string. For example, it converts '&' to '&'.

const decodeString = require('micromark-util-decode-string');
const decoded = decodeString('Hello & World');
console.log(decoded); // 'Hello & World'

Other packages similar to micromark-util-decode-string

he

The 'he' package is a robust HTML entity encoder/decoder. It supports both encoding and decoding of HTML entities, including named, numeric, and hexadecimal references. Compared to micromark-util-decode-string, 'he' offers more comprehensive functionality for both encoding and decoding.

entities

The 'entities' package provides fast and robust encoding and decoding of XML and HTML entities. It supports both named and numeric entities. While micromark-util-decode-string focuses on decoding, 'entities' offers both encoding and decoding capabilities.

html-entities

The 'html-entities' package is another library for encoding and decoding HTML entities. It supports named, numeric, and hexadecimal entities. Similar to micromark-util-decode-string, it provides decoding functionality but also includes encoding features.

README

micromark-util-decode-string

micromark utility to decode markdown strings.

Contents

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

What is this?

This package exposes an algorithm to parse character escapes and 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-string

In Deno with esm.sh:

import {decodeString} from 'https://esm.sh/micromark-util-decode-string@1'

In browsers with esm.sh:

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

Use

import {decodeString} from 'micromark-util-decode-string'

decodeString('a ; b') // 'a ; b'
decodeString('a \\; b') // 'a ; b'
decodeString('a ; b') // 'a ; b'

API

This module exports the identifier decodeString. There is no default export.

decodeString(value)

Decode markdown strings (which occur in places such as fenced code info strings, destinations, labels, and titles).

The “string” content type allows character escapes and -references. This decodes those.

Parameters

• value (string) — value to decode

Returns

Decoded value (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-string@^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