Add .onSizeLessThan() helper method
#131
Merged
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
sindresorhus
changed the title
.onSizeLessThan() helper method
readme.md
Outdated
| adding a new item. | ||
|
|
||
| Note that this only limits the number of items waiting to start; there could still be up to `concurrency` jobs | ||
| already running that this call does not include in its calculation. |
There was a problem hiding this comment.
Can you use the same docs text here and in the TS doc comment? I know we have not done that before, but it makes it easier to keep both up to date if they are in sync.
Co-authored-by: Sindre Sorhus <[email protected]>
|
I copied the readme changed over to the TS comment. Let me know if there's anything else I can do to help. |
Totenfluch
pushed a commit
to Totenfluch/p-queue
that referenced
this pull request
Jul 18, 2021
Co-authored-by: Sindre Sorhus <[email protected]>
Arnagos
pushed a commit
to Arnagos/p-queue
that referenced
this pull request
May 2, 2022
Co-authored-by: Sindre Sorhus <[email protected]>
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.
Returns a promise that settles when the queue size is less than the given limit;
queue.size < limit.If you want to avoid having the queue grow beyond a certain size you can
await queue.onSizeLessThan()beforeadding a new item.
Note that this only limits the number of items waiting to start; there could still be up to
concurrencyjobsalready running that this call does not include in its calculation.