Skip to content

Commit bff5d5b

Browse files
committed
tools: add FileHandle to doc/type-parser.js
PR-URL: #18601 Refs: #18407 Refs: #18444 Reviewed-By: Anatoli Papirovski <apapirovski@mac.com> Reviewed-By: Luigi Pinca <luigipinca@gmail.com> Reviewed-By: Ruben Bridgewater <ruben@bridgewater.de> Reviewed-By: Colin Ihrig <cjihrig@gmail.com>
1 parent ee67dd0 commit bff5d5b

File tree

2 files changed

+13
-13
lines changed

2 files changed

+13
-13
lines changed

doc/api/fs.md

Lines changed: 12 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -3548,7 +3548,7 @@ the error raised if the file is not accessible.
35483548
added: REPLACEME
35493549
-->
35503550

3551-
* `file` {string|Buffer|URL|[FileHandle][]} filename or `FileHandle`
3551+
* `file` {string|Buffer|URL|FileHandle} filename or `FileHandle`
35523552
* `data` {string|Buffer}
35533553
* `options` {Object|string}
35543554
* `encoding` {string|null} **Default:** `'utf8'`
@@ -3640,7 +3640,7 @@ fs.promises.copyFile('source.txt', 'destination.txt', COPYFILE_EXCL)
36403640
added: REPLACEME
36413641
-->
36423642

3643-
* `filehandle` {[FileHandle][]}
3643+
* `filehandle` {FileHandle}
36443644
* `mode` {integer}
36453645
* Returns: {Promise}
36463646

@@ -3652,7 +3652,7 @@ success.
36523652
added: REPLACEME
36533653
-->
36543654

3655-
* `filehandle` {[FileHandle][]}
3655+
* `filehandle` {FileHandle}
36563656
* `uid` {integer}
36573657
* `gid` {integer}
36583658
* Returns: {Promise}
@@ -3665,7 +3665,7 @@ the `Promise` with no arguments upon success.
36653665
added: REPLACEME
36663666
-->
36673667

3668-
* `filehandle` {[FileHandle][]}
3668+
* `filehandle` {FileHandle}
36693669
* Returns: {Promise}
36703670

36713671
Asynchronous fdatasync(2). The `Promise` is resolved with no arguments upon
@@ -3676,7 +3676,7 @@ success.
36763676
added: REPLACEME
36773677
-->
36783678

3679-
* `filehandle` {[FileHandle][]}
3679+
* `filehandle` {FileHandle}
36803680
* Returns: {Promise}
36813681

36823682
Retrieves the [`fs.Stats`][] for the given `filehandle`.
@@ -3686,7 +3686,7 @@ Retrieves the [`fs.Stats`][] for the given `filehandle`.
36863686
added: REPLACEME
36873687
-->
36883688

3689-
* `filehandle` {[FileHandle][]}
3689+
* `filehandle` {FileHandle}
36903690
* Returns: {Promise}
36913691

36923692
Asynchronous fsync(2). The `Promise` is resolved with no arguments upon
@@ -3697,7 +3697,7 @@ success.
36973697
added: REPLACEME
36983698
-->
36993699

3700-
* `filehandle` {[FileHandle][]}
3700+
* `filehandle` {FileHandle}
37013701
* `len` {integer} **Default:** `0`
37023702
* Returns: {Promise}
37033703

@@ -3746,7 +3746,7 @@ The last three bytes are null bytes ('\0'), to compensate the over-truncation.
37463746
added: REPLACEME
37473747
-->
37483748

3749-
* `filehandle` {[FileHandle][]}
3749+
* `filehandle` {FileHandle}
37503750
* `atime` {number|string|Date}
37513751
* `mtime` {number|string|Date}`
37523752
* Returns: {Promise}
@@ -3934,7 +3934,7 @@ files can be opened for writing with the `r+` flag. A call to
39343934
added: REPLACEME
39353935
-->
39363936

3937-
* `filehandle` {[FileHandle][]}
3937+
* `filehandle` {FileHandle}
39383938
* `buffer` {Buffer|Uint8Array}
39393939
* `offset` {integer}
39403940
* `length` {integer}
@@ -3981,7 +3981,7 @@ will be passed as `Buffer` objects.
39813981
added: REPLACEME
39823982
-->
39833983

3984-
* `path` {string|Buffer|URL|[FileHandle][]} filename or `FileHandle`
3984+
* `path` {string|Buffer|URL|FileHandle} filename or `FileHandle`
39853985
* `options` {Object|string}
39863986
* `encoding` {string|null} **Default:** `null`
39873987
* `flag` {string} **Default:** `'r'`
@@ -4147,7 +4147,7 @@ The `atime` and `mtime` arguments follow these rules:
41474147
added: REPLACEME
41484148
-->
41494149

4150-
* `filehandle` {[FileHandle][]}
4150+
* `filehandle` {FileHandle}
41514151
* `buffer` {Buffer|Uint8Array}
41524152
* `offset` {integer}
41534153
* `length` {integer}
@@ -4180,7 +4180,7 @@ the end of the file.
41804180
added: REPLACEME
41814181
-->
41824182

4183-
* `file` {string|Buffer|URL|[FileHandle][]} filename or `FileHandle`
4183+
* `file` {string|Buffer|URL|FileHandle} filename or `FileHandle`
41844184
* `data` {string|Buffer|Uint8Array}
41854185
* `options` {Object|string}
41864186
* `encoding` {string|null} **Default:** `'utf8'`
@@ -4469,7 +4469,6 @@ The following constants are meant for use with the [`fs.Stats`][] object's
44694469
[`util.promisify()`]: util.html#util_util_promisify_original
44704470
[Caveats]: #fs_caveats
44714471
[Common System Errors]: errors.html#errors_common_system_errors
4472-
[FileHandle]: #fs_class_filehandle
44734472
[FS Constants]: #fs_fs_constants_1
44744473
[MDN-Date]: https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Date
44754474
[MDN-Number]: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Data_structures#Number_type

tools/doc/type-parser.js

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -45,6 +45,7 @@ const typeMap = {
4545

4646
'EventEmitter': 'events.html#events_class_eventemitter',
4747

48+
'FileHandle': 'fs.html#fs_class_filehandle',
4849
'fs.Stats': 'fs.html#fs_class_fs_stats',
4950

5051
'http.Agent': 'http.html#http_class_http_agent',

0 commit comments

Comments
 (0)