he - npm Package Compare versions

Comparing version 0.4.0 to 0.4.1

package.json

 {
 	"name": "he",
-	"version": "0.4.0",
+	"version": "0.4.1",
 	"description": "A robust HTML entities encoder/decoder with full Unicode support.",
@@ -58,5 +58,6 @@ "homepage": "http://mths.be/he",
 		"qunitjs": "~1.11.0",
-		"regenerate": "~0.6.1",
-		"requirejs": "~2.1.11"
+		"regenerate": "~0.6.2",
+		"requirejs": "~2.1.11",
+		"string.fromcodepoint": "~0.2.0"
 	}
 }

README.md

@@ -67,3 +67,3 @@ # he [![Build status](https://travis-ci.org/mathiasbynens/he.svg?branch=master)](https://travis-ci.org/mathiasbynens/he) [![Dependency status](https://gemnasium.com/mathiasbynens/he.svg)](https://gemnasium.com/mathiasbynens/he)
 
-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.
+This function takes a string of text and encodes (by default) any symbols that aren’t printable ASCII symbols and `&`, `<`, `>`, `"`, `'`, and `` ` ``, replacing them with character references.
 
@@ -75,2 +75,9 @@ ```js
 
+As long as the input string contains [allowed code points](http://www.whatwg.org/specs/web-apps/current-work/multipage/parsing.html#preprocessing-the-input-stream) only, the return value of this function is always valid HTML. Any [(invalid) code points that cannot be represented using a character reference](http://www.whatwg.org/specs/web-apps/current-work/multipage/tokenization.html#table-charref-overrides) in the input are not encoded.
+
+```js
+he.encode('foo \0 bar');
+// → 'foo \0 bar'
+```
+
 The `options` object is optional. It recognizes the following properties:
@@ -125,2 +132,24 @@
 
+#### `strict`
+
+The default value for the `strict` option is `false`. This means that `encode()` will encode any HTML text content you feed it, even if it contains any symbols that cause [parse errors](http://www.whatwg.org/specs/web-apps/current-work/multipage/parsing.html#preprocessing-the-input-stream). To throw an error when such invalid HTML is encountered, set the `strict` option to `true`. This option makes it possible to use _he_ as part of HTML parsers and HTML validators.
+
+```js
+// Using the global default setting (defaults to `false`, i.e. error-tolerant mode):
+he.encode('\x01');
+// → '&#x1;'
+
+// Passing an `options` object to `encode`, to explicitly enable error-tolerant mode:
+he.encode('\x01', {
+  'strict': false
+});
+// → '&#x1;'
+
+// Passing an `options` object to `encode`, to explicitly enable strict mode:
+he.encode('\x01', {
+  'strict': true
+});
+// → Parse error
+```
+
 #### Overriding default `encode` options globally
@@ -156,3 +185,3 @@
 
-The default value for the `isAttributeValue` option is `false`. This means that `decode()` will decode the string as if it were used in a text context in an HTML document. HTML has different rules for parsing character references in attribute values — set this option to `true` to treat the input string as if it were used as an attribute value.
+The default value for the `isAttributeValue` option is `false`. This means that `decode()` will decode the string as if it were used in [a text context in an HTML document](http://www.whatwg.org/specs/web-apps/current-work/multipage/tokenization.html#data-state). HTML has different rules for [parsing character references in attribute values](http://www.whatwg.org/specs/web-apps/current-work/multipage/tokenization.html#character-reference-in-attribute-value-state) — set this option to `true` to treat the input string as if it were used as an attribute value.
 
@@ -218,3 +247,3 @@ ```js
 
-This function takes a string of text and escapes it for use in text contexts in XML or HTML documents. Only the following characters are escaped: `&`, `<`, `>`, `"`, and `'`.
+This function takes a string of text and escapes it for use in text contexts in XML or HTML documents. Only the following characters are escaped: `&`, `<`, `>`, `"`, `'`, and `` ` ``.
 
@@ -221,0 +250,0 @@ ```js

No alert changes

Improved metrics

Total package byte prevSize

104765

increased by2.72%

Lines of code

586

increased by3.17%

Number of lines in readme file

326

increased by9.76%

Worsened metrics

Dev dependency count

12

increased by9.09%

No dependency changes