diff options
Diffstat (limited to 'node_modules/write-pkg/readme.md')
-rw-r--r-- | node_modules/write-pkg/readme.md | 59 |
1 files changed, 59 insertions, 0 deletions
diff --git a/node_modules/write-pkg/readme.md b/node_modules/write-pkg/readme.md new file mode 100644 index 000000000..fa51dad26 --- /dev/null +++ b/node_modules/write-pkg/readme.md @@ -0,0 +1,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) |