Upgrade Ava to v4

This commit is contained in:
Henry Mercer 2022-02-01 18:01:11 +00:00
parent 9a40cc5274
commit ce89f1b611
1153 changed files with 27264 additions and 95308 deletions

View file

@ -1,9 +1,8 @@
# load-json-file [![Build Status](https://travis-ci.org/sindresorhus/load-json-file.svg?branch=master)](https://travis-ci.org/sindresorhus/load-json-file)
# load-json-file
> Read and parse a 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).
It also [strips UTF-8 BOM](https://github.com/sindresorhus/strip-bom).
## Install
@ -11,32 +10,28 @@
$ npm install load-json-file
```
## Usage
```js
const loadJsonFile = require('load-json-file');
import {loadJsonFile} from 'load-json-file';
loadJsonFile('foo.json').then(json => {
console.log(json);
//=> {foo: true}
});
console.log(await loadJsonFile('foo.json'));
//=> {foo: true}
```
## API
### loadJsonFile(filePath, [options])
### loadJsonFile(filePath, options?)
Returns a promise for the parsed JSON.
Returns a `Promise<unknown>` with the parsed JSON.
### loadJsonFile.sync(filepath, [options])
### loadJsonFileSync(filepath, options?)
Returns the parsed JSON.
#### options
Type: `Object`
Type: `object`
##### beforeParse
@ -50,12 +45,12 @@ Type: `Function`
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.
## 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.](https://tidelift.com/subscription/pkg/npm-load-json-file?utm_source=npm-load-json-file&utm_medium=referral&utm_campaign=enterprise&utm_term=repo)
## Related
- [write-json-file](https://github.com/sindresorhus/write-json-file) - Stringify and write JSON to a file atomically
## License
MIT © [Sindre Sorhus](https://sindresorhus.com)