Improve Blob, file, and stream method documentation

sindresorhus / file-type

Detect the file type of a file, stream, or data

MIT License

3.64k stars 345 forks source link

Improve Blob, file, and stream method documentation #641

Closed Borewit closed 1 month ago

Borewit commented 1 month ago

Improve documentation of:

fileTypeFromFile(filePath): explain this method can only be used if the JavaScript engine is Node.js
fileTypeFromStream(stream) explain that Node.js stream is only available when used with Node.js
fileTypeFromBlob(blob) explain that this is the method to used for web API File

Resolves #640

sindresorhus commented 1 month ago

You also need to update the doc comments in the types.

sindresorhus commented 1 month ago

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").

sindresorhus commented 1 month ago

There are still missed things, like https://github.com/sindresorhus/file-type/pull/641#discussion_r1673134960