Sign Up for Free

RunKit +

Try any Node.js package right in your browser

This is a playground to test code. It runs a full Node.js environment and already has all of npm’s 400,000 packages pre-installed, including ujson with all npm packages installed. Try it out:

var ujson = require("ujson")

This service is provided by RunKit and is not affiliated with npm, Inc or the package authors.

ujson v1.0.3

Methods to work with json files and objects.

ujson

npm npm

Methods to work with JSON objects and files.

Installation

Install ujson using NPM:

npm install ujson

API

ujson.parse(str)

Parses a JSON string and builds the JavaScript value or object described by the string.

ujson.toString(obj, [ space])

Converts a JavaScript object to a JSON string. Accepts the following arguments:

  • obj: JavaScript object to converts to a string.
  • space: string or number that's used to insert white space into the output JSON string for readability purposes.

ujson.read(path, [options, ] callback)

Reads the content of a JSON file. Accepts the following arguments:

  • path: full path to the json file.
  • options: (optionally) object or string with the following options:
    • encoding: default: utf8.
  • callback: function that will be executed with two arguments: error and data, where data is a parsed object with the file content in JSON format, and error is an Error object (see https://nodejs.org/api/errors.html#errors_class_error) if there is an error reading the JSON file.

If options is a string, then it specifies the encoding. Example:

ujson.read('file.json', 'utf8', function(error, data)
{
  //Check for error
  if(error){ throw error; }

  //Show json content
  console.log(data);
});

ujson.readSync(path, [options])

Synchronous version of ujson.read. Returns a parsed object with the content of the json file.

ujson.write(path, object, [options, ] callback)

Write the object to the json file specified. Accepts the following arguments:

  • path: string with the filename.
  • object: json object that will be saved as a json file.
  • options (optionally) object or string with the following options:
    • encoding: default: utf8.
    • space: string or number that's used to insert white space into the output JSON string for readability purposes.
  • callback: function.

Example:

ujson.write('file.json', { key: 'value' }, { encoding: 'utf8', space: '\t' }, function(error)
{
  //Check for error
  if(err){ throw error; }

  //Do something....
});

ujson.writeSync(path, object, [options])

Synchronous version of ujson.write.

ujson.extend(child, parent, keys)

Extend a child object with the keys of a parent object. Example:

//Parent object
var obj_parent = { key1: 'value1', key2: 'value2', key3: 'value3' };

//Child object
var obj_child = { key4: 'value4' };

//Extend
var obj_extended = ujson.extend(obj_child, obj_parent, [ 'key1', 'key2' ]);

//Show  extended object
console.log(obj_extended); //-> { key4: 'value4', key1: 'value1', key2: 'value2' }

License

MIT LICENSE.

RunKit is a free, in-browser JavaScript dev environment for prototyping Node.js code, with every npm package installed. Sign up to share your code.
Sign Up for Free