Blame view

node_modules/load-json-file/readme.md 951 Bytes
aaac7fed   liuqimichale   add
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
  # load-json-file [![Build Status](https://travis-ci.org/sindresorhus/load-json-file.svg?branch=master)](https://travis-ci.org/sindresorhus/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).
  
  
  ## Install
  
  ```
  $ npm install --save load-json-file
  ```
  
  
  ## Usage
  
  ```js
  const loadJsonFile = require('load-json-file');
  
  loadJsonFile('foo.json').then(json => {
  	console.log(json);
  	//=> {foo: true}
  });
  ```
  
  
  ## API
  
  ### loadJsonFile(filepath)
  
  Returns a promise that resolves to the parsed JSON.
  
  ### loadJsonFile.sync(filepath)
  
  Returns the parsed JSON.
  
  
  ## Related
  
  - [write-json-file](https://github.com/sindresorhus/write-json-file) - Stringify and write JSON to a file atomically
  
  
  ## License
  
  MIT © [Sindre Sorhus](http://sindresorhus.com)