🚀 Big News: Socket Acquires Coana to Bring Reachability Analysis to Every Appsec Team.Learn more
Socket
Sign inDemoInstall
Socket

promise-again

Package Overview
Dependencies
Maintainers
1
Versions
6
Alerts
File Explorer

Advanced tools

Socket logo

Install Socket

Detect and block malicious and high-risk dependencies

Install

promise-again

Yet another wrapper for functions that returns promise to retry rejected attempts. But this one with advanced **flexibility**.

1.3.2
latest
npm
Version published
Weekly downloads
9
Maintainers
1
Weekly downloads
 
Created
Source

promise-again

Yet another wrapper for functions that returns promise to retry rejected attempts.
But this one with advanced flexibility.

Usage

import promiseAgain from 'promise-again';

function someFunctionReturningAPromise() {
    ...
}

const wrappedFunction = promiseAgain(
    /**
    * A function that returns a promise
    **/
    someFunctionReturningAPromise,
    {
        /**
        * Optional. Delay in milisecconds or a function that returns a delay 
        * or a function that returns a promise that resolves to a delay.
        * 
        * @param reason - reason of the last rejection;
        * @param attempt - number of used attempts;
        * @param ...args - last attempt arguments;
        *
        * @returns {number | Promise<number>} - modified arguments to be used in the next attempt or a promise that is resolved to such arguments;
        **/
        delay: 1000, /*number | ((attempt: number, ...args: any[]) => number | Promise<number>)*/
        
        /**
        * Required. Number of attempts or function that returns true or a Promise that resolved to true if retry is needed;
        * 
        * @param reason - reason of the last rejection;
        * @param attempt - number of used attempts;
        * @param ...args - last attempt arguments;
        *
        * @returns {boolean | Promise<any[]>} - modified arguments to be used in the next attempt or a promise that is resolved to such arguments;
        **/
        attempts: 10, /*number | ((attempt: number, ...args: any[]) => boolean | Promise<boolean>);*/
        
        /**
        * Optional. Function that is called before every retry attempt to modify next attempt arguments;
        * 
        * @param reason - reason of the last rejection;
        * @param attempt - number of used attempts;
        * @param ...args - last attempt arguments;
        *
        * @returns {any[] | Promise<any[]>} - modified arguments to be used in the next attempt or a promise that is resolved to such arguments;
        **/
        retryArgumentsInterceptor: (reason, attempt, ...args) => args /*(reason: any, attempt: number, ...args: any[]) => any[] | Promise<any[]>;*/
    }
)

wrappedFunction().then();

Keywords

promise

FAQs

Package last updated on 25 Jun 2017

Did you know?

Socket

Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.

Install

Related posts