ujson
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
anddata
, wheredata
is a parsed object with the file content in JSON format, anderror
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;
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;
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 objectvar obj_parent = key1: 'value1' key2: 'value2' key3: 'value3' ; //Child objectvar obj_child = key4: 'value4' ; //Extendvar obj_extended = ujson; //Show extended objectconsole; //-> { key4: 'value4', key1: 'value1', key2: 'value2' }
License
MIT LICENSE.