forked from lix-project/lix-website
.. | ||
node_modules | ||
index.d.ts | ||
index.js | ||
license | ||
package.json | ||
readme.md |
load-json-file ![Build Status](https://travis-ci.org/sindresorhus/load-json-file.svg?branch=master)
Read and parse a JSON file
Strips UTF-8 BOM, uses graceful-fs
, and throws more helpful JSON errors.
Install
$ npm install load-json-file
Usage
const loadJsonFile = require('load-json-file');
loadJsonFile('foo.json').then(json => {
console.log(json);
//=> {foo: true}
});
API
loadJsonFile(filePath, [options])
Returns a promise for the parsed JSON.
loadJsonFile.sync(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.
Related
- write-json-file - Stringify and write JSON to a file atomically
License
MIT © Sindre Sorhus