Add path to onProgress event #155
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
requested changes
Aug 30, 2023
readme.md
Outdated
| } | ||
| ``` | ||
|
|
||
| - `percent` is a value between `0` and `1` | ||
| - `path` will not be present if no files were deleted |
There was a problem hiding this comment.
This is missing in the TS doc comment.
There was a problem hiding this comment.
And it should describe what it is, like in the TS docs. They should be in sync.
There was a problem hiding this comment.
Fixed in a8b391e
index.d.ts
Outdated
| @@ -15,6 +15,11 @@ export interface ProgressData { | |||
| Completed percentage. A value between `0` and `1`. | |||
| */ | |||
| readonly percent: number; | |||
|
|
|||
| /** | |||
| Path of deleted file | |||
There was a problem hiding this comment.
From onProgress docs:
Called after each file or directory is deleted.
So it could be a directory too.
It would also be useful to make it clear it's an "absolute path".
There was a problem hiding this comment.
Fixed in a8b391e
|
PR feedback has been addressed, and builds are passing. This is ready for re-review. |
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 the path of the deleted file to the
onProgressevent. Fixes #154