streamqueue

v2.0.0

StreamQueue pipe the queued streams one by one in order to preserve their content order. For more information about how to use this package see README

Latest version published 4 months ago

License: MIT

NPM

GitHub

Package Health Score

70 / 100

security
No known security issues
popularity
Recognized
maintenance
Sustainable
community
Sustainable

Explore Similar Packages

Security

No known security issues

All security vulnerabilities belong to production dependencies of direct and indirect packages.

Security and license risk for significant versions

All Versions

Version				Vulnerabilities	License Risk
2.0.0	\|	07/2024		0 C 0 H 0 M 0 L	0 H 0 M 0 L
1.1.2	\|	12/2017		0 C 0 H 0 M 0 L	0 H 0 M 0 L
0.1.3	\|	02/2015		0 C 0 H 0 M 0 L	0 H 0 M 0 L
0.0.7	\|	04/2014		0 C 0 H 0 M 0 L	0 H 0 M 0 L
0.0.6	\|	03/2014	Popular	0 C 0 H 0 M 0 L	0 H 0 M 0 L

License

MIT

Security Policy

Is your project affected by vulnerabilities?

Scan your projects for vulnerabilities. Fix quickly with automated fixes. Get started with Snyk for free.

Get started free

Popularity

Recognized

Weekly Downloads (73,299)

GitHub Stars: 63
Forks: 4
Contributors: 3

Direct Usage Popularity

The npm package streamqueue receives a total of 73,299 downloads a week. As such, we scored streamqueue popularity level to be Recognized.

Based on project statistics from the GitHub repository for the npm package streamqueue, we found that it has been starred 63 times.

Downloads are calculated as moving averages for a period of the last 12 months, excluding weekends and known missing data points.

Community

Sustainable

Readme.md: Yes
Contributing.md: Yes
Code of Conduct: Yes
Contributors: 3
Funding: Yes

This project has seen only 10 or less contributors.

Embed Package Health Score Badge

Maintenance

Sustainable

Commit Frequency

Open Issues: 1
Open PR: 0
Last Release: 4 months ago
Last Commit: 4 months ago

Further analysis of the maintenance status of streamqueue based on released npm versions cadence, the repository activity, and other data points determined that its maintenance is Sustainable.

We found that streamqueue demonstrates a positive version release cadence with at least one new version released in the past 12 months.

In the past month we didn't find any pull request activity or change in issues status has been detected for the GitHub repository.

Keep your project healthy

Check your package.json

Ensure all the packages you're using are healthy and well-maintained

Snyk Vulnerability Scanner

Get health score & security insights directly in your IDE

Package

Node.js Compatibility: >=20.11.1

Age: 11 years
Dependencies: 1 Direct
Versions: 17
Install Size: 133 kB
Dist-tags: 2
# of Files: 13
Maintainers: 1
TS Typings: No

streamqueue has more than a single and default latest tag published for the npm package. This means, there may be other tags available for this package, such as next to indicate future releases, or stable to indicate stable releases.

Readme

streamqueue

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

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

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

StreamQueue

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

Nicolas Froidure

License

MIT

streamqueue dependencies

yerror

FAQs

What is streamqueue?

StreamQueue pipe the queued streams one by one in order to preserve their content order. Visit Snyk Advisor to see a full health score report for streamqueue, including popularity, security, maintenance & community analysis.

Is streamqueue popular?

The npm package streamqueue receives a total of 73,299 weekly downloads. As such, streamqueue popularity was classified as a recognized. Visit the popularity section on Snyk Advisor to see the full health analysis.

Is streamqueue well maintained?

We found indications that streamqueue maintenance is sustainable demonstrating some project activity. We saw a total of 3 open source contributors collaborating on the project. See the full package health analysis to learn more about the package maintenance status.

Is streamqueue safe to use?

The npm package streamqueue was scanned for known vulnerabilities and missing license, and no issues were found. Thus the package was deemed as safe to use. See the full health analysis review.

Last updated on 20 November-2024, at 18:07 (UTC).

Build a secure application checklist

Select a recommended open source package

Minimize your risk by selecting secure & well maintained open source packages

DONE

Scan your app for vulnerabilities

Scan your application to find vulnerabilities in your: source code, open source dependencies, containers and configuration files

SCAN NOW

Fix identified vulnerabilities

Easily fix your code by leveraging automatically generated PRs

AUTO FIX

Monitor for new issues

New vulnerabilities are discovered every day. Get notified if your application is affected

MONITOR APP

Package Health Score

Explore Similar Packages

Security and license risk for significant versions

Is your project affected by vulnerabilities?

Weekly Downloads (73,299)

Direct Usage Popularity

Embed Package Health Score Badge

Commit Frequency

Keep your project healthy

Check your package.json

Snyk Vulnerability Scanner

Readme

streamqueue

Usage

Stats

Contributing

API

Classes

Functions

StreamQueue

new StreamQueue(options, ...streams)

streamQueue.queue(...streams) ⇒

streamQueue.done(...streams) ⇒

queueObjectStreams(options, ...streams) ⇒

queueStreams(options, ...streams) ⇒

Authors

License

streamqueue dependencies

streamqueue development dependencies

FAQs

What is streamqueue?

Is streamqueue popular?

Is streamqueue well maintained?

Is streamqueue safe to use?

Build a secure application checklist

Select a recommended open source package

Scan your app for vulnerabilities

Source Code

Open Source

Container

Config

Fix identified vulnerabilities

Monitor for new issues