Add support for filter predicate in once() (#122)#124
Merged
sindresorhus merged 3 commits intosindresorhus:mainfrom Jun 20, 2025
Merged
Add support for filter predicate in once() (#122)#124sindresorhus merged 3 commits intosindresorhus:mainfrom
sindresorhus merged 3 commits intosindresorhus:mainfrom
Conversation
Owner
|
You need to update the readme and index.d.ts |
Contributor
Author
|
@sindresorhus I’ve updated the readme and index.d.ts accordingly |
This file contains hidden or 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
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.
Add support for filter predicate in once()
This change extends
once(eventNames, predicate)so you can pass an optional filter function. When provided,oncewill:• ignore any events for which
predicate(data)returns false• unsubscribe and resolve on the first event where
predicate(data)returns trueIf no predicate is passed,
oncebehaves exactly as before. The predicate is validated up-front and will throw aTypeErrorif it’s not a function. Four new tests cover:• resolving only on the first matching event
• throwing on invalid predicate types
• using multiple event names
• unsubscribing via
promise.off()before a matchCloses #122