jsonx-js

JSONx javascript binding.

Usage no npm install needed!

<script type="module">
  import jsonxJs from 'https://cdn.skypack.dev/jsonx-js';
</script>

README

JSONx-js

  • JSONx is a superset of JSON, meaning a valid JSON string is automatically a valid JSONx string.
  • JSONx is not intended to replace JSON, instead, it is intended to be translated to JSON.
  • JSONx-js is the Javascript binding of JSONx. It helps to translate a JSONx string to a JSON string.

Installation

npm install jsonx-js

Examples

{
    // keys are not necessary to be quoted
    name: "jsonx",

    /* This is also a comment.  */
    url: "http://jsonx.org",

    /*
        Here is some more comments
        which span across multi lines.
    */
    "languages-bindings": ["Javascript", "Golang",],

    /*
        Tailing comma is not a problem.
        Multiline text also works.
    */

    description: `Multiline text is translated into an array
of strings. JSONx makes JSON easier to use for
configuration files.`,
}

The JSONx above should produce the following JSON:

{
  "name": "jsonx",
  "url": "http://jsonx.org",
  "languages-bindings": [
    "Javascript",
    "Golang"
  ],
  "description": [
    "Multiline text is translated into an array",
    "of strings. JSONx makes JSON easier to use for",
    "configuration files."
  ]
}

Code in Node.js

var jsonx = require('jsonx-js');
var jsonxString = '...';
var jsonString = jsonx.toJSON(jsonxString);
console.log(jsonString);

Code in browsers

<script src="path/to/jsonx.js"></script>
<script>
    var jsonxString = '...';
    var jsonString = jsonx.toJSON(jsonxString);
    console.log(jsonString);
</script>