@wrote/write/README.md

Write a file to the filesystem.

# @wrote/write

[![npm version](https://badge.fury.io/js/%40wrote%2Fwrite.svg)](https://npmjs.org/package/@wrote/write)

`@wrote/write` is a package to write a file to the filesystem.

```sh
yarn add -E @wrote/write
```

## Table Of Contents

- [Table Of Contents](#table-of-contents)
- [API](#api)
- [`async write(path: string, data?: string|Buffer)`](#async-writepath-stringdata-stringbuffer-void)
- [Copyright](#copyright)

<p align="center"><a href="#table-of-contents"><img src=".documentary/section-breaks/0.svg?sanitize=true"></a></p>

## API

The package is available by importing its default function:

```js
import write from '@wrote/write'
```

<p align="center"><a href="#table-of-contents"><img src=".documentary/section-breaks/1.svg?sanitize=true"></a></p>

## `async write(`<br/>&nbsp;&nbsp;`path: string,`<br/>&nbsp;&nbsp;`data?: string|Buffer,`<br/>`): void`

Write data to a file on the filesystem.

```js
import write from '@wrote/write'

const Write = async (path) => {
  await write(path, '> example-data')
  console.log('Written data to %s:', path)
}
```
```
Written data to example/temp/example.txt:
> example-data
```

<p align="center"><a href="#table-of-contents"><img src=".documentary/section-breaks/2.svg?sanitize=true"></a></p>

## Copyright

<table>
  <tr>
    <th>
      <a href="https://artd.eco">
        <img src="https://raw.githubusercontent.com/wrote/wrote/master/images/artdeco.png" alt="Art Deco" />
      </a>
    </th>
    <th>© <a href="https://artd.eco">Art Deco</a> for <a href="https://wrote.cc">Wrote</a> 2019</th>
    <th>
      <a href="https://wrote.cc">
        <img src="https://avatars3.githubusercontent.com/u/40831417?s=100" width="100" alt="Wrote" />
      </a>
    </th>
    <th>
      <a href="https://www.technation.sucks" title="Tech Nation Visa">
        <img src="https://raw.githubusercontent.com/artdecoweb/www.technation.sucks/master/anim.gif"
          alt="Tech Nation Visa" />
      </a>
    </th>
    <th><a href="https://www.technation.sucks">Tech Nation Visa Sucks</a></th>
  </tr>
</table>

<p align="center"><a href="#table-of-contents"><img src=".documentary/section-breaks/-1.svg?sanitize=true"></a></p>