diff options
author | Kamat, Trivikram <16024985+trivikr@users.noreply.github.com> | 2019-08-25 04:59:14 +0300 |
---|---|---|
committer | Ruben Bridgewater <ruben@bridgewater.de> | 2019-09-04 17:48:18 +0300 |
commit | 395245f1eb54ada2faeedaf8a94983e49683feb7 (patch) | |
tree | f6460691377216028bb73fa9c4852a2cf2c45e93 /doc/api | |
parent | a2c704773ac429125f197fabe74b792e4cfa9760 (diff) |
doc,fs: add extends for derived classes
PR-URL: https://github.com/nodejs/node/pull/29304
Reviewed-By: Luigi Pinca <luigipinca@gmail.com>
Reviewed-By: James M Snell <jasnell@gmail.com>
Diffstat (limited to 'doc/api')
-rw-r--r-- | doc/api/fs.md | 19 |
1 files changed, 9 insertions, 10 deletions
diff --git a/doc/api/fs.md b/doc/api/fs.md index 7e8266a90ec..1dc2c6841cc 100644 --- a/doc/api/fs.md +++ b/doc/api/fs.md @@ -374,11 +374,13 @@ value is determined by the `options.encoding` passed to [`fs.readdir()`][] or added: v0.5.8 --> +* Extends {EventEmitter} + A successful call to [`fs.watch()`][] method will return a new `fs.FSWatcher` object. -All `fs.FSWatcher` objects are [`EventEmitter`][]'s that will emit a `'change'` -event whenever a specific watched file is modified. +All `fs.FSWatcher` objects emit a `'change'` event whenever a specific watched +file is modified. ### Event: 'change' <!-- YAML @@ -437,11 +439,11 @@ Stop watching for changes on the given `fs.FSWatcher`. Once stopped, the added: v0.1.93 --> +* Extends: {stream.Readable} + A successful call to `fs.createReadStream()` will return a new `fs.ReadStream` object. -All `fs.ReadStream` objects are [Readable Streams][]. - ### Event: 'close' <!-- YAML 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 --> -`WriteStream` is a [Writable Stream][]. +* Extends {stream.Writable} ### Event: 'close' <!-- YAML @@ -1536,7 +1538,7 @@ changes: * `start` {integer} * `end` {integer} **Default:** `Infinity` * `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 returned by this method has a default `highWaterMark` of 64 kb. @@ -1628,7 +1630,7 @@ changes: * `autoClose` {boolean} **Default:** `true` * `emitClose` {boolean} **Default:** `false` * `start` {integer} -* Returns: {fs.WriteStream} See [Writable Stream][]. +* Returns: {fs.WriteStream} `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 @@ -5210,7 +5212,6 @@ the file contents. [`AHAFS`]: https://www.ibm.com/developerworks/aix/library/au-aix_event_infrastructure/ [`Buffer.byteLength`]: buffer.html#buffer_class_method_buffer_bytelength_string_encoding [`Buffer`]: buffer.html#buffer_buffer -[`EventEmitter`]: events.html [`FSEvents`]: https://developer.apple.com/documentation/coreservices/file_system_events [`ReadDirectoryChangesW`]: https://docs.microsoft.com/en-us/windows/desktop/api/winbase/nf-winbase-readdirectorychangesw [`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-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 -[Readable Streams]: stream.html#stream_class_stream_readable -[Writable Stream]: stream.html#stream_class_stream_writable [chcp]: https://ss64.com/nt/chcp.html [inode]: https://en.wikipedia.org/wiki/Inode [support of file system `flags`]: #fs_file_system_flags |