Repository navigation
Commit 205ef76
authored
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 <43923165+Chxxeton@users.noreply.github.com>
PR-URL: #65307
Reviewed-By: James M Snell <jasnell@gmail.com>
Reviewed-By: Luigi Pinca <luigipinca@gmail.com>
Reviewed-By: Aviv Keller <me@aviv.sh>
Reviewed-By: Ulises Gascón <ulisesgascongonzalez@gmail.com>1 parent ba8cdc2 commit 205ef76
1 file changed
Lines changed: 5 additions & 0 deletions
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
1191 | 1191 | | |
1192 | 1192 | | |
1193 | 1193 | | |
| 1194 | + | |
| 1195 | + | |
1194 | 1196 | | |
1195 | 1197 | | |
1196 | 1198 | | |
| |||
7351 | 7353 | | |
7352 | 7354 | | |
7353 | 7355 | | |
| 7356 | + | |
| 7357 | + | |
7354 | 7358 | | |
7355 | 7359 | | |
7356 | 7360 | | |
| |||
8416 | 8420 | | |
8417 | 8421 | | |
8418 | 8422 | | |
| 8423 | + | |
8419 | 8424 | | |
8420 | 8425 | | |
8421 | 8426 | | |
| |||
0 commit comments