Skip to content
Closed
Show file tree
Hide file tree
Changes from 1 commit
Commits
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
Next Next commit
doc: add extends for derived classes
  • Loading branch information
trivikr committed Aug 24, 2019
commit 288052693925bc75c687245da1c3e6c20b1d50a7
5 changes: 3 additions & 2 deletions doc/api/child_process.md
Original file line number Diff line number Diff line change
Expand Up @@ -894,8 +894,9 @@ arbitrary command execution.**
added: v2.2.0
-->

Instances of the `ChildProcess` class are [`EventEmitters`][`EventEmitter`] that
represent spawned child processes.
* Extends: {EventEmitter}

Instances of the `ChildProcess` represent spawned child processes.

Instances of `ChildProcess` are not intended to be created directly. Rather,
use the [`child_process.spawn()`][], [`child_process.exec()`][],
Expand Down
2 changes: 2 additions & 0 deletions doc/api/cluster.md
Original file line number Diff line number Diff line change
Expand Up @@ -116,6 +116,8 @@ also be used for other use cases requiring worker processes.
added: v0.7.0
-->

* Extends: {EventEmitter}

A `Worker` object contains all public information and method about a worker.
In the master it can be obtained using `cluster.workers`. In a worker
it can be obtained using `cluster.worker`.
Expand Down
6 changes: 3 additions & 3 deletions doc/api/dgram.md
Original file line number Diff line number Diff line change
Expand Up @@ -35,8 +35,9 @@ server.bind(41234);
added: v0.1.99
-->

The `dgram.Socket` object is an [`EventEmitter`][] that encapsulates the
datagram functionality.
* Extends: {EventEmitter}

Encapsulates the datagram functionality.
Comment thread
trivikr marked this conversation as resolved.
Resolved

New instances of `dgram.Socket` are created using [`dgram.createSocket()`][].
The `new` keyword is not to be used to create `dgram.Socket` instances.
Expand Down Expand Up @@ -719,7 +720,6 @@ and `udp6` sockets). The bound address and port can be retrieved using
[`Error`]: errors.html#errors_class_error
[`ERR_SOCKET_DGRAM_IS_CONNECTED`]: errors.html#errors_err_socket_dgram_is_connected
[`ERR_SOCKET_DGRAM_NOT_CONNECTED`]: errors.html#errors_err_socket_dgram_not_connected
[`EventEmitter`]: events.html
[`System Error`]: errors.html#errors_class_systemerror
[`close()`]: #dgram_socket_close_callback
[`cluster`]: cluster.html
Expand Down
5 changes: 3 additions & 2 deletions doc/api/domain.md
Original file line number Diff line number Diff line change
Expand Up @@ -273,11 +273,12 @@ serverDomain.run(() => {

## Class: Domain

* Extends: {EventEmitter}

The `Domain` class encapsulates the functionality of routing errors and
uncaught exceptions to the active `Domain` object.

`Domain` is a child class of [`EventEmitter`][]. To handle the errors that it
catches, listen to its `'error'` event.
To handle the errors that it catches, listen to its `'error'` event.

### domain.members

Expand Down
4 changes: 2 additions & 2 deletions doc/api/inspector.md
Original file line number Diff line number Diff line change
Expand Up @@ -64,6 +64,8 @@ An exception will be thrown if there is no active inspector.

## Class: inspector.Session

* Extends: {EventEmitter}

The `inspector.Session` is used for dispatching messages to the V8 inspector
back-end and receiving message responses and notifications.

Expand All @@ -76,8 +78,6 @@ Create a new instance of the `inspector.Session` class. The inspector session
needs to be connected through [`session.connect()`][] before the messages
can be dispatched to the inspector backend.

`inspector.Session` is an [`EventEmitter`][] with the following events:

### Event: 'inspectorNotification'
<!-- YAML
added: v8.0.0
Expand Down
4 changes: 4 additions & 0 deletions doc/api/net.md
Original file line number Diff line number Diff line change
Expand Up @@ -60,6 +60,8 @@ net.createServer().listen(
added: v0.1.90
-->

* Extends: {EventEmitter}

This class is used to create a TCP or [IPC][] server.

### new net.Server([options][, connectionListener])
Expand Down Expand Up @@ -384,6 +386,8 @@ active server in the event system. If the server is already `unref`ed calling
added: v0.3.4
-->

* Extends: {stream.Duplex}
Comment thread
trivikr marked this conversation as resolved.
Resolved

This class is an abstraction of a TCP socket or a streaming [IPC][] endpoint
(uses named pipes on Windows, and Unix domain sockets otherwise). A
`net.Socket` is also a [duplex stream][], so it can be both readable and
Expand Down
2 changes: 2 additions & 0 deletions doc/api/readline.md
Original file line number Diff line number Diff line change
Expand Up @@ -38,6 +38,8 @@ received on the `input` stream.
added: v0.1.104
-->

* Extends: {EventEmitter}

Instances of the `readline.Interface` class are constructed using the
`readline.createInterface()` method. Every instance is associated with a
single `input` [Readable][] stream and a single `output` [Writable][] stream.
Expand Down
3 changes: 2 additions & 1 deletion doc/api/repl.md
Original file line number Diff line number Diff line change
Expand Up @@ -333,7 +333,8 @@ function myWriter(output) {
added: v0.1.91
-->

The `repl.REPLServer` class inherits from the [`readline.Interface`][] class.
* Extends: {readline.Interface}

Instances of `repl.REPLServer` are created using the `repl.start()` method and
*should not* be created directly using the JavaScript `new` keyword.

Expand Down
19 changes: 11 additions & 8 deletions doc/api/tty.md
Original file line number Diff line number Diff line change
Expand Up @@ -35,10 +35,11 @@ classes.
added: v0.5.8
-->

The `tty.ReadStream` class is a subclass of [`net.Socket`][] that represents the
readable side of a TTY. In normal circumstances [`process.stdin`][] will be the
only `tty.ReadStream` instance in a Node.js process and there should be no
reason to create additional instances.
* Extends: {net.Socket}

Represents the readable side of a TTY. In normal circumstances
[`process.stdin`][] will be the only `tty.ReadStream` instance in a Node.js
process and there should be no reason to create additional instances.

### readStream.isRaw
<!-- YAML
Expand Down Expand Up @@ -78,10 +79,12 @@ terminal is disabled, including echoing input characters.
added: v0.5.8
-->

The `tty.WriteStream` class is a subclass of [`net.Socket`][] that represents
the writable side of a TTY. In normal circumstances, [`process.stdout`][] and
[`process.stderr`][] will be the only `tty.WriteStream` instances created for a
Node.js process and there should be no reason to create additional instances.
* Extends: {net.Socket}

Represents the writable side of a TTY. In normal circumstances,
[`process.stdout`][] and [`process.stderr`][] will be the only
`tty.WriteStream` instances created for a Node.js process and there
should be no reason to create additional instances.

### Event: 'resize'
<!-- YAML
Expand Down