From bc060bab5d8181e76af4b06cb9338883dba7a9ca Mon Sep 17 00:00:00 2001 From: Sergey Chernyshev Date: Thu, 25 Apr 2024 04:20:22 +0200 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 --- graal-nodejs/doc/api/webstreams.md | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/graal-nodejs/doc/api/webstreams.md b/graal-nodejs/doc/api/webstreams.md index e557a29b201..4d487d9d05d 100644 --- a/graal-nodejs/doc/api/webstreams.md +++ b/graal-nodejs/doc/api/webstreams.md @@ -850,7 +850,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` @@ -950,8 +950,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()`