Socket
Socket
Sign inDemoInstall

entities

Package Overview
Dependencies
0
Maintainers
1
Versions
29
Alerts
File Explorer

Advanced tools

Install Socket

Detect and block malicious and high-risk dependencies

Install

    entities

Encode & decode XML/HTML entities with ease


Version published
Maintainers
1
Install size
49.9 kB
Created

Package description

What is entities?

The 'entities' npm package is a library that helps with encoding and decoding HTML entities. It is useful for dealing with HTML data in text form and can be used to prevent XSS attacks by sanitizing input or output.

What are entities's main functionalities?

Encode HTML Entities

Encodes special characters in a string to their corresponding HTML entities. Useful for displaying text on a webpage without it being interpreted as HTML.

"require('entities').encodeHTML('<div>Hello & welcome!</div>');"

Decode HTML Entities

Decodes HTML entities back to their original characters. This is useful for processing text that contains HTML entities and converting them to their readable form.

"require('entities').decodeHTML('&lt;div&gt;Hello &amp; welcome!&lt;/div&gt;');"

Encode XML Entities

Similar to encoding HTML entities, but specifically for XML, which has a smaller set of entities.

"require('entities').encodeXML('<note>Priority & importance</note>');"

Decode XML Entities

Decodes XML entities back to their original characters, which is useful when working with XML data.

"require('entities').decodeXML('&lt;note&gt;Priority &amp; importance&lt;/note&gt;');"

Other packages similar to entities

Readme

Source

#entities

En- & decoder for XML/HTML entities.

####Features:

  • Focussed on speed
  • Supports three levels of entities: XML, HTML4 & HTML5
    • Supports char code entities (eg. &#x55;)
    • Special optimizations for XML: A more restrictive syntax allows faster parsing

##How to…

###…install entities

npm install entities

###…use entities

//encoding
require("entities").encode(<str> data[, <int> level]);
//decoding
require("entities").decode(<str> data[, <int> level]);

The level attribute indicates what level of entities should be decoded (0 = XML, 1 = HTML4 and 2 = HTML5). The default is 0 (read: XML).

There are also methods to access the level directly. Just append the name of the level to the action and you're ready to go (e.g. encodeHTML4(data), decodeXML(data)).

##TODO

  • There should be a way to remove tables that aren't used. The HTML5 table is pretty heavy, if it's not needed, it shouldn't be kept in memory.

Keywords

FAQs

Last updated on 08 Apr 2013

Did you know?

Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.

Install

Related posts

SocketSocket SOC 2 Logo

Product

  • Package Alerts
  • Integrations
  • Docs
  • Pricing
  • FAQ
  • Roadmap

Stay in touch

Get open source security insights delivered straight into your inbox.


  • Terms
  • Privacy
  • Security

Made with ⚡️ by Socket Inc