Skip to content

Commit

Permalink
doc: fix Type notation in webstreams
Browse files Browse the repository at this point in the history
Replace `type` with `Type: {Promise}`. Plus, fix incorrect
verb(`creates` -> `returns`) in description.

PR-URL: nodejs#49121
Reviewed-By: Luigi Pinca <luigipinca@gmail.com>
Reviewed-By: Chemi Atlow <chemi@atlow.co.il>
  • Loading branch information
deokjinkim authored and rluvaton committed Aug 15, 2023
1 parent 3a8b57b commit 5c9f5e1
Showing 1 changed file with 3 additions and 3 deletions.
6 changes: 3 additions & 3 deletions doc/api/webstreams.md
Original file line number Diff line number Diff line change
Expand Up @@ -895,7 +895,7 @@ added: v16.5.0
* Returns: {WritableStreamDefaultWriter}
Creates and creates a new writer instance that can be used to write
Creates and returns a new writer instance that can be used to write
data into the `WritableStream`.
#### `writableStream.locked`
Expand Down Expand Up @@ -995,8 +995,8 @@ The amount of data required to fill the {WritableStream}'s queue.
added: v16.5.0
-->
* type: A promise that is fulfilled with `undefined` when the
writer is ready to be used.
* Type: {Promise} Fulfilled with `undefined` when the writer is ready
to be used.
#### `writableStreamDefaultWriter.releaseLock()`
Expand Down

0 comments on commit 5c9f5e1

Please sign in to comment.