# @twec/async-file-reader

> Asynchronous file reader

Latest version **1.0.0** (published 2020-06-30) · ISC license · 0 weekly downloads

## Install

```sh
npm install @twec/async-file-reader
pnpm add @twec/async-file-reader
yarn add @twec/async-file-reader
bun add @twec/async-file-reader
```

## 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 | 1.0.0 |
| Published | 2020-06-30 |
| First published | 2020-06-30 |
| Weekly downloads | 0 |
| License | ISC |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 1 |
| Unpacked size | 7.3 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| Author | Tim Monroe |
| Maintainers | fye-engineering, vlaadbrain, strumwolf, couto, drudge, ramitos |
| Keywords | utils, utilities, twec, fye, async, file, reader |

## Links

- npm: https://www.npmjs.com/package/@twec/async-file-reader
- npm.io page: https://npm.io/package/@twec/async-file-reader

## Dependencies (1)

- [debug](https://npm.io/package/debug.md) ^4.1.1

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

- 1.0.0 (latest) — 2020-06-30

## README

# `@twec/async-file-reader`

> TODO: description

## Usage

```
const asyncFileReaderConstructor = require('@twec/async-file-reader').asyncFileReader;
const asyncFileReader = new asyncFileReaderConstructor( {fileName, readSize, lineTerminator, encoding, convertToString} );
while ((line = await asyncFileReader.readLine()) != null) {
    // do something...
}

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