Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/okunishinishi/node-writeout
Node.js module to write out files with various options.
https://github.com/okunishinishi/node-writeout
Last synced: 2 months ago
JSON representation
Node.js module to write out files with various options.
- Host: GitHub
- URL: https://github.com/okunishinishi/node-writeout
- Owner: okunishinishi
- License: mit
- Created: 2015-07-18T12:39:03.000Z (over 9 years ago)
- Default Branch: master
- Last Pushed: 2022-12-30T17:14:24.000Z (about 2 years ago)
- Last Synced: 2024-09-19T23:36:06.734Z (4 months ago)
- Language: JavaScript
- Homepage: https://www.npmjs.com/package/writeout
- Size: 119 KB
- Stars: 1
- Watchers: 2
- Forks: 1
- Open Issues: 5
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
writeout
==========
[![Build Status][bd_travis_shield_url]][bd_travis_url]
[![Code Climate][bd_codeclimate_shield_url]][bd_codeclimate_url]
[![Code Coverage][bd_codeclimate_coverage_shield_url]][bd_codeclimate_url]
[![npm Version][bd_npm_shield_url]][bd_npm_url]
[bd_repo_url]: https://github.com/okunishinishi/node-writeout
[bd_travis_url]: http://travis-ci.org/okunishinishi/node-writeout
[bd_travis_shield_url]: http://img.shields.io/travis/okunishinishi/node-writeout.svg?style=flat
[bd_travis_com_url]: http://travis-ci.com/okunishinishi/node-writeout
[bd_travis_com_shield_url]: https://api.travis-ci.com/okunishinishi/node-writeout.svg?token=
[bd_license_url]: https://github.com/okunishinishi/node-writeout/blob/master/LICENSE
[bd_codeclimate_url]: http://codeclimate.com/github/okunishinishi/node-writeout
[bd_codeclimate_shield_url]: http://img.shields.io/codeclimate/github/okunishinishi/node-writeout.svg?style=flat
[bd_codeclimate_coverage_shield_url]: http://img.shields.io/codeclimate/coverage/github/okunishinishi/node-writeout.svg?style=flat
[bd_gemnasium_url]: https://gemnasium.com/okunishinishi/node-writeout
[bd_gemnasium_shield_url]: https://gemnasium.com/okunishinishi/node-writeout.svg
[bd_npm_url]: http://www.npmjs.org/package/writeout
[bd_npm_shield_url]: http://img.shields.io/npm/v/writeout.svg?style=flat
[bd_standard_url]: http://standardjs.com/
[bd_standard_shield_url]: https://img.shields.io/badge/code%20style-standard-brightgreen.svg
Write out string files with various options.
Installation
-----
```bash
npm install writeout --save
```
Usage
----
```javascript
'use strict'
const writeout = require('writeout')
// Generate a file.
writeout('hello-wold', 'This is the contents text', {
mkdirp: true,
skipIfIdentical: true
}).then((result) => {
if (!result.skipped) {
console.log('File generated:', result.filename)
}
}).catch((err) =>
console.error(err)
)
```
Options
-----
| Name | Default | Description |
| --- | --- | --- |
| `mkdirp` | false | Make parent directories. |
| `skipIfIdentical` | false | Skip to write if existing content is identical. ||
| `mode` | "644" | File permission. |
| `force` | false | Force to write even if existing file is readonly. |
License
-------
This software is released under the [MIT License](https://github.com/okunishinishi/node-writeout/blob/master/LICENSE).