Big update!Introducing GitHub Bot Commands. Learn more
Socket
Log inBook a demo

parse-entities

Package Overview
Dependencies
8
Maintainers
1
Versions
13
Issues
File Explorer

Advanced tools

parse-entities

Parse HTML character references

    4.0.0latest

Version published
Maintainers
1
Weekly downloads
7,960,639
decreased by-12.42%

Weekly downloads

Changelog

Source

4.0.0

  • cd47ffd Fix webpack

Full Changelog: https://github.com/wooorm/parse-entities/compare/3.1.0...4.0.0

Readme

Source

parse-entities

Build Coverage Downloads Size

Parse HTML character references.

Contents

What is this?

This is a small and powerful decoder of HTML character references (often called entities).

When should I use this?

You can use this for spec-compliant decoding of character references. It’s small and fast enough to do that well. You can also use this when making a linter, because there are different warnings emitted with reasons for why and positional info on where they happened.

Install

This package is ESM only. In Node.js (version 12.20+, 14.14+, or 16.0+), install with npm:

npm install parse-entities

In Deno with Skypack:

import {parseEntities} from 'https://cdn.skypack.dev/parse-entities@3?dts'

In browsers with Skypack:

<script type="module"> import {parseEntities} from 'https://cdn.skypack.dev/[email protected]?min' </script>

Use

import {parseEntities} from 'parse-entities' console.log(parseEntities('alpha &amp bravo'))) // => alpha & bravo console.log(parseEntities('charlie &copycat; delta')) // => charlie ©cat; delta console.log(parseEntities('echo &copy; foxtrot &#8800; golf &#x1D306; hotel')) // => echo © foxtrot ≠ golf 𝌆 hotel

API

This package exports the following identifier: parseEntities. There is no default export.

parseEntities(value[, options])

Parse HTML character references.

options

Configuration (optional).

options.additional

Additional character to accept (string?, default: ''). This allows other characters, without error, when following an ampersand.

options.attribute

Whether to parse value as an attribute value (boolean?, default: false). This results in slightly different behavior.

options.nonTerminated

Whether to allow nonterminated references (boolean, default: true). For example, &copycat for ©cat. This behavior is compliant to the spec but can lead to unexpected results.

options.position

Starting position of value (Position or Point, optional). Useful when dealing with values nested in some sort of syntax tree. The default is:

{line: 1, column: 1, offset: 0}
options.warning

Error handler (Function?).

options.text

Text handler (Function?).

options.reference

Reference handler (Function?).

options.warningContext

Context used when calling warning ('*', optional).

options.textContext

Context used when calling text ('*', optional).

options.referenceContext

Context used when calling reference ('*', optional)

Returns

string — decoded value.

function warning(reason, point, code)

Error handler.

Parameters
  • this (*) — refers to warningContext when given to parseEntities
  • reason (string) — human readable reason for emitting a parse error
  • point (Point) — place where the error occurred
  • code (number) — machine readable code the error

The following codes are used:

CodeExampleNote
1foo &amp barMissing semicolon (named)
2foo &#123 barMissing semicolon (numeric)
3Foo &bar bazEmpty (named)
4Foo &#Empty (numeric)
5Foo &bar; bazUnknown (named)
6Foo &#128; bazDisallowed reference
7Foo &#xD800; bazProhibited: outside permissible unicode range
function text(value, position)

Text handler.

Parameters
  • this (*) — refers to textContext when given to parseEntities
  • value (string) — string of content
  • position (Position) — place where value starts and ends
function reference(value, position, source)

Character reference handler.

Parameters
  • this (*) — refers to referenceContext when given to parseEntities
  • value (string) — decoded character reference
  • position (Position) — place where source starts and ends
  • source (string) — raw source of character reference

Types

This package is fully typed with TypeScript. Additional Options, WarningHandler, ReferenceHandler, and TextHandler types are exported that model their respective values.

Compatibility

This package is at least compatible with all maintained versions of Node.js. As of now, that is Node.js 12.20+, 14.14+, and 16.0+. It also works in Deno and modern browsers.

Security

This package is safe: it matches the HTML spec to parse character references.

Contribute

Yes please! See How to Contribute to Open Source.

License

MIT © Titus Wormer

Keywords

FAQs

What is parse-entities?

Parse HTML character references

Is parse-entities popular?

The npm package parse-entities receives a total of 7,621,857 weekly downloads. As such, parse-entities popularity was classified as popular.

Is parse-entities well maintained?

We found that parse-entities 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.

Last updated on 22 Nov 2021

Did you know?

Socket installs a Github app to automatically flag issues on every pull request and report the health of your dependencies. Find out what is inside your node modules and prevent malicious activity before you update the dependencies.

Install Socket
Socket

Product

Subscribe to our newsletter

Get open source security insights delivered straight into your inbox. Be the first to learn about new features and product updates.


  • Terms
  • Privacy
  • Security

Made with ⚡️ by Socket Inc