Limit function #88
Merged
Limit function #88
Conversation
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
added 2 commits
December 3, 2024 20:27
sindresorhus
requested changes
Dec 4, 2024
readme.md
Outdated
| @@ -77,6 +90,28 @@ Note: This does not cancel promises that are already running. | |||
|
|
|||
| Get or set the concurrency limit. | |||
|
|
|||
| ### limitFunction(fn, options) | |||
|
|
|||
| Return a function with limited concurrency | |||
There was a problem hiding this comment.
Suggested change
| Return a function with limited concurrency | |
| Return a function with limited concurrency. |
This needs to clearly describe how it's different from the main export.
readme.md
Outdated
|
|
||
| Minimum: `1` | ||
|
|
||
| #### option |
readme.md
Outdated
|
|
||
| #### concurrency | ||
|
|
||
| Type: `number`(Interget) |
readme.md
Outdated
| @@ -28,6 +28,19 @@ const result = await Promise.all(input); | |||
| console.log(result); | |||
| ``` | |||
|
|
|||
| ```js | |||
| import {limitFunction} from 'p-limit'; | |||
There was a problem hiding this comment.
Move this example to the limitFunction API docs.
index.d.ts
Outdated
| @@ -41,3 +41,22 @@ Run multiple promise-returning & async functions with limited concurrency. | |||
| @returns A `limit` function. | |||
| */ | |||
| export default function pLimit(concurrency: number): LimitFunction; | |||
|
|
|||
| export type LimitFunctionOption = { | |||
There was a problem hiding this comment.
Actually, just name it Options as I would like to make pLimit support an options-object too, for readability.
index.d.ts
Outdated
Comment on lines
53
to
58
| Return a function with limited concurrency | ||
|
|
||
| @param function_ - Promise-returning/async function. | ||
| @param option | ||
| @return Function with limited concurrency | ||
| */ |
There was a problem hiding this comment.
Suggested change
| Return a function with limited concurrency | |
| @param function_ - Promise-returning/async function. | |
| @param option | |
| @return Function with limited concurrency | |
| */ | |
| Return a function with limited concurrency. | |
| @param function_ - Promise-returning/async function. | |
| @return Function with limited concurrency. | |
| */ |
readme.md
Outdated
|
|
||
| Return a function with limited concurrency. | ||
|
|
||
| Note: Unlike fucntion return by `pLimit`, the return by `limitFunction` is already limited, do not need call with `limit`. |
There was a problem hiding this comment.
Multiple typos and does not make it super clear what the difference is. Maybe try using ChatGPT.
There was a problem hiding this comment.
Should be in index.d.ts too
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
No description provided.