The r-json npm package is a simple utility for reading and parsing JSON files. It provides a straightforward way to load JSON data from a file and work with it in your Node.js applications.
Read JSON from a file
This feature allows you to read and parse JSON data from a specified file path. The parsed data is returned as a JavaScript object.
const rjson = require('r-json');
const data = rjson('path/to/your/file.json');
console.log(data);The 'fs' module is a built-in Node.js module that provides an API for interacting with the file system. It can be used to read JSON files by reading the file content and then parsing it with JSON.parse. Unlike r-json, 'fs' is more versatile and can handle various file operations beyond just reading JSON.
The 'jsonfile' package is a simple module for reading and writing JSON files. It provides methods for reading JSON files into JavaScript objects and writing JavaScript objects to JSON files. Compared to r-json, 'jsonfile' offers both read and write capabilities.
The 'node-fetch' package is a lightweight module that brings window.fetch to Node.js. It can be used to fetch JSON data from URLs and parse it. While it is not specifically for reading local JSON files like r-json, it is useful for working with JSON data from web APIs.
A small module to read JSON files.
If you want to write JSON files, check out w-json.
# Using npm
npm install --save r-json
# Using yarn
yarn add r-json
// 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"}
)
);
There are few ways to get help:
rJson(path, callback)path: The JSON file path.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
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.
Have an idea? Found a bug? See how to contribute.
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:
If you are using this library in one of your projects, add it in this list. :sparkles:
@acegoal07/file-tools@acegoal07/json-editor@dottjt/mediareade@isysd/gpmalfred-melon-youtubeangularvezbaauto-geo-sunsetbiblebirthdayblahbloggify-plugin-classcdnjs-importerchewb-youtube-uploadercli-sunsetedit-json-fileemojicengine-appengine-composition-crudengine-parserengine-toolsgh-notifierghcalgit-package-jsongit-statsgithub-labellergpmideamade-in-brazilmade-in-indiamade-in-romaniamarkdownalint-cli2namynp-initpackyr-package-jsonsafe-r-jsonship-releasetest-youtube-apitildatithetools_may_24web-termyoutube-album-uploaderyoutube-album-uploader-multipleFAQs
A small module to read JSON files.
The npm package r-json receives a total of 149,970 weekly downloads. As such, r-json popularity was classified as popular.
We found that r-json demonstrated a healthy version release cadence and project activity because the last version was released less than a year ago. It has 1 open source maintainer collaborating on the project.
Did you know?
Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.
Security News
OpenSSF has published OSPS Baseline, an initiative designed to establish a minimum set of security-related best practices for open source software projects.
Security News
Michigan TypeScript founder Dimitri Mitropoulos implements WebAssembly runtime in TypeScript types, enabling Doom to run after processing 177 terabytes of type definitions.
Security News
vlt's new "reproduce" tool verifies npm packages against their source code, outperforming traditional provenance adoption in the JavaScript ecosystem.