Skip to content

Commit

Permalink
doc: add version when diagnostics_channel APIs were added
Browse files Browse the repository at this point in the history
Add a yaml section to document when diagnostics_channel APIs were
introduced.

PR-URL: #40208
Reviewed-By: Stephen Belanger <admin@stephenbelanger.com>
Reviewed-By: Tobias Nießen <tniessen@tnie.de>
Reviewed-By: James M Snell <jasnell@gmail.com>
Reviewed-By: Colin Ihrig <cjihrig@gmail.com>
  • Loading branch information
Flarna authored and targos committed Oct 4, 2021
1 parent 2fa5e50 commit a68f91c
Showing 1 changed file with 42 additions and 0 deletions.
42 changes: 42 additions & 0 deletions doc/api/diagnostics_channel.md
Original file line number Diff line number Diff line change
Expand Up @@ -79,6 +79,12 @@ if (channel.hasSubscribers) {

#### `diagnostics_channel.hasSubscribers(name)`

<!-- YAML
added:
- v15.1.0
- v14.17.0
-->

* `name` {string|symbol} The channel name
* Returns: {boolean} If there are active subscribers

Expand Down Expand Up @@ -106,6 +112,12 @@ if (diagnostics_channel.hasSubscribers('my-channel')) {

#### `diagnostics_channel.channel(name)`

<!-- YAML
added:
- v15.1.0
- v14.17.0
-->

* `name` {string|symbol} The channel name
* Returns: {Channel} The named channel object

Expand All @@ -127,6 +139,12 @@ const channel = diagnostics_channel.channel('my-channel');

### Class: `Channel`

<!-- YAML
added:
- v15.1.0
- v14.17.0
-->

The class `Channel` represents an individual named channel within the data
pipeline. It is use to track subscribers and to publish messages when there
are subscribers present. It exists as a separate object to avoid channel
Expand All @@ -137,6 +155,12 @@ with `new Channel(name)` is not supported.

#### `channel.hasSubscribers`

<!-- YAML
added:
- v15.1.0
- v14.17.0
-->

* Returns: {boolean} If there are active subscribers

Check if there are active subscribers to this channel. This is helpful if
Expand Down Expand Up @@ -167,6 +191,12 @@ if (channel.hasSubscribers) {

#### `channel.publish(message)`

<!-- YAML
added:
- v15.1.0
- v14.17.0
-->

* `message` {any} The message to send to the channel subscribers

Publish a message to any subscribers to the channel. This will trigger
Expand Down Expand Up @@ -194,6 +224,12 @@ channel.publish({

#### `channel.subscribe(onMessage)`

<!-- YAML
added:
- v15.1.0
- v14.17.0
-->

* `onMessage` {Function} The handler to receive channel messages
* `message` {any} The message data
* `name` {string|symbol} The name of the channel
Expand Down Expand Up @@ -224,6 +260,12 @@ channel.subscribe((message, name) => {

#### `channel.unsubscribe(onMessage)`

<!-- YAML
added:
- v15.1.0
- v14.17.0
-->

* `onMessage` {Function} The previous subscribed handler to remove

Remove a message handler previously registered to this channel with
Expand Down

0 comments on commit a68f91c

Please sign in to comment.