jsonfile

Reading JSON files

This feature allows you to read JSON files asynchronously. The readFile function takes a file path and a callback function that receives an error or the parsed JSON object.

const jsonfile = require('jsonfile');

jsonfile.readFile('/path/to/file.json', (err, obj) => {
  if (err) console.error(err);
  console.log(obj);
});

Writing JSON files

This feature allows you to write JSON objects to files asynchronously. The writeFile function takes a file path, the object to be written, and a callback function that is called upon completion or error.

const jsonfile = require('jsonfile');

const obj = {name: 'John', age: 30};
jsonfile.writeFile('/path/to/file.json', obj, (err) => {
  if (err) console.error(err);
});

Reading JSON files synchronously

This feature allows you to read JSON files synchronously, blocking the event loop until the file is read. The readFileSync function takes a file path and returns the parsed JSON object or throws an error.

const jsonfile = require('jsonfile');

try {
  const obj = jsonfile.readFileSync('/path/to/file.json');
  console.log(obj);
} catch (err) {
  console.error(err);
}

Writing JSON files synchronously

This feature allows you to write JSON objects to files synchronously, blocking the event loop until the file is written. The writeFileSync function takes a file path and the object to be written, and it will throw an error if the operation fails.

const jsonfile = require('jsonfile');

const obj = {name: 'Jane', age: 25};
try {
  jsonfile.writeFileSync('/path/to/file.json', obj);
} catch (err) {
  console.error(err);
}

Customizing JSON spacing

This feature allows you to customize the indentation of the JSON output. The writeFile and writeFileSync functions accept an options object where you can specify the number of spaces to use for indentation.

const jsonfile = require('jsonfile');

const obj = {name: 'Alice', age: 28};
jsonfile.writeFile('/path/to/file.json', obj, {spaces: 2}, (err) => {
  if (err) console.error(err);
});