Thanks to visit codestin.com
Credit goes to github.com

Skip to content

Commit a1e9c3a

Browse files
chasetoncoaduh95
chasetonco
authored and
aduh95
committed
doc: add missing return types in fs.md
Three entries in the fs documentation described their return value only in prose, or not at all, so doc-kit could not parse a return type and fell back to `void`: * `filehandle[Symbol.asyncDispose]()` and `dir[Symbol.asyncDispose]()` both return a promise, matching the existing `Returns: {Promise}` annotations on other async dispose methods. * `new fs.Utf8Stream([options])` is a constructor and returns an instance of the class. Verified at runtime and by rendering the page locally with doc-kit. Refs: nodejs/doc-kit#953 Signed-off-by: Chxxeton <[email protected]> PR-URL: #65307 Reviewed-By: James M Snell <[email protected]> Reviewed-By: Luigi Pinca <[email protected]> Reviewed-By: Aviv Keller <[email protected]> Reviewed-By: Ulises Gascón <[email protected]>
1 parent 4533572 commit a1e9c3a

1 file changed

Lines changed: 4 additions & 0 deletions

File tree

‎doc/api/fs.md‎

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1184,6 +1184,8 @@ changes:
11841184
description: No longer experimental.
11851185
-->
11861186
1187+
* Returns: {Promise}
1188+
11871189
Calls `filehandle.close()` and returns a promise that fulfills when the
11881190
filehandle is closed.
11891191
@@ -7317,6 +7319,8 @@ changes:
73177319
description: No longer experimental.
73187320
-->
73197321
7322+
* Returns: {Promise}
7323+
73207324
Calls `dir.close()` if the directory handle is open, and returns a promise that
73217325
fulfills when disposal is complete.
73227326

0 commit comments

Comments
 (0)