Product
Introducing License Enforcement in Socket
Ensure open-source compliance with Socket’s License Enforcement Beta. Set up your License Policy and secure your software!
micromark-util-encode
Advanced tools
The micromark-util-encode package is a utility library for encoding HTML entities in text. It is part of the micromark ecosystem, which is a markdown parser compliant with CommonMark. This utility is specifically designed to help with the encoding of characters that have special meaning in HTML, ensuring that text is safely and correctly displayed in an HTML context.
HTML Entity Encoding
This feature allows for the encoding of text containing characters that have special meaning in HTML, such as '<', '>', and '&', into their corresponding HTML entities. This is useful for displaying user-generated content without risking HTML injection vulnerabilities.
"use strict";
var encode = require('micromark-util-encode');
var result = encode('<div>Hello & Welcome</div>');
console.log(result); // Outputs: '<div>Hello & Welcome</div>'
The 'he' package is a robust HTML entity encoder/decoder written in JavaScript. It supports all named character references defined in HTML, handling encoding and decoding in a comprehensive manner. Compared to micromark-util-encode, 'he' offers a broader set of functionalities for dealing with HTML entities beyond just encoding, including decoding capabilities.
The 'escape-html' package is a simple utility for escaping HTML entities in strings. It focuses solely on converting characters like '<', '>', '&', '"', and "'" into their corresponding HTML entities to prevent HTML injection. While it serves a similar purpose to micromark-util-encode in terms of preventing HTML injection, it does not belong to a larger markdown processing ecosystem and is more limited in scope.
micromark utility to encode dangerous html characters.
npm:
npm install micromark-util-encode
import {encode} from 'micromark-util-encode'
encode('<3') // '<3'
This module exports the following identifiers: 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.
value
(string
) — Value to encode.string
— Encoded value.
See security.md
in micromark/.github
for how to
submit a security report.
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.
FAQs
micromark utility to encode dangerous html characters
We found that micromark-util-encode demonstrated a not healthy version release cadence and project activity because the last version was released a year ago. It has 1 open source maintainer collaborating on the project.
Did you know?
Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.
Product
Ensure open-source compliance with Socket’s License Enforcement Beta. Set up your License Policy and secure your software!
Product
We're launching a new set of license analysis and compliance features for analyzing, managing, and complying with licenses across a range of supported languages and ecosystems.
Product
We're excited to introduce Socket Optimize, a powerful CLI command to secure open source dependencies with tested, optimized package overrides.