ent

What is ent?

The 'ent' npm package is used for encoding and decoding HTML entities. It provides a simple way to convert special characters to their corresponding HTML entities and vice versa.

What are ent's main functionalities?

Encoding HTML Entities

This feature allows you to encode special characters in a string to their corresponding HTML entities. This is useful for safely displaying user-generated content on a web page.

const ent = require('ent');
const encoded = ent.encode('<div>Hello & welcome!</div>');
console.log(encoded); // Output: &lt;div&gt;Hello &amp; welcome!&lt;/div&gt;

Decoding HTML Entities

This feature allows you to decode HTML entities back to their original characters. This is useful for processing HTML content that has been encoded.

const ent = require('ent');
const decoded = ent.decode('<div>Hello & welcome!</div>');
console.log(decoded); // Output: <div>Hello & welcome!</div>

Other packages similar to ent

he

The 'he' package is another popular library for encoding and decoding HTML entities. It is known for its compliance with the HTML5 specification and its ability to handle a wide range of character sets. Compared to 'ent', 'he' offers more comprehensive support for different types of entities and edge cases.

html-entities

The 'html-entities' package provides similar functionality for encoding and decoding HTML entities. It supports both XML and HTML4/5 entities and offers methods for encoding and decoding both named and numeric entities. Compared to 'ent', 'html-entities' provides more flexibility in terms of the types of entities it can handle.

README

ent

Encode and decode HTML entities

example

var ent = require('ent');
console.log(ent.encode('<span>©moo</span>'))
console.log(ent.decode('&pi; &amp; &rho;'));

<span>©moo</span>
π & ρ

methods

var ent = require('ent');
var encode = require('ent/encode');
var decode = require('ent/decode');

encode(str, opts={})

Escape unsafe characters in str with html entities.

By default, entities are encoded with numeric decimal codes.

If opts.numeric is false or opts.named is true, encoding will used named codes like π.

If opts.special is set to an Object, the key names will be forced to be encoded (defaults to forcing: <>'"&). For example:

console.log(encode('hello', { special: { l: true } }));

hello

decode(str)

Convert html entities in str back to raw text.

credits

HTML entity tables are from the official entities.json file for the whatwg HTML specification.

install

With npm do:

npm install ent

license

MIT

Changelog

v2.2.1 - 2024-06-20

Fixed

• Give credits to whatwg, instead of HTML::Entities #23

Commits

• [Dev Deps] add eslint, safe-publish-latest, evalmd a54380e
• Only apps should have lockfiles 5369429
• [Tests] migrate from travis to GHA 0ce07a1
• [Dev Deps] update tape da07969
• [meta] use npmignore 153e114
• [meta] update URLs 758c132
• [meta] use auto-changelog c1b7129
• [Fix] use punycode package instead of the deprecated node core module 67568c3
• [meta] add missing engines.node 0f25e78
• [Dev Deps] update tape 2d900f7