micromark-util-encode

micromark utility to encode dangerous html characters.

Contents

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

What is this?

This package exposes an algorithm to make text safe for embedding in HTML.

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-encode

In Deno with esm.sh:

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

In browsers with esm.sh:

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

Use

import {encode} from 'micromark-util-encode'

encode('<3') // '&lt;3'

API

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

encode(value)

Encode only the dangerous HTML characters.

This ensures that certain characters which have special meaning in HTML are dealt with. Technically, we can skip > and " in many cases, but CM includes them.

Parameters

• value (string) — value to encode

Returns

Encoded 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-encode@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