# fd-read-stream

> Readable stream that reads from a file descriptor. Supports tailing and retries.

Latest version **1.1.0** (published 2017-03-30) · MIT license · 0 weekly downloads

## Install

```sh
npm install fd-read-stream
pnpm add fd-read-stream
yarn add fd-read-stream
bun add fd-read-stream
```

## 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.1.0 |
| Published | 2017-03-30 |
| First published | 2017-03-30 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 1 |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 16 |
| Author | Mathias Buus |
| Maintainers | mafintosh |

## Links

- npm: https://www.npmjs.com/package/fd-read-stream
- Repository: https://github.com/mafintosh/fd-read-stream
- Issues: https://github.com/mafintosh/fd-read-stream/issues
- npm.io page: https://npm.io/package/fd-read-stream

## Dependencies (1)

- [readable-stream](https://npm.io/package/readable-stream.md) ^2.2.6

## Recent versions

- 1.1.0 (latest) — 2017-03-30
- 1.0.0 — 2017-03-30

## README

# fd-read-stream

Readable stream that reads from a file descriptor. Supports tailing and retries.

```
npm install fd-read-stream
```

## Usage

``` js
var fs = require('fs')
var createReadStream = require('fd-read-stream')

var rs = createReadStream(fs.openSync('some-file', 'r'))

rs.pipe(process.stdout)
```

## API

#### `var rs = createReadStream(fd, [options])`

Create a new readable stream. Options include:

``` js
{
  tail: false // keep reading the fd forever (will pool it)
  retry: 0 // wait this many ms and retry a read once if it fails
}
```

## License

MIT

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