151 lines
8.7 KiB
Markdown
151 lines
8.7 KiB
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"));
|
|
```
|
|
|
|
|
|
|
|
## :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.
|
|
|
|
|
|
|
|
## :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:
|
|
|
|
|
|
- [`alfred-melon-youtube`](https://github.com/hyunchel/alfred-melon-youtube#readme) (by Hyunchel Kim)—Enjoy Melon chart music on Youtube playlist.
|
|
- [`auto-geo-sunset`](https://github.com/aminnaggar/auto-geo-sunset#readme) (by Amin El-Naggar)—Automagically figures out your location using your ip, and uses that to calculate the time of sunset.
|
|
- [`bible`](https://github.com/BibleJS/BibleApp)—Read the Holy Bible via the command line.
|
|
- [`birthday`](https://github.com/IonicaBizau/birthday)—Know when a friend's birthday is coming.
|
|
- [`blah`](https://github.com/IonicaBizau/blah)—A command line tool to optimize the repetitive actions.
|
|
- [`bloggify-plugin-class`](https://github.com/Bloggify/plugin-class#readme) (by Bloggify)—A library for managing plugin objects.
|
|
- [`cdnjs-importer`](https://github.com/cdnjs/cdnjs-importer)—Easy way to import a library into CDNJS.
|
|
- [`chewb-youtube-uploader`](https://github.com/samradical/youtube-uploader) (by Sam Elie)—Wrapper tool around a great uploader.
|
|
- [`cli-sunset`](https://github.com/IonicaBizau/cli-sunset)—A fancy command line tool for knowing the sunset time.
|
|
- [`edit-json-file`](https://github.com/IonicaBizau/edit-json-file#readme)—Edit a json file with ease.
|
|
- [`emojic`](https://github.com/IonicaBizau/emojic#readme)—Emoji in your Node.js command line apps.
|
|
- [`engine-app`](https://github.com/jillix/engine-app#readme) (by jillix)—Engine app related helper functions.
|
|
- [`engine-composition-crud`](https://github.com/jillix/engine-composition-crud#readme) (by jillix)—The default module for creating, reading, updating and deleting Engine instances.
|
|
- [`engine-parser`](https://github.com/IonicaBizau/engine-parser) (by jillix)—Engine composition parser.
|
|
- [`engine-tools`](https://github.com/jillix/engine-tools) (by jillix)—Engine Tools library and CLI app.
|
|
- [`gh-notifier`](https://bitbucket.org/IonicaBizau/gh-notifier#readme)—Receive desktop notifications from your GitHub dashboard.
|
|
- [`ghcal`](https://github.com/IonicaBizau/ghcal)—See the GitHub contributions calendar of a user in the command line.
|
|
- [`git-package-json`](https://github.com/IonicaBizau/git-package-json#readme)—Get the package.json contents from git repositories.
|
|
- [`git-stats`](https://github.com/IonicaBizau/git-stats)—Local git statistics including GitHub-like contributions calendars.
|
|
- [`github-labeller`](https://github.com/IonicaBizau/github-labeller#readme)—Automagically create issue labels in your GitHub projects.
|
|
- [`gpm`](https://github.com/IonicaBizau/gpm)—npm + git = gpm - Install NPM packages and dependencies from git repositories.
|
|
- [`idea`](https://github.com/IonicaBizau/idea)—A lightweight CLI tool and module for keeping ideas in a safe place quick and easy.
|
|
- [`made-in-brazil`](https://github.com/IonicaBizau/made-in-brazil#readme)—A list of neat projects made in Brazil.
|
|
- [`made-in-india`](https://github.com/IonicaBizau/made-in-india#readme)—A list of neat projects made in India.
|
|
- [`made-in-romania`](https://github.com/IonicaBizau/made-in-romania#readme)—A list of cool projects made in Romania.
|
|
- [`namy`](https://github.com/IonicaBizau/namy)—Gets the name of the exported function.
|
|
- [`np-init`](https://github.com/IonicaBizau/np-init#readme)—Easily start a npm package from scratch.
|
|
- [`packy`](https://github.com/IonicaBizau/packy#readme)—Set default fields in your package.json files.
|
|
- [`r-package-json`](https://github.com/IonicaBizau/r-package-json#readme)—Read package.json files.
|
|
- [`safe-r-json`](https://github.com/IonicaBizau/safe-r-json#readme)—A convenient JSON file reader.
|
|
- [`ship-release`](https://github.com/IonicaBizau/ship-release#readme)—Publish new versions on GitHub and npm with ease.
|
|
- [`test-youtube-api`](https://github.com/IonicaBizau/test-youtube-api)—Test Youtube API NodeJS module
|
|
- [`tilda`](https://github.com/IonicaBizau/tilda)—Tiny module for building command line tools.
|
|
- [`tithe`](https://github.com/IonicaBizau/tithe)—Organize and track the tithe payments.
|
|
- [`web-term`](https://github.com/IonicaBizau/web-term)—A full screen terminal in your browser.
|
|
- [`youtube-album-uploader`](https://github.com/jpchip/youtube-album-uploader) (by Jared Chapiewsky)—Uploads an mp3 album to Youtube
|
|
- [`youtube-album-uploader-multiple`](https://github.com/Chnapy/youtube-album-uploader-multiple) (by Richard Haddad)—Uploads multiple mp3 files to youtube
|
|
|
|
## :scroll: License
|
|
|
|
[MIT][license] © [Ionică Bizău][website]
|
|
|
|
|
|
[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
|
|
|
|
[license]: http://showalicense.com/?fullname=Ionic%C4%83%20Biz%C4%83u%20%3Cbizauionica%40gmail.com%3E%20(https%3A%2F%2Fionicabizau.net)&year=2015#license-mit
|
|
[website]: https://ionicabizau.net
|
|
[contributing]: /CONTRIBUTING.md
|
|
[docs]: /DOCUMENTATION.md
|