https://github.com/sindresorhus/load-json-file

Read and parse a JSON file
https://github.com/sindresorhus/load-json-file

Last synced: about 23 hours ago
JSON representation

Read and parse a JSON file

• Host: GitHub
• URL: https://github.com/sindresorhus/load-json-file
• Owner: sindresorhus
• License: mit
• Created: 2015-09-02T06:38:15.000Z (over 9 years ago)
• Default Branch: main
• Last Pushed: 2023-05-17T10:53:06.000Z (over 1 year ago)
• Last Synced: 2025-01-03T15:06:33.335Z (8 days ago)
• Language: JavaScript
• Size: 31.3 KB
• Stars: 245
• Watchers: 8
• Forks: 47
• Open Issues: 0
• Metadata Files:
  • Readme: readme.md
  • Funding: .github/funding.yml
  • License: license
  • Security: .github/security.md

Awesome Lists containing this project

• awesome-nodejs-cn - load-json-file - 读取、解析 JSON 文件 (包 / 文件系统)
• awesome-nodejs - load-json-file - Read and parse a JSON file.  (Repository / Object / JSON / JSON Schema)
• awesome-nodejs - load-json-file - Read and parse a JSON file. (Packages / Filesystem)
• awesome-nodejs - load-json-file - Read and parse a JSON file - ★ 122 (Filesystem)
• awesome-node - load-json-file - Read and parse a JSON file. (Packages / Filesystem)
• awesome-nodejs-cn - load-json-file - 读取解析JSON文件. (目录 / 文件系统)
• awesome-nodejs - load-json-file - Read and parse a JSON file (Uncategorized / Uncategorized)
• awesome-nodejs-cn - load-json-file - **star:246** 读取和解析JSON文件 (包 / 文件系统)

README

        
# load-json-file

> Read and parse a JSON file

It also strips UTF-8 [byte order mark](https://en.wikipedia.org/wiki/Byte_order_mark#UTF-8) (BOM).

## Install

```

$ npm install load-json-file

```

## Usage

```js

import {loadJsonFile} from 'load-json-file';

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

//=> {foo: true}

```

## API

### loadJsonFile(filePath, options?)

Returns a `Promise` 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](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