Blame view

node_modules/p-limit/readme.md 1.38 KB
aaac7fed   liuqimichale   add
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
60
61
62
63
64
65
66
67
68
69
  # p-limit [![Build Status](https://travis-ci.org/sindresorhus/p-limit.svg?branch=master)](https://travis-ci.org/sindresorhus/p-limit)
  
  > Run multiple promise-returning & async functions with limited concurrency
  
  
  ## Install
  
  ```
  $ npm install p-limit
  ```
  
  
  ## Usage
  
  ```js
  const pLimit = require('p-limit');
  
  const limit = pLimit(1);
  
  const input = [
  	limit(() => fetchSomething('foo')),
  	limit(() => fetchSomething('bar')),
  	limit(() => doSomething())
  ];
  
  (async () => {
  	// Only one promise is run at once
  	const result = await Promise.all(input);
  	console.log(result);
  })();
  ```
  
  
  ## API
  
  ### pLimit(concurrency)
  
  Returns a `limit` function.
  
  #### concurrency
  
  Type: `number`<br>
  Minimum: `1`
  
  Concurrency limit.
  
  ### limit(fn)
  
  Returns the promise returned by calling `fn`.
  
  #### fn
  
  Type: `Function`
  
  Promise-returning/async function.
  
  
  ## Related
  
  - [p-queue](https://github.com/sindresorhus/p-queue) - Promise queue with concurrency control
  - [p-throttle](https://github.com/sindresorhus/p-throttle) - Throttle promise-returning & async functions
  - [p-debounce](https://github.com/sindresorhus/p-debounce) - Debounce promise-returning & async functions
  - [p-all](https://github.com/sindresorhus/p-all) - Run promise-returning & async functions concurrently with optional limited concurrency
  - [More…](https://github.com/sindresorhus/promise-fun)
  
  
  ## License
  
  MIT © [Sindre Sorhus](https://sindresorhus.com)