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

brianmhunt-mutex-promise

v1.0.13

Published

Promises with uncaught handling and events

Downloads

16

Readme

Mutex Promise

A+ Compliant (and mostly follows ECMA-262) ES6 Promises with a few extra features that can help with debugging :

  • events
  • temporal mutual exclusion
  • uncaught checking
  • creation and chaining call stack

This implementation is primarily designed for testing, and a reasonably readable spec-compliant implementation. Its main intended purpose is as a drop-in replacement for the built-in ES6 implementation when one is developing and debugging

This implementation is not intended to be used in production. As it is itself written in ES6 Javascript meaning,

  • there's already a native Promise class;
  • this would need to be transpiled for backwards compatibility; and, in any case
  • this implementation is not fast compared to others.

Install

$ npm install brianmhunt-mutex-promise

Events

The following events are available:

  • new - a new promise was created
  • reject - a promise was rejected
  • resolve - a promise was resolved
  • uncaught - a rejection not caught
  • trespass - a promise was resolved/rejected outside its mutex

The this of each shall be the promise from which it was thrown.

Register events with e.g.

Promise.on('new', function () { /* this = promise instance */ })

Unregister events with

Promise.off('new', fn)

Temporal mutual exclusion

You can set an identifier that when not strictly equal when promises are chained will result in atrespass event being emitted. For example:

Promise.setMutex("abc")
p = new Promise(function () {}).then(function () {})
Promise.setMutex("def")
p.then(function () {})

// This will emit `trespass` twice - once for both `then`'s because they
// are both asynchronously resolved.

The trespass event receives a data argument with two events, like this:

{
  promiseMutexTo: this.mutexTo,
  mutexId: MutexPromise.mutexId
}

For a more solid example, consider a testing scenario with Mocha:

beforeEach(function () {
  // Any promises created after this, but before the next `beforeEach` will
  // be in the same mutex period.
  Promise.setMutex(this.currentTest)  
})

after(function () {
  // Catch any promises resolved after testing completes.
  Promise.setMutex('Tests complete')
})

Promise.on('trespass', function (data) {
  console.error("A promise started in test ", data.promiseMutexTo,
    "was concluded after that test completed, specifically:", data.mutexId)
})

Uncaught Checking

An uncaught event is raised, following roughly the logic of:

  • A rejection is raised;
  • After a short period of time, no rejection handler has been added (via .then, race or all) that would catch it

Note:

Creation and Chaining Call Stack

Each promise instance has a creationStack property, and once resolved or rejected a resolutionStack property.

License & Thanks

© 2016 Brian M Hunt (MIT License)

Thanks to NetPleadings/Conductor for time to work on this!