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-get

v1.0.0

Published

A through2 to create a lodash.get analog for streams

Downloads

7,637

Readme

through2-get

Version License Test Coverage Status

This is a super thin wrapper around through2 that works like _.get but for streams.

For when through2 is just too verbose :wink:

IMPORTANT: If you return null from your function, the stream will end there.

IMPORTANT: _.get can only be applied to object streams.


var get = require("through2-get");

var content = get('content');

// vs. with through2:
var content = through2(function (chunk, encoding, cb) {
  this.push(_.get(chunk, 'content'));
  return cb();
})

// Then use your get:
source.pipe(content).pipe(sink)

// Works like `_.get` meaning you can specify a path and a default value
var contentEach = get({excludeZBS: true}, 'content', '');

// vs. with through2:
var contentEach = through2(function (chunk, encoding, cb) {
  var out = _.get(chunk, 'content', '');
  if (out === '') return cb();
  this.push(out);
  return cb();
});

Differences from _.get:

  • Cannot insert null elements into the stream without aborting.

API

require("through2-get")([options,] path, [defaultValue])

Create a stream.Transform instance with objectMode: true defaulting to true that will call _.get(path, defaultValue) on each stream object.

var Tx = require("through2-get").ctor([options,] path, [defaultValue])

Create a reusable stream.Transform TYPE that can be called via new Tx or Tx() to create an instance.

Arguments

  • options
    • excludeZBS (boolean): defaults true.
    • all other through2 options.
  • path (Array|string): The path of the property to get.
  • [defaultValue] (*): The value returned if the resolved value is undefined.