# micromark-util-decode-string

> micromark utility to decode markdown strings

Latest version **2.0.1** (published 2024-11-12) · MIT license · 0 weekly downloads

## Install

```sh
npm install micromark-util-decode-string
pnpm add micromark-util-decode-string
yarn add micromark-util-decode-string
bun add micromark-util-decode-string
```

## Health

**Score 50/100 (C)** — status: stable.

Positive: has types; esm support; no vulnerabilities; high maintenance score.

Warnings: low downloads.

Negative: stale.

## Facts

| | |
|---|---|
| Version | 2.0.1 |
| Published | 2024-11-12 |
| First published | 2021-09-19 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | bundled |
| Module format | ESM |
| Dependencies | 4 |
| Unpacked size | 10.8 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 2220 |
| Author | Titus Wormer |
| Maintainers | wooorm |
| Keywords | micromark, util, utility, decode, character, reference, escape, string |

## Links

- npm: https://www.npmjs.com/package/micromark-util-decode-string
- Repository: https://github.com/micromark/micromark.git#main
- Homepage: https://github.com/micromark/micromark/tree/main#readme
- Issues: https://github.com/micromark/micromark/issues
- Funding: https://github.com/sponsors/unifiedjs
- npm.io page: https://npm.io/package/micromark-util-decode-string

## Dependencies (4)

- [micromark-util-symbol](https://npm.io/package/micromark-util-symbol.md) ^2.0.0
- [micromark-util-character](https://npm.io/package/micromark-util-character.md) ^2.0.0
- [decode-named-character-reference](https://npm.io/package/decode-named-character-reference.md) ^1.0.0
- [micromark-util-decode-numeric-character-reference](https://npm.io/package/micromark-util-decode-numeric-character-reference.md) ^2.0.0

## Alternatives

- [flatbuffers](https://npm.io/package/flatbuffers.md) — 6.0M weekly downloads
- [jwt-simple](https://npm.io/package/jwt-simple.md) — 259.5K weekly downloads
- [@exodus/patch-broken-hermes-typed-arrays](https://npm.io/package/@exodus/patch-broken-hermes-typed-arrays.md) — 28.5K weekly downloads
- [@native-to-anchor/buffer-layout](https://npm.io/package/@native-to-anchor/buffer-layout.md) — 12.2K weekly downloads
- [binary-parser-encoder](https://npm.io/package/binary-parser-encoder.md) — 5.3K weekly downloads

## Recent versions

- 2.0.1 (latest) — 2024-11-12
- 2.0.0 — 2023-06-21
- 1.1.0 — 2023-05-30
- 1.0.2 — 2021-11-22
- 1.0.1 — 2021-10-02
- 1.0.0 — 2021-09-19

## README

# micromark-util-decode-string

[![Build][build-badge]][build]
[![Coverage][coverage-badge]][coverage]
[![Downloads][downloads-badge]][downloads]
[![Size][bundle-size-badge]][bundle-size]
[![Sponsors][sponsors-badge]][opencollective]
[![Backers][backers-badge]][opencollective]
[![Chat][chat-badge]][chat]

[micromark][] utility to decode markdown strings.

## Contents

* [What is this?](#what-is-this)
* [When should I use this?](#when-should-i-use-this)
* [Install](#install)
* [Use](#use)
* [API](#api)
  * [`decodeString(value)`](#decodestringvalue)
* [Types](#types)
* [Compatibility](#compatibility)
* [Security](#security)
* [Contribute](#contribute)
* [License](#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][esm].
In Node.js (version 16+), install with [npm][]:

```sh
npm install micromark-util-decode-string
```

In Deno with [`esm.sh`][esmsh]:

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

In browsers with [`esm.sh`][esmsh]:

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

## Use

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

decodeString('a &semi; b') // 'a ; b'
decodeString('a \\; b') // 'a ; b'
decodeString('a ; b') // 'a ; b'
```

## API

This module exports the identifier [`decodeString`][api-decode-string].
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`][securitymd] in [`micromark/.github`][health] for how to
submit a security report.

## Contribute

See [`contributing.md`][contributing] in [`micromark/.github`][health] for ways
to get started.
See [`support.md`][support] for ways to get help.

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

## License

[MIT][license] © [Titus Wormer][author]

<!-- Definitions -->

[build-badge]: https://github.com/micromark/micromark/workflows/main/badge.svg

[build]: https://github.com/micromark/micromark/actions

[coverage-badge]: https://img.shields.io/codecov/c/github/micromark/micromark.svg

[coverage]: https://codecov.io/github/micromark/micromark

[downloads-badge]: https://img.shields.io/npm/dm/micromark-util-normalize-identifier.svg

[downloads]: https://www.npmjs.com/package/micromark-util-normalize-identifier

[bundle-size-badge]: https://img.shields.io/badge/dynamic/json?label=minzipped%20size&query=$.size.compressedSize&url=https://deno.bundlejs.com/?q=micromark-util-normalize-identifier

[bundle-size]: https://bundlejs.com/?q=micromark-util-normalize-identifier

[sponsors-badge]: https://opencollective.com/unified/sponsors/badge.svg

[backers-badge]: https://opencollective.com/unified/backers/badge.svg

[opencollective]: https://opencollective.com/unified

[npm]: https://docs.npmjs.com/cli/install

[esm]: https://gist.github.com/sindresorhus/a39789f98801d908bbc7ff3ecc99d99c

[esmsh]: https://esm.sh

[chat-badge]: https://img.shields.io/badge/chat-discussions-success.svg

[chat]: https://github.com/micromark/micromark/discussions

[license]: https://github.com/micromark/micromark/blob/main/license

[author]: https://wooorm.com

[health]: https://github.com/micromark/.github

[securitymd]: https://github.com/micromark/.github/blob/main/security.md

[contributing]: https://github.com/micromark/.github/blob/main/contributing.md

[support]: https://github.com/micromark/.github/blob/main/support.md

[coc]: https://github.com/micromark/.github/blob/main/code-of-conduct.md

[typescript]: https://www.typescriptlang.org

[micromark]: https://github.com/micromark/micromark

[api-decode-string]: #decodestringvalue

---
_Source: https://npm.io/package/micromark-util-decode-string · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._