UNPKG

p-min-delay

Version:

Delay a promise a minimum amount of time

github.com/sindresorhus/p-min-delay

sindresorhus/p-min-delay

59 lines (34 loc) • 1.52 kB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
# p-min-delay > Delay a promise a minimum amount of time While the [`delay`](https://github.com/sindresorhus/delay) module delays the promise a specified amount of time and then resolves it, this module ensures the promise resolves after the specified amount of time. Useful when you have a promise that may settle immediately or may take some time, and you want to ensure it doesn't settle too fast. For example, if you want to show a loading indicator for at least 1 second (but longer if needed) to prevent a confusing flash in the UI. ## Install ```sh npm install p-min-delay ``` ## Usage ```js import pMinDelay from 'p-min-delay'; const value = await pMinDelay(somePromise, 1000); // Executed after minimum 1 second even if `somePromise` fulfills before that ``` ## API ### pMinDelay(promise, minimumDelay, options?) #### promise Type: `Promise` Promise to delay. #### minimumDelay Type: `number` Time in milliseconds. #### options Type: `Object` ##### delayRejection Type: `boolean`\ Default: `true` Delay the rejection. Turn this off if you want a rejected promise to fail fast. ## Related - [delay](https://github.com/sindresorhus/delay) - Delay a promise a specified amount of time - [p-immediate](https://github.com/sindresorhus/p-immediate) - Returns a promise resolved in the next event loop - think `setImmediate()` - [p-timeout](https://github.com/sindresorhus/p-timeout) - Timeout a promise after a specified amount of time - [More…](https://github.com/sindresorhus/promise-fun)