SandwichStream

About

While I'm not overjoyed about how performant the internals will operate, I wanted a readable stream that was ACTUALLY A READABLE STREAM. Not a streams1 stream masquerading as streams2. As soon as somebody writes a better concat stream as a readable stream with a nice simple API, this baby is going to develop some serious abandonment issues.

Installation

1npm install sandwich-stream --save

note: this code was made using it TypeScript, and its typings are linked in package.json, so there's no need of installing @types/sandwich-stream or anything related.

Usage

1import { SandwichStream } from 'sandwich-stream';
2// OR EVEN:
3// const SandwichStream = require('sandwich-stream');
4
5const sandwich = SandwichStream({
6    head: 'Thing at the top\n',
7    tail: '\nThing at the bottom',
8    separator: '\n ---- \n'
9});
10
11sandwich.add(aStreamIPreparedEarlier)
12        .add(anotherStreamIPreparedEarlier)
13        .add(aFurtherStreamIPreparedEarlier)
14        .pipe(process.stdout);
15
16// The thing at the top
17//  ---- 
18// Stream1
19//  ---- 
20// Stream2
21//  ---- 
22// Stream3
23// The thing at the bottom

Configuration Options

• head option takes a string/buffer and pushes the string before all other content
• foot option takes a string/buffer and pushes the string after all other data has been pushed
• separator option pushes a string/buffer between each stream
• Readable Options can also be passed through.

API

Too add a stream use the .add method: sandwich.add(streamVariable);

More

Wanna known more about Node Streams? Read this.