Skip to content

Navigation Menu

Sign in
Appearance settings

Search code, repositories, users, issues, pull requests...

Provide feedback

We read every piece of feedback, and take your input very seriously.

Saved searches

Use saved searches to filter your results more quickly

Appearance settings

Commit 683cd0f

Browse filesBrowse files
trivikrBridgeAR
authored andcommitted
doc,fs: add extends for derived classes
PR-URL: #29304 Reviewed-By: Luigi Pinca <luigipinca@gmail.com> Reviewed-By: James M Snell <jasnell@gmail.com>
1 parent 0820854 commit 683cd0f
Copy full SHA for 683cd0f

File tree

Expand file treeCollapse file tree

1 file changed

+9
-10
lines changed
Open diff view settings
Filter options
Expand file treeCollapse file tree

1 file changed

+9
-10
lines changed
Open diff view settings
Collapse file

‎doc/api/fs.md‎

Copy file name to clipboardExpand all lines: doc/api/fs.md
+9-10Lines changed: 9 additions & 10 deletions
  • Display the source diff
  • Display the rich diff
Original file line numberDiff line numberDiff line change
@@ -374,11 +374,13 @@ value is determined by the `options.encoding` passed to [`fs.readdir()`][] or
374374
added: v0.5.8
375375
-->
376376

377+
* Extends {EventEmitter}
378+
377379
A successful call to [`fs.watch()`][] method will return a new `fs.FSWatcher`
378380
object.
379381

380-
All `fs.FSWatcher` objects are [`EventEmitter`][]'s that will emit a `'change'`
381-
event whenever a specific watched file is modified.
382+
All `fs.FSWatcher` objects emit a `'change'` event whenever a specific watched
383+
file is modified.
382384

383385
### Event: 'change'
384386
<!-- YAML
@@ -437,11 +439,11 @@ Stop watching for changes on the given `fs.FSWatcher`. Once stopped, the
437439
added: v0.1.93
438440
-->
439441

442+
* Extends: {stream.Readable}
443+
440444
A successful call to `fs.createReadStream()` will return a new `fs.ReadStream`
441445
object.
442446

443-
All `fs.ReadStream` objects are [Readable Streams][].
444-
445447
### Event: 'close'
446448
<!-- YAML
447449
added: v0.1.93
@@ -860,7 +862,7 @@ of 0.12, `ctime` is not "creation time", and on Unix systems, it never was.
860862
added: v0.1.93
861863
-->
862864

863-
`WriteStream` is a [Writable Stream][].
865+
* Extends {stream.Writable}
864866

865867
### Event: 'close'
866868
<!-- YAML
@@ -1536,7 +1538,7 @@ changes:
15361538
* `start` {integer}
15371539
* `end` {integer} **Default:** `Infinity`
15381540
* `highWaterMark` {integer} **Default:** `64 * 1024`
1539-
* Returns: {fs.ReadStream} See [Readable Streams][].
1541+
* Returns: {fs.ReadStream}
15401542

15411543
Unlike the 16 kb default `highWaterMark` for a readable stream, the stream
15421544
returned by this method has a default `highWaterMark` of 64 kb.
@@ -1628,7 +1630,7 @@ changes:
16281630
* `autoClose` {boolean} **Default:** `true`
16291631
* `emitClose` {boolean} **Default:** `false`
16301632
* `start` {integer}
1631-
* Returns: {fs.WriteStream} See [Writable Stream][].
1633+
* Returns: {fs.WriteStream}
16321634

16331635
`options` may also include a `start` option to allow writing data at
16341636
some position past the beginning of the file, allowed values are in the
@@ -5210,7 +5212,6 @@ the file contents.
52105212
[`AHAFS`]: https://www.ibm.com/developerworks/aix/library/au-aix_event_infrastructure/
52115213
[`Buffer.byteLength`]: buffer.html#buffer_class_method_buffer_bytelength_string_encoding
52125214
[`Buffer`]: buffer.html#buffer_buffer
5213-
[`EventEmitter`]: events.html
52145215
[`FSEvents`]: https://developer.apple.com/documentation/coreservices/file_system_events
52155216
[`ReadDirectoryChangesW`]: https://docs.microsoft.com/en-us/windows/desktop/api/winbase/nf-winbase-readdirectorychangesw
52165217
[`ReadStream`]: #fs_class_fs_readstream
@@ -5264,8 +5265,6 @@ the file contents.
52645265
[MSDN-Rel-Path]: https://docs.microsoft.com/en-us/windows/desktop/FileIO/naming-a-file#fully-qualified-vs-relative-paths
52655266
[MSDN-Using-Streams]: https://docs.microsoft.com/en-us/windows/desktop/FileIO/using-streams
52665267
[Naming Files, Paths, and Namespaces]: https://docs.microsoft.com/en-us/windows/desktop/FileIO/naming-a-file
5267-
[Readable Streams]: stream.html#stream_class_stream_readable
5268-
[Writable Stream]: stream.html#stream_class_stream_writable
52695268
[chcp]: https://ss64.com/nt/chcp.html
52705269
[inode]: https://en.wikipedia.org/wiki/Inode
52715270
[support of file system `flags`]: #fs_file_system_flags

0 commit comments

Comments
0 (0)
Morty Proxy This is a proxified and sanitized view of the page, visit original site.