aboutsummaryrefslogtreecommitdiff
path: root/node_modules/write-pkg/readme.md
blob: fa51dad26d781479b253cfc865120aba2c009b48 (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
# write-pkg [![Build Status](https://travis-ci.org/sindresorhus/write-pkg.svg?branch=master)](https://travis-ci.org/sindresorhus/write-pkg)

> Write a `package.json` file

Writes atomically and creates directories for you as needed. Sorts dependencies when writing.


## Install

```
$ npm install --save write-pkg
```


## Usage

```js
const path = require('path');
const writePkg = require('write-pkg');

writePkg({foo: true}).then(() => {
	console.log('done');
});

writePkg(__dirname, {foo: true}).then(() => {
	console.log('done');
});

writePkg(path.join('unicorn', 'package.json'), {foo: true}).then(() => {
	console.log('done');
});
```


## API

### writePkg([path], data)

Returns a `Promise`.

### writePkg.sync([path], data)

#### path

Type: `string`<br>
Default: `process.cwd()`

Path to where the `package.json` file should be written or its directory.


## Related

- [read-pkg](https://github.com/sindresorhus/read-pkg) - Read a `package.json` file
- [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)