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

capture-console

v1.0.2

Published

Simple and easy stdio capture for Node.js

Downloads

51,276

Readme

capture-console

Build Status Published Version Published Downloads

capture-console is a small Node.js library built to help when capturing log output via process.stdout and process.stderr. The main use case is unit testing (which is why I built it), but there's no reason it can't be used in production code paths.

Installation

capture-console lives on npm, so just install it via the command line and you're good to go.

$ npm install --save-dev capture-console

Usage

There are a whole bunch of ways to use capture-console, mainly due to scoping, with the two easiest defined below. Depending on your use case you might be pushed more towards one than the other, but in general you can just choose your preference.

Scoped Captures

The easiest way to use capture-console is with scoping; this is when the output of a provided function is captured.

Note that this form assumes synchronous execution - async stuff will require manual hookups (below).

const capcon = require('capture-console');

let stderr = capcon.captureStderr(() => {
  // whatever is done in here has stderr captured,
  // the return value is a string containing stderr
});

let stdout = capcon.captureStdout(() => {
  // whatever is done in here has stdout captured,
  // the return value is a string containing stdout
});

let stdio = capcon.captureStdio(() => {
  // whatever is done in here has both stdout and stderr captured,
  // the return value is an object with 'stderr' and 'stdout' keys
});

Manual Captures

There are also ways to manually stop and start a capture context, by passing a process stream to watch and a callback to fire on each message.

const capcon = require('capture-console');

// our buffer
let output = '';

// the first parameter here is the stream to capture, and the
// second argument is the function receiving the output
capcon.startCapture(process.stdout, stdout => {
  output += stdout;
});

// whatever is done here has stdout captured - but note
// that `output` is updated throughout execution

capcon.stopCapture(process.stdout);

// anything logged here is no longer captured

Intercepting

You should be aware that all capture functions will still pass the values through to the main stdio write() functions, so logging will still go to your standard IO devices.

If this is not desirable, you can use the intercept functions. These functions are literally s/capture/intercept when compared to those shown above, and the only difference is that calls aren't forwarded through to the base implementation.