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 🙏

© 2022 – Pkg Stats / Ryan Hefner

mutex-promise

v0.1.0

Published

Small JS mutex library

Downloads

1,443

Readme

Promise Mutex

A simple JS Mutex library that works both in browser and NodeJS. Library ensures that asynchronous code will wait until the mutex is unlocked, even if it was locked from another tab.

The usual use-case is when you need to do a server request and you'd like to make sure that only one concurrent request will be executed, others will wait until the mutex is unlocked, no matter which tab has created the request.

Installation

Browser

$ bower install promise-mutex

Or download the raw file.

NodeJS

$ npm install mutex

API

var MutexPromise = require('mutex-promise'); // in NodeJS, in browser this is not needed

var mutex = new MutexPromise('key', {...options}); // key will be used for localStorage, so it should be unique enough

Options:

  • timeout — mutex will be automatically unlocked after timeout
  • interval — how frequently to poll the storage for changes
// Lock the mutex
mutex.lock();

// Get a promise that resolves when mutex is unlocked or expired
mutex.promise().then(function(mutex){ ... });

// Unlock the mutex
mutex.unlock();

Example

The function ensures that only one concurrent request may be executed.

var mutex = new MutexPromise('some-very-unique-key');

function doStuffExclusively(mutex) {
    return mutex.promise()
        .then(function(mutex){
            mutex.lock();
            return fetch('http://localhost', {method: 'PUT', body: ...});
        })
        .then(function(res){
            mutex.unlock();
            return res;
        })
        .catch(function(e){
            mutex.unlock();
            throw e;
        });
}

doStuffExclusively(mutex);
doStuffExclusively(mutex);
doStuffExclusively(mutex);

Dependencies

Library uses Promises, modern browsers these days have native implementation, for old ones you can use any polyfill.

To store data library uses LocalStorage in browser and a simple Storage object in NodeJS. Keep in mind, that library's built-in NodeJS storage is not persistent, nothing is shared between processes or script runs. If you need to have persistent mutexes you can inject a persistent Storage implementation via DI. Implementation must have at least getValue(key, value), setValue(key) and removeValue(key) methods, which has to be synchronous.

To inject custom implementations of Promise or Storage:

MutexPromise.Promise = ...;
MutexPromise.localStorage = ...;