Skip to content

Commit

Permalink
Improve function documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
Borewit committed Jul 11, 2024
1 parent db0fbd2 commit 53d0112
Showing 1 changed file with 3 additions and 1 deletion.
4 changes: 3 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -183,7 +183,7 @@ import { inspect } from 'util';

#### parseStream function

_Only available for Node.js._
_Only available using a Node.js JavaScript engines._

Parses the provided audio stream for metadata.
The stream should be of type [Node.js Readable](https://nodejs.org/api/stream.html#class-streamreadable).
Expand Down Expand Up @@ -223,6 +223,8 @@ parseWebStream(stream: ReadableStream<Uint8Array>, fileInfo?: IFileInfo | string

#### parseBlob function

_This method can only be used if with a Node.js JavaScript engine._

Parse an audio file from a [Blob](https://developer.mozilla.org/en-US/docs/Web/API/Blob) or [File](https://developer.mozilla.org/en-US/docs/Web/API/File).

```js
Expand Down

0 comments on commit 53d0112

Please sign in to comment.