Skip to content

Commit 6034638

Browse files
author
Stephen Belanger
committed
doc: deprecate diagnostics_channel object subscribe method
1 parent de5896b commit 6034638

File tree

1 file changed

+8
-1
lines changed

1 file changed

+8
-1
lines changed

doc/api/diagnostics_channel.md

Lines changed: 8 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -308,8 +308,11 @@ channel.publish({
308308
added:
309309
- v15.1.0
310310
- v14.17.0
311+
deprecated: REPLACEME
311312
-->
312313

314+
> Stability: 0 - Deprecated: Use [`diagnostics_channel.subscribe(name, onMessage)`][]
315+
313316
* `onMessage` {Function} The handler to receive channel messages
314317
* `message` {any} The message data
315318
* `name` {string|symbol} The name of the channel
@@ -344,6 +347,7 @@ channel.subscribe((message, name) => {
344347
added:
345348
- v15.1.0
346349
- v14.17.0
350+
deprecated: REPLACEME
347351
changes:
348352
- version:
349353
- v17.1.0
@@ -353,6 +357,8 @@ changes:
353357
description: Added return value. Added to channels without subscribers.
354358
-->
355359

360+
> Stability: 0 - Deprecated: Use [`diagnostics_channel.unsubscribe(name, onMessage)`][]
361+
356362
* `onMessage` {Function} The previous subscribed handler to remove
357363
* Returns: {boolean} `true` if the handler was found, `false` otherwise.
358364

@@ -389,5 +395,6 @@ channel.unsubscribe(onMessage);
389395

390396
[`'uncaughtException'`]: process.md#event-uncaughtexception
391397
[`channel.subscribe(onMessage)`]: #channelsubscribeonmessage
392-
[`diagnostics_channel.subscribe(name, onMessage)`]: #diagnostics_channelunsubscribename_onmessage
393398
[`diagnostics_channel.channel(name)`]: #diagnostics_channelchannelname
399+
[`diagnostics_channel.subscribe(name, onMessage)`]: #diagnostics_channelsubscribename-onmessage
400+
[`diagnostics_channel.unsubscribe(name, onMessage)`]: #diagnostics_channelunsubscribename-onmessage

0 commit comments

Comments
 (0)