A robust HTML entities encoder/decoder with full Unicode support. 

mathias

	"description": "A robust HTML entities encoder/decoder with full Unicode support.",

		"url": "https://github.com/mathiasbynens/he.git"

		"url": "https://github.com/mathiasbynens/he/issues"

# he [![Build status](https://travis-ci.org/mathiasbynens/he.png?branch=master)](https://travis-ci.org/mathiasbynens/he) [![Dependency status](https://gemnasium.com/mathiasbynens/he.png)](https://gemnasium.com/mathiasbynens/he)

_he_ (for “HTML entities”) is a robust HTML entity encoder/decoder written in JavaScript. It supports [all standardized named character references as per HTML](http://www.whatwg.org/specs/web-apps/current-work/multipage/named-character-references.html), handles [ambiguous ampersands](http://mathiasbynens.be/notes/ambiguous-ampersands) and other edge cases [just like a browser would](http://www.whatwg.org/specs/web-apps/current-work/multipage/tokenization.html#tokenizing-character-references), has an extensive test suite, and — contrary to many other JavaScript solutions — _he_ handles astral Unicode symbols just fine. [An online demo is available.](http://mothereff.in/html-entities)

Via [Component](https://github.com/component/component):

In [Narwhal](http://narwhaljs.org/), [Node.js](http://nodejs.org/), and [RingoJS](http://ringojs.org/):

In [Rhino](http://www.mozilla.org/rhino/):

Using an AMD loader like [RequireJS](http://requirejs.org/):

A string representing the semantic version number.

This function takes a string of text and encodes any symbols that aren’t printable ASCII symbols and that can be replaced with character references. For example, it would turn `©` into `&#xA9;`, but it wouldn’t turn `+` into `&#x2B;` or `&plus;` since there is no point in doing so. Additionally, it replaces any remaining non-ASCII symbols with a hexadecimal escape sequence (e.g. `&#x1D306;`). The return value of this function is always valid HTML.

he.encode('foo © bar ≠ baz 𝌆 qux');

// → 'foo &#xA9; bar &#x2260; baz &#x1D306; qux'

The `options` object is optional. It recognizes the following properties:

The default value for the `useNamedReferences` option is `false`. This means that `encode()` will not use any named character references (e.g. `&copy;`) in the output — hexadecimal escapes (e.g. `&#xA9;`) will be used instead. Set it to `true` to enable the use of named references.

**Note that if compatibility with older browsers is a concern, this option should remain disabled.**

// Using the global default setting (defaults to `false`):

// Passing an `options` object to `encode`, to explicitly disallow named references:

he.encode('foo © bar ≠ baz 𝌆 qux', {

// Passing an `options` object to `encode`, to explicitly allow named references:

// → 'foo &copy; bar &ne; baz &#x1D306; qux'

#### Overriding default `encode` options globally

To use the `he` binary in your shell, simply install he globally using npm:

To use the `he` binary in your shell, simply install _he_ globally using npm:

After that you will be able to encode/decode HTML entities from the command line:

$ he --decode 'f&#xF6;o &#x2665; b&#xE5;r &#x1D306; baz'

$ he --encode --use-named-refs 'föo ♥ bår 𝌆 baz'

f&ouml;o &hearts; b&aring;r &#x1D306; baz

$ he --decode 'f&ouml;o &hearts; b&aring;r &#x1D306; baz'

Read a local text file, encode it for use in an HTML text context, and save the result to a new file:

$ he --encode < foo.txt > foo-escaped.html

$ curl -sL "http://git.io/HnfEaw" | he --encode > escaped.html

Or, the opposite — read a local file containing a snippet of HTML in a text context, decode it back to plain text, and save the result to a new file:

$ he --decode < foo-escaped.html > foo.txt

Or do the same with an online HTML snippet:

$ curl -sL "http://git.io/HnfEaw" | he --decode > decoded.txt

See `he --help` for the full list of options.

he has been tested in at least Chrome 27-29, Firefox 3-22, Safari 4-6, Opera 10-12, IE 6-10, Node.js v0.10.0, Narwhal 0.3.2, RingoJS 0.8-0.9, PhantomJS 1.9.0, and Rhino 1.7RC4.

After cloning this repository, run `npm install` to install the dependencies needed for he development and testing. You may want to install Istanbul _globally_ using `npm install istanbul -g`.

Once that’s done, you can run the unit tests in Node using `npm test` or `node tests/tests.js`. To run the tests in Rhino, Ringo, Narwhal, and web browsers as well, use `grunt test`.

To generate [the code coverage report](http://rawgithub.com/mathiasbynens/he/master/coverage/he/he.js.html), use `grunt cover`.

Thanks to [Simon Pieters](http://simon.html5.org/) (@zcorpan) for the many suggestions.

| [![twitter/mathias](http://gravatar.com/avatar/24e08a9ea84deb17ae121074d0f17125?s=70)](http://twitter.com/mathias "Follow @mathias on Twitter") |

| [Mathias Bynens](http://mathiasbynens.be/) |

_he_ is available under the [MIT](http://mths.be/mit) license.

		{
		"name": "he",
		"version": "0.3.2",
		"version": "0.3.3",
		"description": "A robust HTML entities encoder/decoder with full Unicode support.",
		@@ -5,0 +5,0 @@ "homepage": "http://mths.be/he",

		@@ -204,3 +204,3 @@ # he [![Build status](https://travis-ci.org/mathiasbynens/he.png?branch=master)](https://travis-ci.org/mathiasbynens/he) [![Dependency status](https://gemnasium.com/mathiasbynens/he.png)](https://gemnasium.com/mathiasbynens/he)

		To use the `he` binary in your shell, simply install he globally using npm:
		To use the `he` binary in your shell, simply install _he_ globally using npm:

		@@ -215,4 +215,8 @@ ```bash
		$ he --encode 'föo ♥ bår 𝌆 baz'
		föo ♥ bår 𝌆 baz

		$ he --decode 'föo ♥ bår 𝌆 baz'
		$ he --encode --use-named-refs 'föo ♥ bår 𝌆 baz'
		föo &hearts; bår 𝌆 baz

		$ he --decode 'föo &hearts; bår 𝌆 baz'
		föo ♥ bår 𝌆 baz
		@@ -219,0 +223,0 @@ ```

Improved metrics