all-named-html-entities open source npm package

Installation

Choose the installation type:

Quick Take

Examples

Purpose

This package exports a plain object with the following keys:

Key	Type	Purpose
	`allNamedEntities` Type: plain object
`allNamedEntities`	plain object	all named HTML entities, key is entity’s name, value is raw decoded entity. 2125 in total.

	`entStartsWith` Type: plain object
`entStartsWith`	plain object	all named HTML entities, grouped by first character, then by second

	`entEndsWith` Type: plain object
`entEndsWith`	plain object	all named HTML entities, grouped by last character, then by second-to-last

	`entStartsWithCaseInsensitive` Type: plain object
`entStartsWithCaseInsensitive`	plain object	all named HTML entities, grouped by first character, then by second, both case-insensitive

	`entEndsWithCaseInsensitive` Type: plain object
`entEndsWithCaseInsensitive`	plain object	all named HTML entities, grouped by last character, then by second-to-last, both case insensitive

	`brokenNamedEntities` Type: plain object
`brokenNamedEntities`	plain object	key-value pairs of common mistyped named HTML entities and their corrections

	`uncertain` Type: plain object
`uncertain`	plain object	all named HTML entities which could be interpreted as words if entity was malformed (missing ampersand for example)

	`allNamedEntitiesSetOnly` Type: Set
`allNamedEntitiesSetOnly`	Set	Set of all named entities, think of array of strings, only unique and faster. Case sensitive list.

	`allNamedEntitiesSetOnlyCaseInsensitive` Type: Set
`allNamedEntitiesSetOnlyCaseInsensitive`	Set	Set of all named entities, think of array of strings, only unique and faster. Case in-sensitive list.

	`decode` Type: function
`decode`	function	decodes named HTML entities (`&...;` format)

	`minLength` Type: integer
`minLength`	integer	length of the shortest of all named HTML entities (currently `2`)

	`maxLength` Type: integer
`maxLength`	integer	length of the longest of all named HTML entities (currently `31`)

	`version` Type: string
`version`	string	as per package.json, for example, `1.4.0`

API — `entStartsWith`

entStartsWith is a plain object:

{
"A": {
    "E": [
        "AElig"
    ],
    "M": [
        "AMP"
    ],
    "a": [
        "Aacute"
    ],
    ...

The point of entStartsWith is that we don’t have to iterate through up to 2,127 entities to match. Instead, we match by first and second letter and match against that list, which varies but is on average tens of strings long.

Let’s tap it.

For example, imagine, we have to check, is there a named HTML entity to the right of string index 2 in string 123Aacute456:

import { entStartsWith } from "all-named-html-entities";

// is there a named HTML entity to the right of index 2?
const input = "123Aacute456";

// first we slice the string from third index onwards, we get "Aacute456"
const workingSlice = input.slice(3);

// this is very verbose and exaggerated code but it's for illustrative purposes

// in real life it would be shorter than all this

// define default answer, false:
let result = false;

if (
  workingSlice &&
  entStartsWith.hasOwnProperty(workingSlice[0]) &&
  entStartsWith[workingSlice[0]].hasOwnProperty(workingSlice[1]) &&
  entStartsWith[workingSlice[0]][workingSlice[1]].some((entity) =>
    workingSlice.startsWith(entity)
  )
) {
  result = true;
}
console.log(`result: ${result}`);

import { all } from "all-named-html-entities";
console.log(Array.isArray(all));

API — `decode()`

import { decode } from "all-named-html-entities";
console.log(decode("&aleph;"));
// => ℵ

If the given input is not a string, or is an empty string or does not start with ampersand or does not end with semicolon, error is thrown.

Else, check is performed and if it’s not found among known entities, a null is returned.

Changelog

Open Changelog

all-named-html-entities3.0.3