blob: ab9162889a5e3bad45cecad2f89a7df7b9a45a27 (
plain)
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
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
|
# write-json-file [](https://travis-ci.org/sindresorhus/write-json-file)
> Stringify and write JSON to a file [atomically](https://github.com/npm/write-file-atomic)
Creates directories for you as needed.
## Install
```
$ npm install --save write-json-file
```
## Usage
```js
const writeJsonFile = require('write-json-file');
writeJsonFile('foo.json', {foo: true}).then(() => {
console.log('done');
});
```
## API
### writeJsonFile(filepath, data, [options])
Returns a `Promise`.
### writeJsonFile.sync(filepath, data, [options])
#### options
Type: `Object`
##### indent
Type: `string` `number`<br>
Default: `\t`
Indentation as a string or number of spaces.<br>
Pass in `null` for no formatting.
##### detectIndent
Type: `boolean`<br>
Default: `false`
Detect indentation automatically if the file exists.
##### sortKeys
Type: `boolean` `function`<br>
Default: `false`
Sort the keys recursively.<br>
Optionally pass in a [`compare`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Array/sort) function.
##### replacer
Type: `function`
Passed into [`JSON.stringify`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/JSON/stringify#The_replacer_parameter).
##### mode
Type: `number`<br>
Default: `0o666`
[Mode](https://en.wikipedia.org/wiki/File_system_permissions#Numeric_notation) used when writing the file.
## Related
- [load-json-file](https://github.com/sindresorhus/load-json-file) - Read and parse a JSON file
- [make-dir](https://github.com/sindresorhus/make-dir) - Make a directory and its parents if needed
## License
MIT © [Sindre Sorhus](https://sindresorhus.com)
|
