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

sinon-stub-promise

v4.0.0

Published

Synchronous Promise stubbing for Sinon.JS

Downloads

88,477

Readme

sinon-stub-promise

Build Status

This is a little package that makes testing of promises easier when stubbing with Sinon.JS. This library ensures stubbed promises are evaluated synchronously, so that no special async tricks are required for testing.

Installation

Install with npm: npm install --save-dev sinon-stub-promise

In node, you can initialize with sinon:

var sinon = require('sinon');
var sinonStubPromise = require('sinon-stub-promise');
sinonStubPromise(sinon);

Or in the browser, you can just include node_modules/sinon-stub-promise/index.js (assumes sinon is available on window object).

Example

// Code under test
function doSomethingWithAPromise(promise, object) {
  promise()
    .then(function(value) {
      // resolves
      object.resolved = value
    })
    .catch(function(value) {
      // rejects
      object.rejected = value
    });
}

// Test
describe('stubbing a promise', function() {
  var promise;

  beforeEach(function() {
    promise = sinon.stub().returnsPromise();
  });

  it('can resolve', function() {
    promise.resolves('resolve value')

    var testObject = {};
    doSomethingWithAPromise(promise, testObject);
    expect(testObject.resolved).to.eql('resolve value');
  });

  it('can reject', function() {
    promise.rejects('reject value')

    var testObject = {};
    doSomethingWithAPromise(promise, testObject);
    expect(testObject.rejected).to.eql('reject value');
  });
}

Why?

We wanted a nice synchronous way of stubbing out promises while testing, and the existing solution, sinon-as-promised, uses a promise under the hood to achieve the stubbing. The issue with this, is that the promise is evaluated asynchronously, so the test code has to deal with that by delaying the assertion until the promise has a chance to run.

Additionally, sinon-as-promised requires you to call either stub.resolves() or stub.rejects() before it will setup the stub as a "thenable" object (one that has then and catch on it). The trouble with this is that if you are testing conditional branches (e.g. test what happens when promise succeeds, then test what happens when promise fails), you have to either resolve or reject the promise for the code under test to pass.

Usage with Karma

In order to use this with the Karma test runner you can either add node_modules/sinon-stub-promise/index.js to files in your config or, alternatively, use the karma-sinon-stub-promise plugin.

Stability?

This is not a Promises/A+ compliant library. We built it to support how we are currently using promises. There is a test suite that will grow over time as we identify any short comings of this library.

To Do

  • Allow for chaining with withArgs. Ideally we could do things like sinon.stub().withArgs(42).resolves('value').