thedesk/app/node_modules/slice-stream/README.md
2018-02-18 16:29:06 +09:00

47 lines
1.1 KiB
Markdown

slice-stream [![Build Status](https://travis-ci.org/EvanOxfeld/slice-stream.png)](https://travis-ci.org/EvanOxfeld/slice-stream)
============
Pipe data through a stream until some fixed length is reached, then callback.
## Installation
```bash
$ npm install slice-stream
```
## Quick Example
### End stream once a fixed length has been reached
```javascript
var SliceStream = require('../');
var streamBuffers = require("stream-buffers");
var ss = new SliceStream({ length: 5}, function (buf, sliceEnd, extra) {
if (!sliceEnd) {
return this.push(buf);
}
this.push(buf);
return this.push(null); //signal end of data
});
var sourceStream = new streamBuffers.ReadableStreamBuffer();
sourceStream.put("Hello World");
var writableStream = new streamBuffers.WritableStreamBuffer();
sourceStream
.pipe(ss)
.pipe(writableStream)
.once('close', function () {
var str = writableStream.getContentsAsString('utf8');
console.log('First 5 bytes piped:', "'" + str + "'");
sourceStream.destroy();
});
//Output
//Piped data before pattern occurs: 'Hello'
```
## License
MIT