Skip to content

Navigation Menu

Sign in
Appearance settings

Search code, repositories, users, issues, pull requests...

Provide feedback

We read every piece of feedback, and take your input very seriously.

Saved searches

Use saved searches to filter your results more quickly

Appearance settings

Commit 8c8c97d

Browse filesBrowse files
Stephen Belangerdanielleadams
authored andcommitted
doc: deprecate diagnostics_channel object subscribe method
PR-URL: #42714 Reviewed-By: James M Snell <jasnell@gmail.com> Reviewed-By: Chengzhong Wu <legendecas@gmail.com> Reviewed-By: Gerhard Stöbich <deb2001-github@yahoo.de> Reviewed-By: Rafael Gonzaga <rafael.nunu@hotmail.com> Reviewed-By: Vladimir de Turckheim <vlad2t@hotmail.com>
1 parent 324473c commit 8c8c97d
Copy full SHA for 8c8c97d

File tree

Expand file treeCollapse file tree

2 files changed

+28
-1
lines changed
Open diff view settings
Filter options
Expand file treeCollapse file tree

2 files changed

+28
-1
lines changed
Open diff view settings
Collapse file

‎doc/api/deprecations.md‎

Copy file name to clipboardExpand all lines: doc/api/deprecations.md
+20Lines changed: 20 additions & 0 deletions
  • Display the source diff
  • Display the rich diff
Original file line numberDiff line numberDiff line change
@@ -3137,6 +3137,24 @@ parameter in [`fs.write()`][], [`fs.writeFile()`][], [`fs.appendFile()`][],
31373137
[`fs.writeFileSync()`][], and [`fs.appendFileSync()`][] is deprecated.
31383138
Convert them to primitive strings.
31393139

3140+
### DEP0163: `channel.subscribe(onMessage)`, `channel.unsubscribe(onMessage)`
3141+
3142+
<!-- YAML
3143+
changes:
3144+
- version: REPLACEME
3145+
pr-url: https://github.com/nodejs/node/pull/42714
3146+
description: Documentation-only deprecation.
3147+
-->
3148+
3149+
Type: Documentation-only
3150+
3151+
These methods were deprecated because they can be used in a way which does not
3152+
hold the channel reference alive long enough to receive the events.
3153+
3154+
Use [`diagnostics_channel.subscribe(name, onMessage)`][] or
3155+
[`diagnostics_channel.unsubscribe(name, onMessage)`][] which does the same
3156+
thing instead.
3157+
31403158
[Legacy URL API]: url.md#legacy-url-api
31413159
[NIST SP 800-38D]: https://nvlpubs.nist.gov/nistpubs/Legacy/SP/nistspecialpublication800-38d.pdf
31423160
[RFC 6066]: https://tools.ietf.org/html/rfc6066#section-3
@@ -3177,6 +3195,8 @@ Convert them to primitive strings.
31773195
[`crypto.scrypt()`]: crypto.md#cryptoscryptpassword-salt-keylen-options-callback
31783196
[`decipher.final()`]: crypto.md#decipherfinaloutputencoding
31793197
[`decipher.setAuthTag()`]: crypto.md#deciphersetauthtagbuffer-encoding
3198+
[`diagnostics_channel.subscribe(name, onMessage)`]: diagnostics_channel.md#diagnostics_channelsubscribename-onmessage
3199+
[`diagnostics_channel.unsubscribe(name, onMessage)`]: diagnostics_channel.md#diagnostics_channelunsubscribename-onmessage
31803200
[`dns.lookup()`]: dns.md#dnslookuphostname-options-callback
31813201
[`dnsPromises.lookup()`]: dns.md#dnspromiseslookuphostname-options
31823202
[`domain`]: domain.md
Collapse file

‎doc/api/diagnostics_channel.md‎

Copy file name to clipboardExpand all lines: doc/api/diagnostics_channel.md
+8-1Lines changed: 8 additions & 1 deletion
  • Display the source diff
  • Display the rich diff
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

@@ -424,5 +430,6 @@ Emitted when server sends a response.
424430

425431
[`'uncaughtException'`]: process.md#event-uncaughtexception
426432
[`channel.subscribe(onMessage)`]: #channelsubscribeonmessage
427-
[`diagnostics_channel.subscribe(name, onMessage)`]: #diagnostics_channelunsubscribename_onmessage
428433
[`diagnostics_channel.channel(name)`]: #diagnostics_channelchannelname
434+
[`diagnostics_channel.subscribe(name, onMessage)`]: #diagnostics_channelsubscribename-onmessage
435+
[`diagnostics_channel.unsubscribe(name, onMessage)`]: #diagnostics_channelunsubscribename-onmessage

0 commit comments

Comments
0 (0)
Morty Proxy This is a proxified and sanitized view of the page, visit original site.