JSURL2 Demo

About JSURL2

JSURL2 aims to be a drop-in replacement for JSON encoding with better size and time characteristics.

JSURL2 has been designed to be:

• Compact: shorter output than JSON
• Readable: leaves accented characters unchanged and doesn't add many characters for encoding
• URI-ready: encodes all query-string delimiters so you can embed it in a query string without extra URI encoding
• Embeddable: safe to put in <script> tags inside single-quoted JS strings (unlike JSON); added whitespace can be stripped
• Extensible: rich mode encodes/decodes Date objects, undefined, NaN and Infinity
• Easy upgrade: replace JSON.parse with JSURL.parse and JSON.stringify with JSURL.stringify; also parses plain JSON

Examples

Format	Value
JSON	{"name": "John Doé", "age": 42, "user": true, "children": ["Mary", "Bill"]}
JSON + URI encoding	%7B%22name%22%3A%22John%20Do%C3%A9%22%2C%22age%22%3A42%2C%22user%22%3Atrue%2C%22children%22%3A%5B%22Mary%22%2C%22Bill%22%5D%7D
JSURL2	(name~John_Doé~age~42~user~~children~!Mary~Bill)~
JSURL2 + URI encoding	(name~John_Do%C3%A9~age~42~user~~children~!Mary~Bill)~

API

var JSURL = require("jsurl2");

// Options:
// * `rich`: encode Date, `undefined`, `Infinity`
// * `short`: remove optional trailing delimiters
str = JSURL.stringify(obj[, options]);

// Options:
// * `deURI`: remove URI encoding and whitespace
obj = JSURL.parse(str[, options]);

// return `default` instead of throwing on error; options are passed to `parse()`
obj = JSURL.tryParse(str[, default][, options]);

Syntax

JSURL uses the allowable characters in URI schemes for multiple purposes depending on the location in the result. Some examples:

• ! starts an array if it is the first character in a value, but inside a string it is unchanged.
• ~ and ) are used as end-of-value and end-of-object delimiters, and are illegal inside encoded values.
• * starts a string, but can be left out if the first string character is a-z. Inside a string, it escapes special characters.
• Whitespace is never legal, so you can strip it before parsing if it can be introduced accidentally.

JSURL has a short mode, which omits unnecessary ending delimiters, saving a few more bytes.

Since browsers may choose to encode any character with URI escaping, decoding will work no matter how many encodings happened, if you pass the deURI: true option to the parser.

Source and full documentation on GitHub.