sindresorhus

load-json-file

	type Reviver = (this: unknown, key: string, value: any) => unknown;

	type BeforeParse = (data: string) => string;

		Applies a function to the JSON string before parsing.

		Prescribes how the value originally produced by parsing is transformed, before being returned.

		See the [`JSON.parse` docs](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/JSON/parse#Using_the_reviver_parameter) for more.

	Strips UTF-8 BOM, uses graceful-fs, and throws more helpful JSON errors.

	import loadJsonFile = require('load-json-file');

		const json = await loadJsonFile('foo.json');

	<T = JsonValue>(filePath: string, options?: loadJsonFile.Options): Promise<T>;

	const json = loadJsonFile.sync('foo.json');

	sync<T = JsonValue>(filePath: string, options?: loadJsonFile.Options): T;

	// TODO: Remove this for the next major release

const parse = (data, filePath, options = {}) => {

	if (typeof options.beforeParse === 'function') {

	return parseJson(data, options.reviver, path.relative(process.cwd(), filePath));

const loadJsonFile = (filePath, options) => pify(fs.readFile)(filePath, 'utf8').then(data => parse(data, filePath, options));

// TODO: Remove this for the next major release

module.exports = async (filePath, options) => parse(await promisify(fs.readFile)(filePath, 'utf8'), filePath, options);

module.exports.sync = (filePath, options) => parse(fs.readFileSync(filePath, 'utf8'), filePath, options);

	"description": "Read and parse a JSON file",

	"repository": "sindresorhus/load-json-file",

# load-json-file [![Build Status](https://travis-ci.org/sindresorhus/load-json-file.svg?branch=master)](https://travis-ci.org/sindresorhus/load-json-file)

[Strips UTF-8 BOM](https://github.com/sindresorhus/strip-bom), uses [`graceful-fs`](https://github.com/isaacs/node-graceful-fs), and throws more [helpful JSON errors](https://github.com/sindresorhus/parse-json).

const loadJsonFile = require('load-json-file');

	console.log(await loadJsonFile('foo.json'));

Returns a `Promise<unknown>` with the parsed JSON.

### loadJsonFile.sync(filepath, [options])

Applies a function to the JSON string before parsing.

Prescribes how the value originally produced by parsing is transformed, before being returned. See the [`JSON.parse` docs](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/JSON/parse#Using_the_reviver_parameter) for more.

- [write-json-file](https://github.com/sindresorhus/write-json-file) - Stringify and write JSON to a file atomically

		@@ -53,7 +53,4 @@ import {JsonValue} from 'type-fest';
		sync<T = JsonValue>(filePath: string, options?: loadJsonFile.Options): T;

		// TODO: Remove this for the next major release
		default: typeof loadJsonFile;
		};

		export = loadJsonFile;

		'use strict';
		const path = require('path');
		const {promisify} = require('util');
		const fs = require('graceful-fs');
		const stripBom = require('strip-bom');
		const parseJson = require('parse-json');
		const pify = require('pify');

		@@ -18,7 +18,3 @@ const parse = (data, filePath, options = {}) => {

		const loadJsonFile = (filePath, options) => pify(fs.readFile)(filePath, 'utf8').then(data => parse(data, filePath, options));

		module.exports = loadJsonFile;
		// TODO: Remove this for the next major release
		module.exports.default = loadJsonFile;
		module.exports = async (filePath, options) => parse(await promisify(fs.readFile)(filePath, 'utf8'), filePath, options);
		module.exports.sync = (filePath, options) => parse(fs.readFileSync(filePath, 'utf8'), filePath, options);

		{
		"name": "load-json-file",
		"version": "5.3.0",
		"version": "6.0.0",
		"description": "Read and parse a JSON file",
		@@ -13,3 +13,3 @@ "license": "MIT",
		"engines": {
		"node": ">=6"
		"node": ">=8"
		},
		@@ -35,5 +35,4 @@ "scripts": {
		"parse-json": "^4.0.0",
		"pify": "^4.0.1",
		"strip-bom": "^3.0.0",
		"type-fest": "^0.3.0"
		"type-fest": "^0.4.1"
		},
		@@ -40,0 +39,0 @@ "devDependencies": {

		@@ -20,6 +20,6 @@ # load-json-file [![Build Status](https://travis-ci.org/sindresorhus/load-json-file.svg?branch=master)](https://travis-ci.org/sindresorhus/load-json-file)

		loadJsonFile('foo.json').then(json => {
		console.log(json);
		(async () => {
		console.log(await loadJsonFile('foo.json'));
		//=> {foo: true}
		});
		})();
		```
		@@ -32,3 +32,3 @@

		Returns a promise for the parsed JSON.
		Returns a `Promise<unknown>` with the parsed JSON.

		@@ -41,3 +41,3 @@ ### loadJsonFile.sync(filepath, [options])

		Type: `Object`
		Type: `object`

		@@ -44,0 +44,0 @@ ##### beforeParse

Improved metrics

Worsened metrics

Dependency changes