@expo/json-file

What is @expo/json-file?

The @expo/json-file npm package is a utility library for reading and writing JSON files. It provides a simple and convenient API for these operations, handling various edge cases and providing helpful error messages.

What are @expo/json-file's main functionalities?

Read JSON file

This feature allows you to read a JSON file asynchronously and parse its contents into a JavaScript object.

{"const { readAsync } = require('@expo/json-file');

async function readJsonFile(filePath) {
  const json = await readAsync(filePath);
  return json;
}

readJsonFile('path/to/file.json').then(data => console.log(data));"}

Write JSON file

This feature enables you to write a JavaScript object to a file as JSON asynchronously, with options to format the output.

{"const { writeAsync } = require('@expo/json-file');

async function writeJsonFile(filePath, data) {
  await writeAsync(filePath, data);
}

const data = { key: 'value' };
writeJsonFile('path/to/file.json', data);"}

Modify JSON file

This feature allows you to modify an existing JSON file by providing an object with the modifications you want to apply.

{"const { modifyAsync } = require('@expo/json-file');

async function modifyJsonFile(filePath, modifications) {
  await modifyAsync(filePath, modifications);
}

modifyJsonFile('path/to/file.json', { key: 'newValue' });"}

Other packages similar to @expo/json-file

jsonfile

The 'jsonfile' package offers similar functionality to '@expo/json-file' for reading and writing JSON files. It provides methods like 'readFileSync', 'writeFileSync', 'readFile', and 'writeFile'. The main difference is that 'jsonfile' does not provide modification capabilities directly, and it has both synchronous and asynchronous methods.

fs-extra

While 'fs-extra' is a more general file system utility library, it includes methods for reading and writing JSON files, such as 'readJson', 'writeJson', 'readJsonSync', and 'writeJsonSync'. It extends the built-in 'fs' module in Node.js and provides additional file operation methods. It is more comprehensive but less specialized than '@expo/json-file'.

README

👋 Welcome to
@expo/json-file

A library for reading and writing JSON files.

🏁 Setup

Install @expo/json-file in your project.

yarn add @expo/json-file

⚽️ Usage

import JsonFile, { JSONObject } from '@expo/json-file';

// Create a file instance
const jsonFile = new JsonFile<JSONObject>(filePath);

// Interact with the file
await jsonFile.readAsync();
await jsonFile.writeAsync({ some: 'data' });