diff --git a/README.md b/README.md index 9c0081b..aeb9661 100644 --- a/README.md +++ b/README.md @@ -1,7 +1,7 @@ Serialize JavaScript ==================== -Serialize JavaScript to a _superset_ of JSON that includes regular expressions and functions. +Serialize JavaScript to a _superset_ of JSON that includes regular expressions, dates and functions. [![npm Version][npm-badge]][npm] [![Dependency Status][david-badge]][david] @@ -11,7 +11,7 @@ Serialize JavaScript to a _superset_ of JSON that includes regular expressions a The code in this package began its life as an internal module to [express-state][]. To expand its usefulness, it now lives as `serialize-javascript` — an independent package on npm. -You're probably wondering: **What about `JSON.stringify()`!?** We've found that sometimes we need to serialize JavaScript **functions** and **regexps**. A great example is a web app that uses client-side URL routing where the route definitions are regexps that need to be shared from the server to the client. +You're probably wondering: **What about `JSON.stringify()`!?** We've found that sometimes we need to serialize JavaScript **functions**, **regexps** or **dates**. A great example is a web app that uses client-side URL routing where the route definitions are regexps that need to be shared from the server to the client. The string returned from this package's single export function is literal JavaScript which can be saved to a `.js` file, or be embedded into an HTML document by making the content of a `')).to.equal('"\\u003C\\u002Fscript\\u003E"'); @@ -197,6 +217,7 @@ describe('serialize( obj )', function () { expect(serialize(fn, {isJSON: false})).to.equal('function fn() { return true; }'); expect(serialize(fn, {isJSON: true})).to.equal('undefined'); + expect(serialize([1], {isJSON: true, space: 2})).to.equal('[\n 1\n]'); }); });