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

typescript-mutex-decorator

v0.1.2

Published

Makes sure a method is called only once at a time and queues all subsequent requests, good for talking to robots

Downloads

3

Readme

TypeScript Mutex Decorator

Makes sure a method is called only once at a time and queues all subsequent requests, good for talking to robots

Quickstart

Install

npm i @melletron/typescript-mutex-decorator

Usage

Simple usage if you want to have one system-wide queue

class Example {
    @mutex() // Decorate method using the default retry timeout (100ms)
    public decorated(answer: number): Promise<void> {
        // do some stuff
        return new Promise((resolve) => {
            // Return a promise
            // You can also make it an async method 
        });
    }
}

Simple usage if you want to override the timeout with a custom timeout

class Example {
    @mutex(0) // Retry the method call within 0ms after first try
    public decorated(answer: number): Promise<void> {
        // do some stuff
        return new Promise((resolve) => {
            // Return a promise
            // You can also make it an async method 
        });
    }
}

Spawn a new mutex on the fly so that you can have your own queue only for that method

class Example {
    @mutexer()() // Create an own instance of the mutex decorator and decorate method using the default retry timeout (100ms) 
    public decorated(answer: number): Promise<void> {
        // do some stuff
        return new Promise((resolve) => {
            // Return a promise
            // You can also make it an async method 
        });
    }
}

You can also set a custom timeout on the decorator you just spawned Spawn a new mutex on the fly so that you can have your own queue only for that method

class Example {
    @mutexer()(0) // Create an own instance of the mutex decorator and retry the method call within 0ms after first try 
    public decorated(answer: number): Promise<void> {
        // do some stuff
        return new Promise((resolve) => {
            // Return a promise
            // You can also make it an async method 
        });
    }
}

Testing the source code

% npm run coverage

> @melletron/[email protected] coverage
> nyc -r text -e .ts -x "src/tests/*.test.ts" npm run test


> @melletron/[email protected] test
> mocha -r ts-node/register src/tests/**/*.test.ts



  mutex
    ✔ only allows a single execution of the method at a time
    ✔ unlocks if a mutexed method throws an error (102ms)


  2 passing (106ms)

----------|---------|----------|---------|---------|-------------------
File      | % Stmts | % Branch | % Funcs | % Lines | Uncovered Line #s 
----------|---------|----------|---------|---------|-------------------
All files |     100 |      100 |     100 |     100 |                   
 mutex.ts |     100 |      100 |     100 |     100 |                   
----------|---------|----------|---------|---------|-------------------