-
-
Notifications
You must be signed in to change notification settings - Fork 102
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
1 parent
056c0f3
commit f005eee
Showing
3 changed files
with
17 additions
and
22 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,29 +1,29 @@ | ||
export interface Limit { | ||
/** | ||
* @param fn - Promise-returning/async function. | ||
* @param arguments - Any arguments to pass through to `fn`. Support for passing arguments on to the `fn` is provided in order to be able to avoid creating unnecessary closures. You probably don't need this optimization unless you're pushing a lot of functions. | ||
* @returns The promise returned by calling `fn(...arguments)`. | ||
*/ | ||
@param fn - Promise-returning/async function. | ||
@param arguments - Any arguments to pass through to `fn`. Support for passing arguments on to the `fn` is provided in order to be able to avoid creating unnecessary closures. You probably don't need this optimization unless you're pushing a lot of functions. | ||
@returns The promise returned by calling `fn(...arguments)`. | ||
*/ | ||
<Arguments extends unknown[], ReturnType>( | ||
fn: (...arguments: Arguments) => PromiseLike<ReturnType> | ReturnType, | ||
...arguments: Arguments | ||
): Promise<ReturnType>; | ||
|
||
/** | ||
* The number of promises that are currently running. | ||
*/ | ||
The number of promises that are currently running. | ||
*/ | ||
readonly activeCount: number; | ||
|
||
/** | ||
* The number of promises that are waiting to run (i.e. their internal `fn` was not called yet). | ||
*/ | ||
The number of promises that are waiting to run (i.e. their internal `fn` was not called yet). | ||
*/ | ||
readonly pendingCount: number; | ||
} | ||
|
||
/** | ||
* Run multiple promise-returning & async functions with limited concurrency. | ||
* | ||
* @param concurrency - Concurrency limit. Minimum: `1`. | ||
* @returns A `limit` function. | ||
*/ | ||
Run multiple promise-returning & async functions with limited concurrency. | ||
@param concurrency - Concurrency limit. Minimum: `1`. | ||
@returns A `limit` function. | ||
*/ | ||
export default function pLimit(concurrency: number): Limit; |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters