# process-file

> Process a file and return the results as a promise

Latest version **2.0.1** (published 2016-04-14) · MIT license · 0 weekly downloads

## Install

```sh
npm install process-file
pnpm add process-file
yarn add process-file
bun add process-file
```

## 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.0.1 |
| Published | 2016-04-14 |
| First published | 2015-07-24 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Node | >=0.10.0 |
| Dependencies | 2 |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 8 |
| Author | Kevin Mårtensson |
| Maintainers | kevva |
| Keywords | file, process, promise, return, stream |

## Links

- npm: https://www.npmjs.com/package/process-file
- Repository: https://github.com/kevva/process-file
- Homepage: https://github.com/kevva/process-file#readme
- Issues: https://github.com/kevva/process-file/issues
- npm.io page: https://npm.io/package/process-file

## Dependencies (2)

- [concat-stream](https://npm.io/package/concat-stream.md) ^1.5.0
- [pinkie-promise](https://npm.io/package/pinkie-promise.md) ^1.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

- 2.0.1 (latest) — 2016-04-14
- 2.0.0 — 2015-10-04
- 1.1.0 — 2015-07-24
- 1.0.0 — 2015-07-24

## README

# process-file [![Build Status](https://travis-ci.org/kevva/process-file.svg?branch=master)](https://travis-ci.org/kevva/process-file)

> Process a file and return the results as a promise


## Install

```
$ npm install --save process-file
```


## Usage

```js
const csvParser = require('csv-parser');
const processFile = require('process-file');

processFile('unicorn.csv', csvParser()).then(data => {
	console.log(data);
	//=> [{foo: 'bar', unicorn: 'awesome'}]
});
```


## API

### processFile(file, stream)

Returns a promise that resolves to your processed result.

#### file

*Required*<br>
Type: `string`, `buffer`

File to process.

#### stream

*Required*<br>
Type: `object`

Stream to process the file with.


## License

MIT © [Kevin Mårtensson](http://github.com/kevva)

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