# buffer-peek-stream

> Transform stream that lets you inspect the start of a readable stream before deciding what to do with it

Latest version **1.1.0** (published 2020-02-02) · MIT license · 0 weekly downloads

## Install

```sh
npm install buffer-peek-stream
pnpm add buffer-peek-stream
yarn add buffer-peek-stream
bun add buffer-peek-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 | 2020-02-02 |
| First published | 2014-11-05 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 0 |
| Unpacked size | 10.1 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 7 |
| Author | Sean Garner |
| Maintainers | davidgwking, seangarner |
| Keywords | stream, streams, peek, parse, buffer, inspect |

## Links

- npm: https://www.npmjs.com/package/buffer-peek-stream
- Repository: https://github.com/seangarner/node-buffer-peek-stream
- Issues: https://github.com/seangarner/node-buffer-peek-stream/issues
- npm.io page: https://npm.io/package/buffer-peek-stream

## Alternatives

- [babylon](https://npm.io/package/babylon.md) — 5.1M weekly downloads
- [csscolorparser](https://npm.io/package/csscolorparser.md) — 3.7M weekly downloads
- [expr-eval-fork](https://npm.io/package/expr-eval-fork.md) — 1.5M weekly downloads
- [@leeoniya/ufuzzy](https://npm.io/package/@leeoniya/ufuzzy.md) — 247.7K weekly downloads
- [xml-parser](https://npm.io/package/xml-parser.md) — 78.4K weekly downloads

## Recent versions

- 1.1.0 (latest) — 2020-02-02
- 1.0.1 — 2015-06-09
- 1.0.0 — 2015-05-19
- 0.2.0 — 2014-11-13
- 0.1.3 — 2014-11-11
- 0.1.2 — 2014-11-07
- 0.1.1 — 2014-11-05

## README

# node-buffer-peek-stream

[![Build Status](https://travis-ci.org/seangarner/node-buffer-peek-stream.svg?branch=master)](https://travis-ci.org/seangarner/node-buffer-peek-stream)

Take a peek at the start of a stream and get back a new stream rewound from the start without
buffering the entire stream.  Useful when you need to inspect the start of the stream before
deciding what to do with the stream.

```
npm install buffer-peek-stream
```

Useful if you want to inspect the start of a stream before deciding what to do with it.

This works with buffers and does no string decoding.  If you know you have a string and already
know its encoding then checkout [peek-stream](https://github.com/mafintosh/peek-stream).


## Usage
As a promise (with await)...
```
const peek = require('buffer-peek-stream').promise;
const readstream = fs.createReadStream('package.json');

const [data, outputStream] = await peek(readstream, 65536);

// outputStream is ready to be piped somewhere else
outputStream.pipe(somewhere_else);
```

As a callback...
```
var peek = require('buffer-peek-stream');
var readstream = fs.createReadStream('package.json');

peek(readstream, 65536, function (err, data, outputStream) {
  if (err) throw err;

  // outputStream is ready to be piped somewhere else
  outputStream.pipe(somewhere_else);
});
```

As a stream...
```
var PeekStream = require('buffer-peek-stream').BufferPeekStream;

var peek = new PeekStream(65536);
var readstream = fs.createReadStream('package.json');

// peek will only emit the peek event once
peek.once('peek', function (buf) {

  // readstream is ready to be piped somewhere else
  peek.pipe(somewhere_else);
});

readstream.pipe(peek);

// alternatively pipe `peek` here instead of in `data` callback
```


## Licence
MIT

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