JSPM

  • ESM via JSPM
  • ES Module Entrypoint
  • Export Map
  • Keywords
  • License
  • Repository URL
  • TypeScript Types
  • README
  • Created
  • Published
  • Downloads 6027149
  • Score
    100M100P100Q212468F
  • License MIT

Encode HTML character references and character entities

Package Exports

  • stringify-entities

This package does not declare an exports field, so the exports above have been automatically detected and optimized by JSPM instead. If any package subpath is missing, it is recommended to post an issue to the original package (stringify-entities) to support the "exports" field. If that is not possible, create a JSPM override to customize the exports field for this package.

Readme

stringify-entities

Build Status Coverage Status Downloads Size

Encode HTML character references and character entities.

  • Very fast
  • Just the encoding part
  • Reliable: '`' characters are escaped to ensure no scripts run in Internet Explorer 6 to 8. Additionally, only named entities recognized by HTML4 are encoded, meaning the infamous ' (which people think is a virus) won’t show up

Algorithm

By default, all dangerous, non-ASCII, and non-printable ASCII characters are encoded. A subset of characters can be given to encode just those characters. Alternatively, pass escapeOnly to escape just the dangerous characters (", ', <, >, &, `). By default, numeric entities are used. Pass useNamedReferences to use named entities when possible, or useShortestReferences to use them if that results in less bytes.

Install

npm:

npm install stringify-entities

Use

var stringify = require('stringify-entities')

stringify('alpha © bravo ≠ charlie 𝌆 delta')
// => 'alpha &#xA9; bravo &#x2260; charlie &#x1D306; delta'

stringify('alpha © bravo ≠ charlie 𝌆 delta', {useNamedReferences: true})
// => 'alpha &copy; bravo &ne; charlie &#x1D306; delta'

API

stringifyEntities(value[, options])

Encode special characters in value.

options
options.escapeOnly

Whether to only escape possibly dangerous characters (boolean, default: false). Those characters are ", ', <, > &, and `.

options.subset

Whether to only escape the given subset of characters (Array.<string>).

options.useNamedReferences

Whether to use named entities where possible (boolean?, default: false).

options.useShortestReferences

Whether to use named entities, where possible, if that results in less bytes (boolean?, default: false). Note: useNamedReferences can be omitted when using useShortestReferences.

options.omitOptionalSemicolons

Whether to omit semicolons when possible (boolean?, default: false). Note: This creates parse errors, don’t use this except when building a minifier.

Omitting semicolons is possible for certain legacy named references, and numeric entities, in some cases.

options.attribute

Only needed when operating dangerously with omitOptionalSemicolons: true. Create entities which don’t fail in attributes (boolean?, default: false).

License

MIT © Titus Wormer