Read and parse a JSON file
Package: load-json-file
Created by: sindresorhus
Last modified: Sat, 17 Jun 2023 00:08:15 GMT
Version: 7.0.1
License: MIT
Downloads: 80,476,664
Repository: https://github.com/sindresorhus/load-json-file
Install
npm install load-json-file
yarn add load-json-file
load-json-file
Read and parse a JSON file
It also strips UTF-8 BOM.
Install
$ npm install load-json-file
Usage
import {loadJsonFile} from 'load-json-file';
console.log(await loadJsonFile('foo.json'));
//=> {foo: true}
API
loadJsonFile(filePath, options?)
Returns a Promise<unknown> with the parsed JSON.
loadJsonFileSync(filepath, options?)
Returns the parsed JSON.
options
Type: object
beforeParse
Type: Function
Applies a function to the JSON string before parsing.
reviver
Type: Function
Prescribes how the value originally produced by parsing is transformed, before being returned. See the JSON.parse docs for more.
load-json-file for enterprise
Available as part of the Tidelift Subscription.
The maintainers of load-json-file and thousands of other packages are working with Tidelift to deliver commercial support and maintenance for the open source dependencies you use to build your applications. Save time, reduce risk, and improve code health, while paying the maintainers of the exact dependencies you use. Learn more.
Related
- write-json-file - Stringify and write JSON to a file atomically
