# files-io

> Read many files in node

Latest version **4.0.1** (published 2021-01-26) · MIT license · 0 weekly downloads

## Install

```sh
npm install files-io
pnpm add files-io
yarn add files-io
bun add files-io
```

## 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 | 4.0.1 |
| Published | 2021-01-26 |
| First published | 2014-08-12 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Node | >=14 |
| Dependencies | 1 |
| Unpacked size | 7.2 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 19 |
| Author | coderaiser |
| Maintainers | coderaiser |
| Keywords | files, read |

## Links

- npm: https://www.npmjs.com/package/files-io
- Repository: https://github.com/coderaiser/files-io
- Homepage: http://github.com/coderaiser/files-io
- Issues: https://github.com/coderaiser/files-io/issues
- npm.io page: https://npm.io/package/files-io

## Dependencies (1)

- [pipe-io](https://npm.io/package/pipe-io.md) ^4.0.0

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

- 4.0.1 (latest) — 2021-01-26
- 4.0.0 — 2021-01-25
- 3.0.2 — 2020-03-21
- 3.0.1 — 2019-09-18
- 3.0.0 — 2018-10-24
- 2.0.0 — 2018-05-02
- 1.2.8 — 2016-12-28
- 1.2.7 — 2016-11-08
- 1.2.6 — 2015-08-17
- 1.2.5 — 2015-02-09
- 1.2.4 — 2015-02-02
- 1.2.3 — 2015-01-16
- 1.2.2 — 2014-12-22
- 1.2.1 — 2014-11-25
- 1.2.0 — 2014-11-03
- … 5 more at https://npm.io/package/files-io/versions

## README

# Files-io [![License][LicenseIMGURL]][LicenseURL] [![NPM version][NPMIMGURL]][NPMURL] [![Dependency Status][DependencyStatusIMGURL]][DependencyStatusURL] [![Build Status][BuildStatusIMGURL]][BuildStatusURL] [![Coverage Status][CoverageIMGURL]][CoverageURL]

========

[NPMIMGURL]: https://img.shields.io/npm/v/files-io.svg?style=flat
[BuildStatusIMGURL]: https://img.shields.io/travis/coderaiser/files-io/master.svg?style=flat
[DependencyStatusIMGURL]: https://img.shields.io/david/coderaiser/files-io.svg?style=flat
[LicenseIMGURL]: https://img.shields.io/badge/license-MIT-317BF9.svg?style=flat
[NPMURL]: https://npmjs.org/package/files-io "npm"
[BuildStatusURL]: https://travis-ci.org/coderaiser/files-io "Build Status"
[DependencyStatusURL]: https://david-dm.org/coderaiser/files-io "Dependency Status"
[LicenseURL]: https://tldrlegal.com/license/mit-license "MIT License"
[CoverageURL]: https://coveralls.io/github/coderaiser/readify?branch=master
[CoverageIMGURL]: https://coveralls.io/repos/coderaiser/readify/badge.svg?branch=master&service=github

Read many files with node.

# Install

`npm i files-io --save`

# How to use?

```js
const files = require('files-io');

const allData = await files.read(['README.md', 'package.json'], 'utf8');
console.log(allData);

/* Easy way to create pipe which would handle all error events */
const NameFrom = 'README.md';
const NameTo = 'README_COPY.gz';

await files.pipe(NameFrom, NameTo, {
    gzip: true,
});
/* join couple files and save them to new file with streams */
const fs = require('fs');
const NAME = 'Join';
const writeStream = fs.createWriteStream(NAME);

await files.readPipe(['README.md', 'package.json'], writeStream);
```

# License

MIT

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