Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

doc,fs: add extends for derived classes #29304

Closed
wants to merge 2 commits into from
Closed

doc,fs: add extends for derived classes #29304

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
a599a1a
doc,fs: add extends for derived classes
trivikr Aug 25, 2019
59a5ef5
f remove `EventEmitter` link
trivikr Aug 25, 2019
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
19 changes: 9 additions & 10 deletions doc/api/fs.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down Expand Up @@ -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
Expand Down Expand Up @@ -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
Expand Down Expand Up @@ -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.
Expand Down Expand Up @@ -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
Expand Down Expand Up @@ -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
Expand Down Expand Up @@ -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
Expand Down