summaryrefslogtreecommitdiff
path: root/deps/node/deps/npm/node_modules/stream-shift/README.md
blob: d9cc2d945fa16191a7fb4b589a67c59372fc9dcd (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
# stream-shift

Returns the next buffer/object in a stream's readable queue

```
npm install stream-shift
```

[![build status](http://img.shields.io/travis/mafintosh/stream-shift.svg?style=flat)](http://travis-ci.org/mafintosh/stream-shift)

## Usage

``` js
var shift = require('stream-shift')

console.log(shift(someStream)) // first item in its buffer
```

## Credit

Thanks [@dignifiedquire](https://github.com/dignifiedquire) for making this work on node 6

## License

MIT