diff options
Diffstat (limited to 'node_modules/write-pkg/readme.md')
| -rw-r--r-- | node_modules/write-pkg/readme.md | 69 |
1 files changed, 0 insertions, 69 deletions
diff --git a/node_modules/write-pkg/readme.md b/node_modules/write-pkg/readme.md deleted file mode 100644 index ad3ed1cd5..000000000 --- a/node_modules/write-pkg/readme.md +++ /dev/null @@ -1,69 +0,0 @@ -# write-pkg [](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. Preserves the indentation if the file already exists. - - -## Install - -``` -$ npm install 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, [options]) - -Returns a `Promise`. - -### writePkg.sync([path], data, [options]) - -#### path - -Type: `string`<br> -Default: `process.cwd()` - -Path to where the `package.json` file should be written or its directory. - -#### options - -Type: `Object` - -##### normalize - -Type: `boolean`<br> -Default: `true` - -Remove empty `dependencies`, `devDependencies`, `optionalDependencies` and `peerDependencies` objects. - -## 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) |