refactor!: split file handles into seperate function #126
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
Signed-off-by: Jon Koops <[email protected]> BREAKING CHANGE: Arrays of `FileSystemFileHandle` are now handled in a dedicated `fromFileHandles()` function.
Pull Request Test Coverage Report for Build 12412031215Details
💛 - Coveralls |
|
@rolandjitsu could I get your input on this PR? If you are enjoying the holidays don't worry, this can all certainly wait until next year. |
Sorry for the late reply. Gonna have a look at this now. |
rolandjitsu
reviewed
Jan 13, 2025
|
@rolandjitsu can we merge this one as-is, or would you like me to make further changes? I have some other work lined up that I'd like to get in as well. |
rolandjitsu
approved these changes
Feb 23, 2025
|
🎉 This PR is included in version 3.0.0-beta.6 🎉 The release is available on: Your semantic-release bot 📦🚀 |
|
Nice, thanks for the merge, I will see if I can dig up some more of the work I had in the pipeline for the next major and get it into shape. |
12 tasks
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.
What kind of change does this PR introduce?
Did you add tests for your changes?
If relevant, did you update the documentation?
Summary
Removes the handling of
FileSystemFileHandlearrays from thefromEvent()function, and moves it to a dedicatedfromFileHandles()function purposefully made for handling this data type. This reduces the need to handle polymorphic input and narrow down what the exact type should be infromEvent(). Additionally, this allows bundlers to more effectively tree-shake the module in case the other code is never used. The JSDoc on the function itself has also been improved with additional details for the consumer.Does this PR introduce a breaking change?
Yes, arrays of
FileSystemFileHandleare now handled in a dedicatedfromFileHandles()function. Users that were previously usingfromEvent()will now have to use this dedicated function instead.Other information
This also removes the notice that this feature is experimental, promoting
fromFileHandles()to a stable API in the next major.