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

proxable

v1.1.1

Published

Function wrapper for direct stubbing and spying

Downloads

5

Readme

Proxable

Simple, unobtrosive function wrapper to allow for direct stubbing and spying. This is useful when writing tests for code that declares its dependencies using object destructuring or ESM import statements.

Returns the original function when NODE_ENV=production for zero overhead in production. This can be overruled by also setting PROXABLE=true.

Functions

createProxable(fn)

Takes a function fn to wrap (required).

Returns a wrapped function that proxies throught to fn by default.

Aliases: proxable(), create()

installStub(proxable, [stub])

Takes a wrapped proxable function (required) and a stub function or value.

  • If stub is a function, it is installed as the proxable's' replacement function. function's original.
  • If stub is any other value, a new function that returns the value stub is installed as the proxable's replacement.

Returns the replacement function.

Alias: stub()

installProxy(proxable, proxyMap)

Takes a wrapped proxable function (required) and a function that maps the original function to a replacement function (required).

Returns the replacement function.

Alias: proxy()

restoreOriginal(proxable)

Takes a wrapped proxable function (required) and restores its original behaviour.

Alias: restore()

Use case

What if you want to unit test the following code?

// users.js

const { find } = require('./database')

module.exports = {
  findUser (username) {
    return find('user', { name: username });
  }
}

You might want to stub out database.find using sinon (or similar). Normally you'd do something like this:

// users.test.js

const sinon = require('sinon')
const users = require('./users')
const database = require('./database')

sinon.stub(database, 'find')

But this won't work, since users.js has a direct reference to the orignal, unstubbed database.find:

const users.findUser('steve')
assert.equal(database.find.callCount, 1) // !-> AssertionError [ERR_ASSERTION]: 0 == 1

That's where proxable comes in. By instrumenting database.find, you can stub or spy on it even for code that has a direct reference to it:

// database.js

const { createProxable } = require('proxable')

module.exports {
  find: createProxable(function find (table, params) {
    // [...]
  })
}

Which allows you to stub it in your test:

// users.test.js

const { installStub, restoreOriginal } = require('proxable')
const sinon = require('sinon')
const users = require('./users')
const database = require('./database')

installStub(database.find, sinon.stub())

const users.findUser('steve')
assert.equal(database.find.callCount, 1) // -> OK

restoreOriginal(database.find)

License

Distributed under the ISC license (see LICENSE).