r-json

A small module to read JSON files.

If you want to write JSON files, check out w-json.

:cloud: Installation

# Using npm
npm install --save r-json

# Using yarn
yarn add r-json

:clipboard: Example

// Dependencies
var ReadJson = require("r-json");

// Read the json file asynchronously
ReadJson(__dirname + "/test.json", function (err, data) {
    console.log(err || data);
});

// Read the same file synchronously
console.log(ReadJson(__dirname + "/test.json"));

// Read another JSON file asynchronously, with a default value and a custom w_json config
ReadJson.defaultRead(
    "./test2.json",
    {myDefaultKey: "myDefaultValue"},
    { new_line: true, space: 4},
    function (err, data) {
        console.log(err || data);
    }
);

// Read the other JSON file synchronously, with a default value
console.log(
    ReadJson.defaultRead(
        "./test2.json",
        {myDefaultKey: "myDefaultValue"}
    )
);

:question: Get Help

There are few ways to get help:

Please post questions on Stack Overflow. You can open issues with questions, as long you add a link to your Stack Overflow question.
For bug reports and feature requests, open issues. :bug:
For direct and quick help, you can use Codementor. :rocket:

:memo: Documentation

`rJson(path, callback)`

Params

String path: The JSON file path.
Function callback: An optional callback. If not passed, the function will run in sync mode.

`rJson_default(path, def_value, w_json_options, callback)`

If there is some error in reading the JSON file, this would overwrite the file with the default value and return the same. This uses node-w-json for writing the default JSON value and so you can pass configs to node-w-json to beautify the file written

Params

String path: The JSON file path.
Object def_value: The Default Value
Object|Number|Boolean w_json_options: Optional: w-json config object containing the fields below. If boolean, it will be handled as new_line, if number it will be handled as space.
space (Number): An optional space value for beautifying the json output (default: 2).
new_line (Boolean): If true, a new line character will be added at the end of the stringified content.
Function callback: An optional callback. If not passed, the function will run in sync mode.

:yum: How to contribute

Have an idea? Found a bug? See how to contribute.

:sparkling_heart: Support my projects

I open-source almost everything I can, and I try to reply to everyone needing help using these projects. Obviously, this takes time. You can integrate and use these projects in your applications for free! You can even change the source code and redistribute (even resell it).

However, if you get some profit from this or just want to encourage me to continue creating stuff, there are few ways you can do it:

Starring and sharing the projects you like :rocket:
—I love books! I will remember you after years if you buy me one. :grin: :book:
—You can make one-time donations via PayPal. I'll probably buy a ~~coffee~~ tea. :tea:
—Set up a recurring monthly donation and you will get interesting news about what I'm doing (things that I don't share with everyone).
Bitcoin—You can send me bitcoins at this address (or scanning the code below): 1P9BRsmazNQcuyTxEqveUsnf5CERdq35V6

Thanks! :heart:

:dizzy: Where is this library used?

If you are using this library in one of your projects, add it in this list. :sparkles:

edit-json-file
emojic
tilda
r-package-json
git-package-json
safe-r-json
git-stats
bloggify-plugin-class
namy
@acegoal07/file-tools
ghcal
engine-tools
np-init
web-term
blah
packy
made-in-romania
made-in-brazil
github-labeller
gpm
engine-app
engine-composition-crud
@dottjt/mediareade
tithe
youtube-album-uploader
youtube-album-uploader-multiple
auto-geo-sunset
test-youtube-api
alfred-melon-youtube
cli-sunset
chewb-youtube-uploader
birthday
engine-parser
generator-bootstrap-boilerplate-template
bible
gh-notifier
ship-release
@acegoal07/json-editor
@everything-registry/sub-chunk-2519
cdnjs-importer
angularvezba
made-in-india
idea

r-json

:cloud: Installation

:clipboard: Example

:question: Get Help

:memo: Documentation

`rJson(path, callback)`

Params

`rJson_default(path, def_value, w_json_options, callback)`

Params

:yum: How to contribute

:sparkling_heart: Support my projects

:dizzy: Where is this library used?

:scroll: License

Current Tags

15 Versions