lix-website/themes/lix/assets/bootstrap/node_modules/load-json-file/readme.md
2024-04-26 22:49:34 -06:00

1.3 KiB

load-json-file Build Status

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.

License

MIT © Sindre Sorhus