Improve Blob, file, and stream method documentation #641
+43
−10
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
Borewit
force-pushed
the
improve-blob-and-stream-documentation
branch
from
47fe441 to
2f738a8
Compare
sindresorhus
requested changes
Jul 10, 2024
readme.md
Outdated
| @@ -147,7 +150,9 @@ The file path to parse. | |||
|
|
|||
| ### fileTypeFromStream(stream) | |||
|
|
|||
| Detect the file type of a [Node.js readable stream](https://nodejs.org/api/stream.html#stream_class_stream_readable) or a [Web API ReadableStream](https://developer.mozilla.org/en-US/docs/Web/API/ReadableStream). | |||
| Detect the file type of a [Web API ReadableStream](https://developer.mozilla.org/en-US/docs/Web/API/ReadableStream). | |||
There was a problem hiding this comment.
Suggested change
| Detect the file type of a [Web API ReadableStream](https://developer.mozilla.org/en-US/docs/Web/API/ReadableStream). | |
| Detect the file type of a [Web `ReadableStream`](https://developer.mozilla.org/en-US/docs/Web/API/ReadableStream). |
|
You also need to update the doc comments in the types. |
|
Some of my suggested changes were not applied. It would have been better to simply commit the changes directly (they are diff suggestions, so you could have just pressed "commit suggestion"). |
|
There are still missed things, like #641 (comment) |
Mapped updated documentation to typings, and added some missing documentation Explained difference, and when to use `NodeFileTypeParser` instead of the `FileTypeParser` class
Co-authored-by: Sindre Sorhus <[email protected]>
Co-authored-by: Sindre Sorhus <[email protected]>
Borewit
force-pushed
the
improve-blob-and-stream-documentation
branch
from
35bc2bc to
7b4969b
Compare
sindresorhus
requested changes
Jul 16, 2024
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.
Improve documentation of:
fileTypeFromFile(filePath): explain this method can only be used if the JavaScript engine is Node.jsfileTypeFromStream(stream)explain that Node.js stream is only available when used with Node.jsfileTypeFromBlob(blob)explain that this is the method to used for web API FileResolves #640