# writeout

> Write out string files with various options.

Latest version **2.3.4** (published 2020-10-01) · MIT license · 0 weekly downloads

## Install

```sh
npm install writeout
pnpm add writeout
yarn add writeout
bun add writeout
```

## Health

**Score 15/100 (F)** — status: abandoned.

Positive: no vulnerabilities.

Warnings: low downloads; no types; no esm support.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 2.3.4 |
| Published | 2020-10-01 |
| First published | 2015-07-18 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Node | >=7.6 |
| Dependencies | 4 |
| Unpacked size | 13.4 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 1 |
| Author | Taka Okunishi |
| Maintainers | okunishinishi |
| Keywords | file, rendering |

## Links

- npm: https://www.npmjs.com/package/writeout
- Repository: https://github.com/okunishinishi/node-writeout
- Homepage: https://github.com/okunishinishi/node-writeout#readme
- Issues: https://github.com/okunishinishi/node-writeout/issues
- npm.io page: https://npm.io/package/writeout

## Dependencies (4)

- [argx](https://npm.io/package/argx.md) ^4.0.4
- [asleep](https://npm.io/package/asleep.md) ^1.0.3
- [mkdirp](https://npm.io/package/mkdirp.md) ^1.0.4
- [filedel](https://npm.io/package/filedel.md) ^4.1.2

## Alternatives

- [unionfs](https://npm.io/package/unionfs.md) — 2.2M weekly downloads
- [path-starts-with](https://npm.io/package/path-starts-with.md) — 35.9K weekly downloads
- [redzip](https://npm.io/package/redzip.md) — 1.2K weekly downloads
- [vscode-anymatch](https://npm.io/package/vscode-anymatch.md) — 848 weekly downloads
- [@ledgerhq/coin-filecoin](https://npm.io/package/@ledgerhq/coin-filecoin.md) — 793 weekly downloads

## Recent versions

- 2.3.4 (latest) — 2020-10-01
- 2.3.2 — 2020-04-27
- 2.3.1 — 2020-02-28
- 2.3.0 — 2020-01-26
- 2.2.4 — 2019-03-05
- 2.2.3 — 2019-02-24
- 2.2.2 — 2019-02-24
- 2.2.1 — 2017-09-17
- 2.2.0 — 2017-05-03
- 2.1.0 — 2016-09-11
- 2.0.7 — 2016-07-30
- 2.0.6 — 2016-07-12
- 2.0.5 — 2016-06-14
- 2.0.4 — 2016-05-19
- 2.0.3 — 2016-05-19
- … 12 more at https://npm.io/package/writeout/versions

## README

writeout
==========

<!---
This file is generated by ape-tmpl. Do not update manually.
--->

<!-- Badge Start -->
<a name="badges"></a>

[![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

<!-- Badge End -->


<!-- Description Start -->
<a name="description"></a>

Write out string files with various options.

<!-- Description End -->




<!-- Sections Start -->
<a name="sections"></a>

<!-- Section from "doc/guides/01.Installation.md.hbs" Start -->

<a name="section-doc-guides-01-installation-md"></a>

Installation
-----

```bash
npm install writeout --save
```


<!-- Section from "doc/guides/01.Installation.md.hbs" End -->

<!-- Section from "doc/guides/02.Usage.md.hbs" Start -->

<a name="section-doc-guides-02-usage-md"></a>

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)
)


```

<!-- Section from "doc/guides/02.Usage.md.hbs" End -->

<!-- Section from "doc/guides/03.Options.md.hbs" Start -->

<a name="section-doc-guides-03-options-md"></a>

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. |

<!-- Section from "doc/guides/03.Options.md.hbs" End -->


<!-- Sections Start -->


<!-- LICENSE Start -->
<a name="license"></a>

License
-------
This software is released under the [MIT License](https://github.com/okunishinishi/node-writeout/blob/master/LICENSE).

<!-- LICENSE End -->

---
_Source: https://npm.io/package/writeout · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._