r-json
Version:
A small module to read JSON files.
291 lines (134 loc) • 6.46 kB
Markdown
<!-- Please do not edit this file. Edit the `blah` field in the `package.json` instead. If in doubt, open an issue. -->
# r-json
[![Support me on Patreon][badge_patreon]][patreon] [![Buy me a book][badge_amazon]][amazon] [![PayPal][badge_paypal_donate]][paypal-donations] [](https://github.com/IonicaBizau/ama) [](https://www.npmjs.com/package/r-json) [](https://www.npmjs.com/package/r-json) [](https://www.codementor.io/@johnnyb?utm_source=github&utm_medium=button&utm_term=johnnyb&utm_campaign=github)
<a href="https://www.buymeacoffee.com/H96WwChMy" target="_blank"><img src="https://www.buymeacoffee.com/assets/img/custom_images/yellow_img.png" alt="Buy Me A Coffee"></a>
> A small module to read JSON files.
If you want to write JSON files, check out [`w-json`](https://github.com/IonicaBizau/node-w-json).
## :cloud: Installation
```sh
# Using npm
npm install --save r-json
# Using yarn
yarn add r-json
```
## :clipboard: Example
```js
// 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:
1. Please [post questions on Stack Overflow](https://stackoverflow.com/questions/ask). You can open issues with questions, as long you add a link to your Stack Overflow question.
2. For bug reports and feature requests, open issues. :bug:
3. For direct and quick help, you can [use Codementor](https://www.codementor.io/johnnyb). :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](https://github.com/IonicaBizau/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][contributing].
## :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:
- [![Buy me a book][badge_amazon]][amazon]—I love books! I will remember you after years if you buy me one. :grin: :book:
- [![PayPal][badge_paypal]][paypal-donations]—You can make one-time donations via PayPal. I'll probably buy a ~~coffee~~ tea. :tea:
- [![Support me on Patreon][badge_patreon]][patreon]—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:
- `/file-tools`
- `/json-editor`
- `/mediareade`
- `/gpm`
- `alfred-melon-youtube`
- `angularvezba`
- `auto-geo-sunset`
- `bible`
- `birthday`
- `blah`
- `bloggify-plugin-class`
- `cdnjs-importer`
- `chewb-youtube-uploader`
- `cli-sunset`
- `edit-json-file`
- `emojic`
- `engine-app`
- `engine-composition-crud`
- `engine-parser`
- `engine-tools`
- `gh-notifier`
- `ghcal`
- `git-package-json`
- `git-stats`
- `github-labeller`
- `gpm`
- `idea`
- `made-in-brazil`
- `made-in-india`
- `made-in-romania`
- `markdownalint-cli2`
- `namy`
- `np-init`
- `packy`
- `r-package-json`
- `safe-r-json`
- `ship-release`
- `test-youtube-api`
- `tilda`
- `tithe`
- `tools_may_24`
- `web-term`
- `youtube-album-uploader`
- `youtube-album-uploader-multiple`
## :scroll: License
[MIT][license] © [Ionică Bizău][website]
[license]: /LICENSE
[website]: https://ionicabizau.net
[contributing]: /CONTRIBUTING.md
[docs]: /DOCUMENTATION.md
[badge_patreon]: https://ionicabizau.github.io/badges/patreon.svg
[badge_amazon]: https://ionicabizau.github.io/badges/amazon.svg
[badge_paypal]: https://ionicabizau.github.io/badges/paypal.svg
[badge_paypal_donate]: https://ionicabizau.github.io/badges/paypal_donate.svg
[patreon]: https://www.patreon.com/ionicabizau
[amazon]: http://amzn.eu/hRo9sIZ
[paypal-donations]: https://www.paypal.com/cgi-bin/webscr?cmd=_s-xclick&hosted_button_id=RVXDDLKKLQRJW