npm package discovery and stats viewer.

Discover Tips

  • General search

    [free text search, go nuts!]

  • Package details

    pkg:[package-name]

  • User packages

    @[username]

Sponsor

Optimize Toolset

I’ve always been into building performant and accessible sites, but lately I’ve been taking it extremely seriously. So much so that I’ve been building a tool to help me optimize and monitor the sites that I build to make sure that I’m making an attempt to offer the best experience to those who visit them. If you’re into performant, accessible and SEO friendly sites, you might like it too! You can check it out at Optimize Toolset.

About

Hi, 👋, I’m Ryan Hefner  and I built this site for me, and you! The goal of this site was to provide an easy way for me to check the stats on my npm packages, both for prioritizing issues and updates, and to give me a little kick in the pants to keep up on stuff.

As I was building it, I realized that I was actually using the tool to build the tool, and figured I might as well put this out there and hopefully others will find it to be a fast and useful way to search and browse npm packages as I have.

If you’re interested in other things I’m working on, follow me on Twitter or check out the open source projects I’ve been publishing on GitHub.

I am also working on a Twitter bot for this site to tweet the most popular, newest, random packages from npm. Please follow that account now and it will start sending out packages soon–ish.

Open Software & Tools

This site wouldn’t be possible without the immense generosity and tireless efforts from the people who make contributions to the world and share their work via open source initiatives. Thank you 🙏

© 2024 – Pkg Stats / Ryan Hefner

through2-promise

v1.1.2

Published

A small promise-based wrapper for through2

Downloads

2,654

Readme

through2-promise

A small promise-based wrapper for through2, based on RangerMauve's through2-map-promise

Quickstart

npm install --save through2-promise

Some examples:

var through2 = require("through2-promise");
fs.createReadStream('ex.txt')
.pipe(through2(function (chunk) {
    for (var i = 0; i < chunk.length; i++) {
        if (chunk[i] == 97)
            chunk[i] = 122; // swap 'a' for 'z'

        this.push(chunk);
    }
}))
.pipe(fs.createWriteStream('out.txt'))
.on('finish', function () {
    doSomethingSpecial()
});

Or object streams:

var all = []

fs.createReadStream('data.csv')
.pipe(csv2())
.pipe(through2.obj(function (chunk) {
    var data = {
        name    : chunk[0],
        address : chunk[3],
        phone   : chunk[10]
    };
    this.push(data);
}))
.on('data', function (data) {
    all.push(data)
})
.on('end', function () {
    doSomethingSpecial(all)
});

API

through2-promise([options,] [fn] [, flushFunction])

Creates a transform stream which calls your transforming function, fn. You can throw within your function to automatically reject the promise and error-out the stream. options is the optional object that gets passed into through2.

this is the through2 stream, so you can do this.push() just like in through2. If you return a Promise, and the Promise resolves to a value, this value will be written to the stream (just like passing a value to the callback in through2).

flushFunction() is a function that runs after the source stream has been consumed. It has access to this.push(), and also any value returned will be appended to the written results.

through2-promise.obj([options,] [fn] [, flushFunction])

Same as the former, but the stream is created in objectMode.

through2-promise.ctor([options,] [fn] [, flushFunction])

Creates a constructor for your transform stream in case you want to be more efficient.