he - npm Package Compare versions

Comparing version 0.3.5 to 0.3.6

package.json

 {
 	"name": "he",
-	"version": "0.3.5",
+	"version": "0.3.6",
 	"description": "A robust HTML entities encoder/decoder with full Unicode support.",
@@ -52,4 +52,4 @@ "homepage": "http://mths.be/he",
 		"grunt-template": "~0.2.0",
-		"istanbul": "~0.1.42",
-		"jsesc": "~0.3.0",
+		"istanbul": "~0.1.43",
+		"jsesc": "~0.4.1",
 		"lodash": "~1.3.1",
@@ -56,0 +56,0 @@ "qunit-clib": "~1.3.0",

README.md

@@ -67,3 +67,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)
 
-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 `©`, but it wouldn’t turn `+` into `+` or `+` since there is no point in doing so. Additionally, it replaces any remaining non-ASCII symbols with a hexadecimal escape sequence (e.g. `𝌆`). The return value of this function is always valid HTML.
+This function takes a string of text and encodes (by default) any symbols that aren’t printable ASCII symbols, replacing them with character references. As long as the input string contains allowed code points only, the return value of this function is always valid HTML.
 
@@ -101,2 +101,25 @@ ```js
 
+#### `encodeEverything`
+
+The default value for the `encodeEverything` option is `false`. This means that `encode()` will not use any character references for printable ASCII symbols that don’t need escaping. Set it to `true` to encode every symbol in the input string.
+
+```js
+// Using the global default setting (defaults to `false`):
+he.encode('foo © bar ≠ baz 𝌆 qux');
+// → 'foo © bar ≠ baz 𝌆 qux'
+
+// Passing an `options` object to `encode`, to explicitly encode all symbols:
+he.encode('foo © bar ≠ baz 𝌆 qux', {
+  'encodeEverything': true
+});
+// → 'foo © bar ≠ baz 𝌆 qux'
+
+// This setting can be combined with the `useNamedReferences` option:
+he.encode('foo © bar ≠ baz 𝌆 qux', {
+  'encodeEverything': true,
+  'useNamedReferences': true
+});
+// → 'foo © bar ≠ baz 𝌆 qux'
+```
+
 #### Overriding default `encode` options globally
@@ -103,0 +126,0 @@

No alert changes

Improved metrics

Total package byte prevSize

101700

increased by2.5%

Lines of code

563

increased by6.43%

Number of lines in readme file

297

increased by8.39%

No dependency changes