# rain-util-fs

> Generator based, co/koa compatible utilities for managing filesystem

Latest version **0.4.0** (published 2016-02-07) · MIT license · 0 weekly downloads

## Install

```sh
npm install rain-util-fs
pnpm add rain-util-fs
yarn add rain-util-fs
bun add rain-util-fs
```

## Health

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

Positive: no vulnerabilities.

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

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 0.4.0 |
| Published | 2016-02-07 |
| First published | 2016-02-06 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Node | >= 4.2.0 |
| Dependencies | 8 |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 0 |
| Author | Max Millien |
| Maintainers | maxmill |
| Keywords | koa, postgres, api, http, fs, json, mkdirp, utils, requests, co, download, generators, bundle, convenience, toolkit |

## Links

- npm: https://www.npmjs.com/package/rain-util-fs
- Repository: https://www.github.com/maxmill/rain-util-fs
- npm.io page: https://npm.io/package/rain-util-fs

## Dependencies (8)

- [co-fs](https://npm.io/package/co-fs.md) *
- [mkdirp](https://npm.io/package/mkdirp.md) *
- [rimraf](https://npm.io/package/rimraf.md) *
- [co-tape](https://npm.io/package/co-tape.md) *
- [jsonfile](https://npm.io/package/jsonfile.md) 2.x
- [thunkify-wrap](https://npm.io/package/thunkify-wrap.md) *
- [array-generators](https://npm.io/package/array-generators.md) 1.x
- [rain-util-download](https://npm.io/package/rain-util-download.md) *

## Alternatives

- [@mapbox/jsonlint-lines-primitives](https://npm.io/package/@mapbox/jsonlint-lines-primitives.md) — 5.3M weekly downloads
- [reftools](https://npm.io/package/reftools.md) — 3.5M weekly downloads
- [@hey-api/openapi-ts](https://npm.io/package/@hey-api/openapi-ts.md) — 3.5M weekly downloads
- [@mapbox/geojson-rewind](https://npm.io/package/@mapbox/geojson-rewind.md) — 2.4M weekly downloads
- [turbo-stream](https://npm.io/package/turbo-stream.md) — 1.7M weekly downloads

## Recent versions

- 0.4.0 (latest) — 2016-02-07
- 0.3.9 — 2016-02-06

## README

# rain-util-fs #

[![Build Status](https://travis-ci.org/maxmill/rain-util-fs.svg?style=flat-square)](https://travis-ci.org/maxmill/rain-util-fs)
[![npm](https://img.shields.io/npm/v/rain-util-fs.svg?style=flat-square)]()
[![npm](https://img.shields.io/npm/dt/rain-util-fs.svg)]()


Generator based, co/koa compatible utilities  for managing filesystem

```
npm i rain-util-fs
var $util = require('rain-util-fs');
```

extends co-fs - all core node fs methods available as generators
```
$util.fs.download   - (file or file array) downloads url(s) to file(s)
$util.fs.upsert     - (dir or dir array) creates dir if non-existent (uses mkdirp)
$util.fs.fetch     - (file or dir) read file or directory contents
$util.fs.rimraf     - (path) yieldable rm -rf
$util.fs.objectify          - (path) converts directory and contents into node module
$util.fs.json.(read|write)  - (file, obj, options)
```


### credits ###


- https://github.com/jprichardson/node-jsonfile
- https://github.com/substack/node-mkdirp
- https://github.com/isaacs/rimraf

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