read-json-sync

What is read-json-sync?

The read-json-sync npm package is a simple utility for reading JSON files synchronously in Node.js. It is useful for scenarios where you need to load configuration files or other JSON data during the initialization phase of your application.

What are read-json-sync's main functionalities?

Read JSON File

This feature allows you to read a JSON file synchronously and parse its contents into a JavaScript object. The file path is provided as an argument to the readJsonSync function.

const readJsonSync = require('read-json-sync');
const data = readJsonSync('path/to/your/file.json');
console.log(data);

Handle Non-Existent Files

This feature demonstrates how to handle errors when attempting to read a non-existent JSON file. The readJsonSync function will throw an error if the file does not exist, which can be caught and handled appropriately.

const readJsonSync = require('read-json-sync');
try {
  const data = readJsonSync('path/to/nonexistent/file.json');
  console.log(data);
} catch (error) {
  console.error('File not found:', error.message);
}

Other packages similar to read-json-sync

jsonfile

The jsonfile package provides both synchronous and asynchronous methods for reading and writing JSON files. It offers more flexibility compared to read-json-sync, as it supports both sync and async operations.

fs-extra

The fs-extra package extends the native Node.js fs module with additional methods, including readJsonSync and writeJsonSync. It provides a more comprehensive set of file system utilities, making it a more versatile choice for file operations.

node-json-db

The node-json-db package is a simple JSON-based database that allows you to read and write JSON data. It offers more advanced features like querying and updating JSON data, which go beyond the basic functionality of read-json-sync.

README

read-json-sync

A Node.js module to read and parse a JSON file synchronously

const readJsonSync = require('read-json-sync');

readJsonSync('package.json'); //=> {name: 'read-json-sync', version: '1.0.0', ...}

Node.js built-in require and import can do almost the same thing, but this module doesn't cache results.

Installation

Use npm.

npm install read-json-sync

API

const readJsonSync = require('read-json-sync');

readJsonSync(path [, options])

path: string Buffer URL (JSON filename) or integer (file descriptor)
options: Object string (fs.readFile options or an encoding of the file)
Return: any (parsed JSON data)

It automatically ignores the leading byte order mark.

// with-bom.json: '\uFEFF{"a": 1}'

JSON.parse('\uFEFF{"a": 1}'); // throws a SyntaxError

readJsonSync('with-bom.json'); //=> {a: 1}

License

Creative Commons Zero v1.0 Universal