@types/he

What is @types/he?

@types/he provides TypeScript type definitions for the 'he' library, which is used for encoding and decoding HTML entities.

What are @types/he's main functionalities?

Encode HTML entities

This feature allows you to encode special characters in a string into their corresponding HTML entities. For example, the ampersand '&' is encoded as '&'.

const he = require('he');
const encoded = he.encode('Hello & World');
console.log(encoded); // Output: 'Hello & World'

Decode HTML entities

This feature allows you to decode HTML entities back into their original characters. For example, '&' is decoded back to '&'.

const he = require('he');
const decoded = he.decode('Hello & World');
console.log(decoded); // Output: 'Hello & World'

Encode HTML entities with custom options

This feature allows you to encode HTML entities with custom options, such as using named references for entities.

const he = require('he');
const encoded = he.encode('Hello & World', { 'useNamedReferences': true });
console.log(encoded); // Output: 'Hello & World'

Decode HTML entities with custom options

This feature allows you to decode HTML entities with custom options, such as treating the input as an attribute value.

const he = require('he');
const decoded = he.decode('Hello & World', { 'isAttributeValue': true });
console.log(decoded); // Output: 'Hello & World'

Other packages similar to @types/he

entities

The 'entities' package provides similar functionality for encoding and decoding HTML entities. It supports both XML and HTML entities and offers a more comprehensive set of features for handling different types of entities.

html-entities

The 'html-entities' package is another alternative for encoding and decoding HTML entities. It provides a simple API and supports both named and numeric entities. It is known for its performance and ease of use.

escape-html

The 'escape-html' package focuses on escaping HTML entities to prevent XSS attacks. It provides a lightweight and efficient way to escape special characters in HTML strings.

README

Installation

npm install --save @types/he

Summary

This package contains type definitions for he (https://github.com/mathiasbynens/he).

Details

Files were exported from https://github.com/DefinitelyTyped/DefinitelyTyped/tree/master/types/he.

Additional Details

• Last updated: Tue, 07 Nov 2023 03:09:37 GMT
• Dependencies: none

Credits

These definitions were written by Simon Edwards, and Robin Tregaskis.