From 032107a6fe8eb37cf6ac8d8a2561977fdd848e18 Mon Sep 17 00:00:00 2001 From: Deokjin Kim Date: Tue, 15 Aug 2023 07:40:02 +0900 Subject: [PATCH] doc: fix `Type` notation in webstreams Replace `type` with `Type: {Promise}`. Plus, fix incorrect verb(`creates` -> `returns`) in description. PR-URL: https://github.com/nodejs/node/pull/49121 Reviewed-By: Luigi Pinca Reviewed-By: Chemi Atlow --- doc/api/webstreams.md | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/doc/api/webstreams.md b/doc/api/webstreams.md index bb3374e1480e73..3f1fdc3c1bd558 100644 --- a/doc/api/webstreams.md +++ b/doc/api/webstreams.md @@ -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` @@ -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()`