docs: Use 'close' event instead of 'finish' in examples#350
Open
XueHua-s wants to merge 1 commit intoZJONSSON:masterfrom
Open
docs: Use 'close' event instead of 'finish' in examples#350XueHua-s wants to merge 1 commit intoZJONSSON:masterfrom
XueHua-s wants to merge 1 commit intoZJONSSON:masterfrom
Conversation
Using the 'finish' event can be misleading as it only indicates that the source stream has ended, not that the data has been fully written to the destination. The 'close' event should be used to guarantee that the file has been completely written to disk.
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
1 participant
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.
This PR updates the getting-started documentation in the README.
Using the 'finish' event can be misleading as it only indicates that the source stream has ended, not that the data has been fully written to the destination. This is a common pitfall for new users of the library.
The 'close' event should be used to guarantee that the file has been completely written to disk.
This change updates the examples in the README to use the correct 'close' event, making the documentation more accurate and preventing potential issues for users.