pump

v3.0.0

pipe streams together and close all of them if one of them closes

NPM

README

GitHub

MIT

Latest version published 4 years ago

    npm install pump

Explore Similar Packages

Package Health Score

67 / 100

Popularity
Influential project
Maintenance
Inactive
Security
No known security issues
Community
Limited

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

Secure Your Project

Find & fix vulnerable dependencies and insecure code

Popularity

Influential project

Weekly Downloads (35,599,582)

Dependents: 2.65K
GitHub Stars: 861
Forks: 51
Contributors: 6

Direct Usage Popularity

The npm package pump receives a total of 35,599,582 downloads a week. As such, we scored pump popularity level to be Influential project.

Based on project statistics from the GitHub repository for the npm package pump, we found that it has been starred 861 times, and that 2,645 other projects in the ecosystem are dependent on it.

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

Security

No known security issues

Security and license risk for significant versions

All Versions

Popular

Version

Release Date

12/2013

07/2014

11/2017

01/2018

01/2018

Direct Vulnerabilities

Popular

Indirect Vulnerabilities

Popular

License Risk

Popular

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

License

MIT

Security Policy

We found a way for you to contribute to the project! Looks like pump is missing a security policy.

You can connect your project's repository to Snyk to stay up to date on security alerts and receive automatic fix pull requests.

    # Install the Snyk CLI and test your project
npm i snyk -g && snyk test pump

Keep your project free of vulnerabilities with Snyk

Maintenance

Inactive

Commit Frequency

No Recent Commits

Open Issues: 12
Open PR: 5
Last Release: 4 years ago
Last Commit: 2 years ago

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

An important project maintenance signal to consider for pump is that it hasn't seen any new versions released to npm in the past 12 months, and could be considered as a discontinued project, or that which receives low attention from its maintainers.

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

Community

Limited

Readme.md: Yes
Contributing.md: No
Code of Conduct: No
Contributors: 6
Funding: Yes

This project has seen only 10 or less contributors.

We found a way for you to contribute to the project! Looks like pump is missing a Code of Conduct.

Embed Package Health Score Badge

Package

Node.js Compatibility: not defined

Age: 8 years
Dependencies: 2 Direct
Versions: 26
Install Size: 0 B
Dist-tags: 1
# of Files: 0
Maintainers: 1
TS Typings: Yes

pump 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.

Not sure how to use pump?

To help you get started, we've collected the most common ways that pump is being used within popular public projects.

staeco / iris-ql / src / util / export.js View on Github

export default async ({ model, value, format, transform, debug, analytics=false }) => {
  const nv = { ...value }

  // prep work findAll usually does
  if (!analytics) {
    // sequelize < 5.10
    if (model._conformOptions) {
      model._injectScope(nv)
      model._conformOptions(nv, model)
      model._expandIncludeAll(nv)
    } else {
      model._injectScope(nv)
      model._conformIncludes(nv, model)
      model._expandAttributes(nv)
      model._expandIncludeAll(nv)
    }
  }

  const sql = select({ value: nv, model })
  if (debug) debug(sql)
  const src = await streamable(model, sql, transform)
  if (!format) return src
  const out = pump(src, format(), (err) => {
    if (err) out.emit('error', err)
  })
  out.contentType = format.contentType
  return out
}

View more ways to use pump

pump

pump is a small node module that pipes streams together and destroys all of them if one of them closes.

npm install pump

What problem does it solve?

When using standard source.pipe(dest) source will not be destroyed if dest emits close or an error. You are also not able to provide a callback to tell when then pipe has finished.

pump does these two things for you

Usage

Simply pass the streams you want to pipe together to pump and add an optional callback

var pump = require('pump')
var fs = require('fs')

var source = fs.createReadStream('/dev/random')
var dest = fs.createWriteStream('/dev/null')

pump(source, dest, function(err) {
  console.log('pipe finished', err)
})

setTimeout(function() {
  dest.destroy() // when dest is closed pump will destroy source
}, 1000)

You can use pump to pipe more than two streams together as well

var transform = someTransformStream()

pump(source, transform, anotherTransform, dest, function(err) {
  console.log('pipe finished', err)
})

If source, transform, anotherTransform or dest closes all of them will be destroyed.

Similarly to stream.pipe(), pump() returns the last stream passed in, so you can do:

return pump(s1, s2) // returns s2

If you want to return a stream that combines both s1 and s2 to a single stream use pumpify instead.

License

MIT

pump is part of the mississippi stream utility collection which includes more useful stream modules similar to this one.

pump dependencies

end-of-stream once

FAQs

What is pump?

pipe streams together and close all of them if one of them closes. Visit Snyk Advisor to see a full health score report for pump, including popularity, security, maintenance & community analysis.

Is pump popular?

The npm package pump receives a total of 35,599,582 weekly downloads. As such, pump popularity was classified as an influential project. Visit the popularity section on Snyk Advisor to see the full health analysis.

Is pump well maintained?

We found indications that pump is an Inactive project. See the full package health analysis to learn more about the package maintenance status.

Is pump safe to use?

The npm package pump 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 January-2022, at 01:09 (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

Keep your project healthy

Check your package.json

Snyk Vulnerability Scanner

Secure Your Project

Weekly Downloads (35,599,582)

Direct Usage Popularity

Security and license risk for significant versions

Version

Release Date

Direct Vulnerabilities

Indirect Vulnerabilities

License Risk

Commit Frequency

Embed Package Health Score Badge

Not sure how to use pump?

pump

What problem does it solve?

Usage

License

Related

pump dependencies

FAQs

What is pump?

Is pump popular?

Is pump well maintained?

Is pump 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