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

@contrast/dep-hooks

v1.10.0

Published

Post hooks for Module.prototype.require

Downloads

83,410

Readme

@contrast/dep-hooks

Intercept calls to require in order to modify or replace exports.

Usage

Class: DepHooks

Instantiation

const DepHooks = require('./lib');
const depHooks = new DepHooks();

The DepHooks constructor accepts a pino logger as an argument.

.resolve(descriptor, ...handlers)

Options:

  • descriptor: This can be a string or an object describing the module you want to intercept. If a string is used, or if the version field of the descriptor isn't set, all versions of the described module will be matched. Descriptors can have a name, version, and file property.

  • handlers: The remaning arguments are the handlers which will be invoked when the described module is require'd. Each handler is passed the exported module and metadata including the module's root directory and its name and version as seen in its package.json file. If a handler returns a truthy value, then that value will replace the return value of require.

Note: Registered handlers run once per unique instance of an export matching a descriptor.

.install()

This will monkey-patch Module.prototype.require so that exports can be intercepted. The monkey-patching will only happen once regardless of how many times this is invoked.

.uninstall()

This will reset Module.prototype.require to its value before being monkey-patched by the instance.

Examples

Use case: For express versions greater than or equal to 4, intercept the export of the package's lib/view.js file (relative to the package's base directory) and apply a tag to the exported function.

const DepHooks = require('./lib');
const depHooks = new DepHooks();
depHooks.resolve(
  {
    name: 'express',
    version: '>=4',
    file: 'lib/view.js',
  },
  (xport, metadata) => {
    // Read from the package.json:
    // - metadata.name
    // - metadata.version
    // Absolute path to file:
    // - metadata.packageDir

    // xport === function View() { /*...*/ }
    xport['I was intercepted'] = true;
  },
);

Use case: Intercept all versions of body-parser and replace the exported functions.

const DepHooks = require('./lib');
const depHooks = new DepHooks();
depHooks.resolve({ name: 'body-parser' }, (xport, metadata) => {
  // Read from the package.json:
  // - metadata.name
  // - metadata.version
  // Absolute path to file:
  // - metadata.packageDir

  // xport === function bodyParser() { /*...*/ }
  return function bodyParserReplacement() {
    /*...*/
  };
});