Utils: `promises`
Table of contents
Interfaces
Type Aliases
Functions
Type Aliases
PWhileOptions
Ƭ PWhileOptions: Object
Type declaration
Name | Type | Description |
---|---|---|
enabledJitter? | boolean | enable jitter to stagger requests |
error? | string | error that can be expressed if the timer ends because the function does not return true |
maxJitter? | number | the maximum the jitter wait time will be (in milliseconds), defaults to 3x the minJitter setting, but less than timeoutMs |
minJitter? | number | the minimum the jitter wait time will be (in milliseconds), defaults to 100ms |
name? | string | Defaults to "Request" |
timeoutMs? | number | Defaults to -1 which is never |
Defined in
packages/utils/src/promises.ts:217
Functions
getBackoffDelay
▸ getBackoffDelay(current
, factor?
, max?
, min?
): number
Get backoff delay that will safe to retry and is slightly staggered
Parameters
Name | Type | Default value |
---|---|---|
current | number | undefined |
factor | number | 2 |
max | number | 60000 |
min | number | 500 |
Returns
number
Defined in
packages/utils/src/promises.ts:316
pDefer
▸ pDefer(): Object
An alternative to Bluebird.defer: http://bluebirdjs.com/docs/api/deferred-migration.html Considered bad practice in most cases, use the Promise constructor
Returns
Object
Name | Type |
---|---|
promise | Promise <any > |
reject | (reason? : any ) => void |
resolve | (value? : unknown ) => void |
Defined in
packages/utils/src/promises.ts:416
pDelay
▸ pDelay<T
>(delay?
, arg?
): Promise
<T
>
promisified setTimeout
Type parameters
Name | Type |
---|---|
T | undefined |
Parameters
Name | Type |
---|---|
delay? | number |
arg? | T |
Returns
Promise
<T
>
Defined in
packages/utils/src/promises.ts:13
pImmediate
▸ pImmediate<T
>(arg?
): Promise
<T
>
promisified process.nextTick,setImmediate or setTimeout depending on your environment
Type parameters
Name | Type |
---|---|
T | undefined |
Parameters
Name | Type |
---|---|
arg? | T |
Returns
Promise
<T
>
Defined in
packages/utils/src/promises.ts:47
pRace
▸ pRace(promises
, logError?
): Promise
<any
>
Run multiple promises at once, and resolve/reject when the first completes
Parameters
Name | Type |
---|---|
promises | Promise <any >[] |
logError? | (err : any ) => void |
Returns
Promise
<any
>
Defined in
packages/utils/src/promises.ts:360
pRaceWithTimeout
▸ pRaceWithTimeout(promises
, timeout
, logError?
): Promise
<any
>
Similar to pRace but with
Parameters
Name | Type | |
---|---|---|
promises | Promise <any > \ | Promise <any >[] |
timeout | number | |
logError? | (err : any ) => void |
Returns
Promise
<any
>
Defined in
packages/utils/src/promises.ts:385
pRetry
▸ pRetry<T
>(fn
, options?
): Promise
<T
>
A promise retry fn.
Type parameters
Name | Type |
---|---|
T | any |
Parameters
Name | Type |
---|---|
fn | PromiseFn <T > |
options? | Partial <PRetryConfig > |
Returns
Promise
<T
>
Defined in
packages/utils/src/promises.ts:125
pWhile
▸ pWhile(fn
, options?
): Promise
<void
>
Run a function until it returns true or throws an error
Parameters
Name | Type |
---|---|
fn | PromiseFn <any > |
options | PWhileOptions |
Returns
Promise
<void
>
Defined in
packages/utils/src/promises.ts:243
waterfall
▸ waterfall(input
, fns
, addBreak?
): Promise
<any
>
Async waterfall function
Parameters
Name | Type | Default value |
---|---|---|
input | unknown | undefined |
fns | PromiseFn <any >[] | undefined |
addBreak | boolean | false |
Returns
Promise
<any
>