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

promise-spin-wait

v1.0.1

Published

An ES6-Promise based spin wait

Downloads

2

Readme

promise-spin-wait Build Status

An ES6-Promise based spin wait

Install

$ npm install --save promise-spin-wait

Usage

Imagine you'd want to test a script that sends emails. Sadly the infrastructure that actually sends them is out of your controll, so emails are not delivered instantly. This is when a spin wait can be useful, it allows you to check regularly for a certain criteria until it's fulfilled.

const spinner = require('promise-spin-wait');

return sendEmail() // Asyncronous, but it will return before the email has actually been delivered
.then(() => {
    return spinner(
        () => {
            return getEmailInboxCount().then(n => n > 0);
        },
        {
            message: "Timeout: No Email received",
            timeout: 5000,
            interval: 500
        }
    );
})

API

spinner(fn, options)

Returns a promise for a the first truish response of fn() or the first rejected promise of fn();

fn

A function returning a value or a promise. If a promise is returned fn() will not be called again until it is resolved. Any errors thrown or promise rejections will lead to the spinner rejecting as well.

Only a truish return value will lead to the spinner stopping.

options

message

Type: string Default: Timeout

Message thrown when timeout occurs

timeout

Type: number Default: 5000

Milliseconds since start when instead of calling fn again an timeout error will be returned

interval

Type: number Default: 100

Duration between the last time fn() has been fulfilled and the next fn() is being called

License

MIT © marekventur