Skip to content

Latest commit

 

History

History
executable file
·
199 lines (142 loc) · 5.5 KB

README.md

File metadata and controls

executable file
·
199 lines (142 loc) · 5.5 KB
Raw

streamqueue

StreamQueue pipe the queued streams one by one in order to preserve their content order.

GitHub license

Usage

Install the npm module:

npm install streamqueue --save

Then, in your scripts:

import { StreamQueue } from 'streamqueue';
import { createReadStream } from 'node:fs';

const queue = new StreamQueue(
  createReadStream('input.txt'),
  createReadStream('input2.txt'),
  createReadStream('input3.txt'),
).pipe(process.stdout);

StreamQueue also accept functions returning streams, the above can be written like this, doing system calls only when piping:

import { queueStreams } = require('streamqueue');
import { createReadStream } from 'node:fs';

const queue = queueStreams(
  createReadStream.bind(null, 'input.txt'),
  createReadStream.bind(null, 'input2.txt'),
  createReadStream.bind(null, 'input3.txt'),
).pipe(process.stdout);

Object-oriented traditionnal API offers more flexibility:

import { StreamQueue } from 'streamqueue';
import { createReadStream } from 'node:fs';

const queue = new StreamQueue();

queue.queue(
  createReadStream('input.txt'),
  createReadStream('input2.txt'),
  createReadStream('input3.txt'),
);
queue.done();

queue.pipe(process.stdout);

You can also chain StreamQueue methods like that:

import StreamQueue from 'streamqueue';
import { createReadStream } from 'node:fs';

new StreamQueue()
  .queue(createReadStream('input.txt'))
  .queue(createReadStream('input2.txt'))
  .queue(createReadStream('input3.txt'))
  .done()
  .pipe(process.stdout);

You can queue new streams at any moment until you call the done() method. So the created stream will not fire the end event until done() call.

Stats

NPM NPM

Contributing

Feel free to propose your code if you agree with publishing it under the MIT license.

API

Classes

StreamQueue

Pipe queued streams sequentially

Functions

queueObjectStreams(options, ...streams) ⇒

Create a new queue in object mode and pipe given streams and end if some

queueStreams(options, ...streams) ⇒

Create a new queue and pipe given streams and end if some

StreamQueue

Pipe queued streams sequentially

Kind: global class

new StreamQueue(options, ...streams)

Create a new queue and pipe given streams and end if some

Returns: StreamQueue

Param Type Description
options Object The queue options
options.objectMode boolean Operate in object mode
options.pauseFlowingStream boolean Pause given streams that are flowing
options.resumeFlowingStream boolean Resume given streams that are flowing
...streams Readable | function The stream or stream returning function to pipe in

streamQueue.queue(...streams) ⇒

Queue each stream given in argument

Kind: instance method of StreamQueue
Returns: StreamQueue

Param Type Description
...streams Readable | function The stream or stream returning function to pipe in

streamQueue.done(...streams) ⇒

Queue each stream given in argument and end

Kind: instance method of StreamQueue
Returns: StreamQueue

Param Type Description
...streams Readable | function The stream or stream returning function to pipe in

queueObjectStreams(options, ...streams) ⇒

Create a new queue in object mode and pipe given streams and end if some

Kind: global function
Returns: StreamQueue

Param Type Description
options Object The queue options
...streams Readable | function The stream or stream returning function to pipe in

queueStreams(options, ...streams) ⇒

Create a new queue and pipe given streams and end if some

Kind: global function
Returns: StreamQueue

Param Type Description
options Object The queue options
...streams Readable | function The stream or stream returning function to pipe in

Authors

License

MIT