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-with-retry

v2.0.1

Published

Easily retry operations with any retry strategy you want.

Downloads

3

Readme

promise-with-retry

Build Status Coverage Status Dependency Status

Easily retry operations with any retry strategy you want.

Support async functions or functions returned Promise.

Intall

npm install promise-with-retry --save

Usage

const RetryOp = require('promise-with-retry').default;

function promiseOperation(...args) {
    return new Promise((resolve: any, reject: any) => {
        // ...
    });
}

async function asyncOperation(...args) {
    // ...
}

let myOp = RetryOp.buildOperation(promiseOperation);
// or async function:
// let myOp = RetryOp.buildOperation(asyncOperation);

let myRetry = new RetryOp(myAsyncOp(500), (retryOptions) => {
    if (retryOptions.returns.error) {
        // retry after 5000ms
        return 5000; 
    }
    // finish
    return;
});

Events

op_resolve

op is resolved

myRetry.on('op_resolve', (retryOptions, data) => {
});
  • data: value op resolved

op_reject

op is rejected

myRetry.on('op_reject', (retryOptions, error) => {
});
  • error: error op rejected

retry

event before op is executed

myRetry.on('retry', (retryOptions) => {
});

finish

op has stop retry

myRetry.on('finish', (retryOptions) => {
});

API

RetryOp.buildOperation(fn)

  • fn: async function or function returned Promise

new RetryOp(op, retryStrategy)

  • op: value returned by RetryOp.buildOperation(fn)
  • retryStrategy: (retryOptions) => {} return a number (ms) as timeout, the retry will happen exactly after that time in milliseconds. if return is not number, will not retry.

retryOptions:

  • startTime: number, ms
  • totalRetryCount: number
  • returns: return of op:
    • error: error op rejected
    • data: value op resolved

Example

typescript example:

import RetryOp from 'promise-with-retry';

async function asyncOperation(ms: number) {
    // ...
}

let myAsyncOp = RetryOp.buildOperation(asyncOperation);
let myRetry = new RetryOp(myAsyncOp(500), (retryOptions) => {
    if (retryOptions.totalRetryCount < 3) {
        // will retry after 500ms
        return 500;
    }
    // stop retry
    return;
});

myRetry.on('finish', (retryOptions) => {
});

Test

npm tet