1.0.9 • Published 1 year ago

bask-promise v1.0.9

Weekly downloads
-
License
ISC
Repository
-
Last release
1 year ago

BASK Promise

Set of common promise utilities, not available in basic node.js features

  • Delay promise
  • Delay before or after promise
  • Run promises in sequence, e.g. requests to database
  • Repeated failed promises

Install

npm i bask-promise --save

Then import module in code:

const promises = require('bask-promise');
promises.delay(100);

Or

const {delay} = require('bask-promise');
delay(100);

Delay

Simple delay

const {delay} = require('bask-promise');
delay(1000).then(() => console.log('Run after 1 second'));

Delay after promise

const {delayAfter} = require('bask-promise');
delayAfter(Promise.resolve('1 second delay after'), 1000);

Delay before promise

const {delayBefore} = require('bask-promise');
delayBefore(() => Promise.resolve('1 second delay before'), 1000);

Random delay

Random time period delay

const {random} = require('bask-promise');
random(1000).then(() => console.log('Run after 0...1 second'));

Specify lower bound

const {random} = require('bask-promise');
random(2000, 1000).then(() => console.log('Run after 1...2 seconds'));

Random delay after promise

const {randomAfter} = require('bask-promise');
randomAfter(Promise.resolve('0...1 second delay after'), 1000);
randomAfter(Promise.resolve('0...2 second delay after'), 2000, 1000);

Random delay before promise

const {randomBefore} = require('bask-promise');
randomBefore(() => Promise.resolve('0...1 second delay before'), 1000);
randomBefore(() => Promise.resolve('1...2 second delay before'), 2000, 1000);

Delay callback

If you want to use delay as a callback inside then, you can use delayFun(ms)

const {delayFun} = require('bask-promise');
Promise.resolve("Delay for 1s in then after promise").then(delayFun(1000));

Sequence

Node.js have basic Promise.all function to run promises in parallel, but to run sequence you have to implement it yourself. This is a typical task for example when quering database or external services.

const {sequence} = require('bask-promise');
sequence([
        () => Promise.resolve('Query database 1'),
        () => Promise.resolve('Query database 2'),
    ])

If you have the same query function, but different arguments - use keySequence:

const {keySequence} = require('bask-promise');
keySequence([1,2,3,4,5], key => queryDatabasePromise(key));

Repeat

Sometimes you need to ensure request that is properly executed. But due to network connections, requests can fail. In that case you may want to repeat failed requests automatically.

Repeat up to 3 times (4 calls total):

const {repeat} = require('bask-promise');
repeat(() => repeatThisPromiseIfFails(), 3);

Repeat until success:

repeat(() => repeatThisPromiseIfFails(), -1);

Log every error

repeat(() => repeatThisPromiseIfFails(), 3, error => console.error(error));

Delay after error

const {repeat, delay} = require('bask-promise');
repeat(() => repeatThisPromiseIfFails(), 3, error => delay(1000));

Promise resolve from outside

If you need to create a promise instance, pass it somewhere, and resolve it later from outside, you can use deferred function

const {deferred} = require('bask-promise');
const promise = deferred();

//use or pass promise somewhere
promise.then(() => null).catch(() => null);

//then resolve promise
promise.resolve(42);
//or
promise.reject(new Error("foo"));
1.0.9

1 year ago

1.0.8

1 year ago

1.0.7

1 year ago

1.0.6

2 years ago

1.0.5

3 years ago

1.0.4

3 years ago

1.0.3

3 years ago

1.0.2

3 years ago

1.0.1

3 years ago

1.0.0

3 years ago