[breaking] feat: Moves minimumWait to wait and updates to LTS only
#33
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
jakobo
force-pushed
the
jakobo/32
branch
2 times, most recently
from
8848211
to
5ee154e
Compare
jakobo
changed the title
minimumWait to wait and updates to LTS onlyminimumWait to wait and updates to LTS only
jakobo
commented
Aug 30, 2023
|
There are still mentions of |
There's been ongoing discussion in the original PR and in sindresorhus#32 about naming the "wait" value. At registration time, it's the minimum amount of time a function waits, but at `gracefulExit`, it's the largest minimum wait value. To eliminate this confusion, the option was renamed to "wait" and the documentation was updated to reflect this. Because this is a breaking change, we're also co-introducing the LTS changes. They can be split off into a separate PR if desired, but it did not add subtantial complexity to this PR. BREAKING CHANGES: * `minimumWait` is now `wait` * Package requires Node 18+ (currently supported LTS)
|
That's on me. I forgot index.d.ts wasn't auto-generated. Force pushed after doing a grep and ensuring docs matched code. Also, are you ok bundling this + the LTS change as 4.0 (requires node 18+)? |
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.
There's been ongoing discussion in the original PR and in #32 about naming the "wait" value. At registration time, it's the minimum amount of time a function waits, but at
gracefulExit, it's the largest minimum wait value. To eliminate this confusion, the option was renamed to "wait" and the documentation was updated to reflect this.Because this is a breaking change, we're also co-introducing the LTS changes. It can be split off into a separate PR if desired, but it did not add substantial complexity to this PR.
BREAKING CHANGES (forces major bump):
minimumWaitis nowwait