1berry/nodejs
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

doc,fs: add extends for derived classes

Browse Source 
PR-URL: https://github.com/nodejs/node/pull/29304
Reviewed-By: Luigi Pinca <luigipinca@gmail.com>
Reviewed-By: James M Snell <jasnell@gmail.com>
This commit is contained in:
Kamat, Trivikram 2019-08-24 18:59:14 -07:00
parent 5c9209bc4d
commit fd964de1b7
1 changed files with 9 additions and 10 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

19
doc/api/fs.md
View File

@ -374,11 +374,13 @@ value is determined by the `options.encoding` passed to [`fs.readdir()`][] or
added: v0.5.8 added: v0.5.8
--> -->
* Extends {EventEmitter}
A successful call to [`fs.watch()`][] method will return a new `fs.FSWatcher` A successful call to [`fs.watch()`][] method will return a new `fs.FSWatcher`
object. object.
All `fs.FSWatcher` objects are [`EventEmitter`][]'s that will emit a `'change'` All `fs.FSWatcher` objects emit a `'change'` event whenever a specific watched
event whenever a specific watched file is modified. file is modified.
### Event: 'change' ### Event: 'change'
<!-- YAML <!-- YAML
@ -437,11 +439,11 @@ Stop watching for changes on the given `fs.FSWatcher`. Once stopped, the
added: v0.1.93 added: v0.1.93
--> -->
* Extends: {stream.Readable}
A successful call to `fs.createReadStream()` will return a new `fs.ReadStream` A successful call to `fs.createReadStream()` will return a new `fs.ReadStream`
object. object.
All `fs.ReadStream` objects are [Readable Streams][].
### Event: 'close' ### Event: 'close'
<!-- YAML <!-- YAML
added: v0.1.93 added: v0.1.93
@ -860,7 +862,7 @@ of 0.12, `ctime` is not "creation time", and on Unix systems, it never was.
added: v0.1.93 added: v0.1.93
--> -->
`WriteStream` is a [Writable Stream][]. * Extends {stream.Writable}
### Event: 'close' ### Event: 'close'
<!-- YAML <!-- YAML
@ -1536,7 +1538,7 @@ changes:
* `start` {integer} * `start` {integer}
* `end` {integer} **Default:** `Infinity` * `end` {integer} **Default:** `Infinity`
* `highWaterMark` {integer} **Default:** `64 * 1024` * `highWaterMark` {integer} **Default:** `64 * 1024`
* Returns: {fs.ReadStream} See [Readable Streams][]. * Returns: {fs.ReadStream}
Unlike the 16 kb default `highWaterMark` for a readable stream, the stream Unlike the 16 kb default `highWaterMark` for a readable stream, the stream
returned by this method has a default `highWaterMark` of 64 kb. returned by this method has a default `highWaterMark` of 64 kb.
@ -1628,7 +1630,7 @@ changes:
* `autoClose` {boolean} **Default:** `true` * `autoClose` {boolean} **Default:** `true`
* `emitClose` {boolean} **Default:** `false` * `emitClose` {boolean} **Default:** `false`
* `start` {integer} * `start` {integer}
* Returns: {fs.WriteStream} See [Writable Stream][]. * Returns: {fs.WriteStream}
`options` may also include a `start` option to allow writing data at `options` may also include a `start` option to allow writing data at
some position past the beginning of the file, allowed values are in the some position past the beginning of the file, allowed values are in the
@ -5210,7 +5212,6 @@ the file contents.
[`AHAFS`]: https://www.ibm.com/developerworks/aix/library/au-aix_event_infrastructure/ [`AHAFS`]: https://www.ibm.com/developerworks/aix/library/au-aix_event_infrastructure/
[`Buffer.byteLength`]: buffer.html#buffer_class_method_buffer_bytelength_string_encoding [`Buffer.byteLength`]: buffer.html#buffer_class_method_buffer_bytelength_string_encoding
[`Buffer`]: buffer.html#buffer_buffer [`Buffer`]: buffer.html#buffer_buffer
[`EventEmitter`]: events.html
[`FSEvents`]: https://developer.apple.com/documentation/coreservices/file_system_events [`FSEvents`]: https://developer.apple.com/documentation/coreservices/file_system_events
[`ReadDirectoryChangesW`]: https://docs.microsoft.com/en-us/windows/desktop/api/winbase/nf-winbase-readdirectorychangesw [`ReadDirectoryChangesW`]: https://docs.microsoft.com/en-us/windows/desktop/api/winbase/nf-winbase-readdirectorychangesw
[`ReadStream`]: #fs_class_fs_readstream [`ReadStream`]: #fs_class_fs_readstream
@ -5264,8 +5265,6 @@ the file contents.
[MSDN-Rel-Path]: https://docs.microsoft.com/en-us/windows/desktop/FileIO/naming-a-file#fully-qualified-vs-relative-paths [MSDN-Rel-Path]: https://docs.microsoft.com/en-us/windows/desktop/FileIO/naming-a-file#fully-qualified-vs-relative-paths
[MSDN-Using-Streams]: https://docs.microsoft.com/en-us/windows/desktop/FileIO/using-streams [MSDN-Using-Streams]: https://docs.microsoft.com/en-us/windows/desktop/FileIO/using-streams
[Naming Files, Paths, and Namespaces]: https://docs.microsoft.com/en-us/windows/desktop/FileIO/naming-a-file [Naming Files, Paths, and Namespaces]: https://docs.microsoft.com/en-us/windows/desktop/FileIO/naming-a-file
[Readable Streams]: stream.html#stream_class_stream_readable
[Writable Stream]: stream.html#stream_class_stream_writable
[chcp]: https://ss64.com/nt/chcp.html [chcp]: https://ss64.com/nt/chcp.html
[inode]: https://en.wikipedia.org/wiki/Inode [inode]: https://en.wikipedia.org/wiki/Inode
[support of file system `flags`]: #fs_file_system_flags [support of file system `flags`]: #fs_file_system_flags