@jsonurl/jsonurl

JSON→URL

About

RFC8259 describes the JSON data model and interchange format, which is widely used in application-level protocols including RESTful APIs. It is common for applications to request resources via the HTTP POST method, with JSON entities. However, POST is suboptimal for requests which do not modify a resource's state. JSON→URL defines a text format for the JSON data model suitable for use within a URL/URI.

Usage

JSON→URL is available as a commonjs module (suitable for use in Node), ES6 module, or a script that may be used directly in a browser.

NPM install

npm install @jsonurl/jsonurl --save

CJS

const JsonURL = require("@jsonurl/jsonurl");

ES6 (Node + Babel)

import JsonURL from "@jsonurl/jsonurl";

Browser script tag

<script
    src="https://cdn.jsdelivr.net/npm/@jsonurl/jsonurl@1.1.0"
    integrity="sha384-JCtJokkM2P1NvInO8p82t17dv0kqMRWhrgLU+H8KIHlev5bM9hot93290mWx50u9"
    crossorigin="anonymous"></script>

The JavaScript API

Once included, the API is the same for all three.

let value = JsonURL.parse( "(Hello:World!)" );
let string = JsonURL.stringify( value );

There are options available, but that's all you need to get started.

JSON→URL has no runtime dependencies.

Security

The parser is designed to parse untrusted input. It supports limits on the number of parsed values and depth of nested arrays or objects. When the limit is exceeded an Error is thrown, and sane limit values are set by default.

License

Changelog

v1.1.1

Added

• Add support for AQF syntax view commit
• Add parse and stringify option noEmptyComposite view commit
• Add getMissingValue() parse option view commit
• Add support for coercing null to empty string on parse/stringify view commit
• Add support for empty keys and empty string values view commit

Changed

• Ignore extraneous ampersands for wfu-implied-composite values view commit
• Upgrade dependencies view commit
• Fix bug when encoding more than one left/right paren in string literal view commit
• Upgrade multiple dependencies