GeezerVison

The World Wide Web, restored to 800 pixels of glory.

GeezerVison is showing github.com — doc: deprecate diagnostics_channel object subscribe method · nodejs/node@4884f18

File tree

Expand file treeCollapse file tree

Open diff view settings

Filter options

doc/api
- deprecations.md
- diagnostics_channel.md

Expand file treeCollapse file tree

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 number	Diff line number	Diff line change
@@ -3102,6 +3102,24 @@ parameter in [`fs.write()`][], [`fs.writeFile()`][], [`fs.appendFile()`][],
`3102`	`3102`	[`fs.writeFileSync()`][], and [`fs.appendFileSync()`][] is deprecated.
`3103`	`3103`	`Convert them to primitive strings.`
`3104`	`3104`
	`3105`	+### DEP0163: `channel.subscribe(onMessage)`, `channel.unsubscribe(onMessage)`
	`3106`	`+`
	`3107`	`+<!-- YAML`
	`3108`	`+changes:`
	`3109`	`+ - version: REPLACEME`
	`3110`	`+ pr-url: https://github.com/nodejs/node/pull/42714`
	`3111`	`+ description: Documentation-only deprecation.`
	`3112`	`+-->`
	`3113`	`+`
	`3114`	`+Type: Documentation-only`
	`3115`	`+`
	`3116`	`+These methods were deprecated because they can be used in a way which does not`
	`3117`	`+hold the channel reference alive long enough to receive the events.`
	`3118`	`+`
	`3119`	+Use [`diagnostics_channel.subscribe(name, onMessage)`][] or
	`3120`	+[`diagnostics_channel.unsubscribe(name, onMessage)`][] which does the same
	`3121`	`+thing instead.`
	`3122`	`+`
`3105`	`3123`	`[Legacy URL API]: url.md#legacy-url-api`
`3106`	`3124`	`[NIST SP 800-38D]: https://nvlpubs.nist.gov/nistpubs/Legacy/SP/nistspecialpublication800-38d.pdf`
`3107`	`3125`	`[RFC 6066]: https://tools.ietf.org/html/rfc6066#section-3`
`@@ -3142,6 +3160,8 @@ Convert them to primitive strings.`
`3142`	`3160`	[`crypto.scrypt()`]: crypto.md#cryptoscryptpassword-salt-keylen-options-callback
`3143`	`3161`	[`decipher.final()`]: crypto.md#decipherfinaloutputencoding
`3144`	`3162`	[`decipher.setAuthTag()`]: crypto.md#deciphersetauthtagbuffer-encoding
	`3163`	+[`diagnostics_channel.subscribe(name, onMessage)`]: diagnostics_channel.md#diagnostics_channelsubscribename-onmessage
	`3164`	+[`diagnostics_channel.unsubscribe(name, onMessage)`]: diagnostics_channel.md#diagnostics_channelunsubscribename-onmessage
`3145`	`3165`	[`dns.lookup()`]: dns.md#dnslookuphostname-options-callback
`3146`	`3166`	[`dnsPromises.lookup()`]: dns.md#dnspromiseslookuphostname-options
`3147`	`3167`	[`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 number	Diff line number	Diff line change
`@@ -308,8 +308,11 @@ channel.publish({`
`308`	`308`	`added:`
`309`	`309`	`- v15.1.0`
`310`	`310`	`- v14.17.0`
	`311`	`+deprecated: REPLACEME`
`311`	`312`	`-->`
`312`	`313`
	`314`	+> Stability: 0 - Deprecated: Use [`diagnostics_channel.subscribe(name, onMessage)`][]
	`315`	`+`
`313`	`316`	* `onMessage` {Function} The handler to receive channel messages
`314`	`317`	* `message` {any} The message data
`315`	`318`	* `name` {string\|symbol} The name of the channel
`@@ -344,12 +347,15 @@ channel.subscribe((message, name) => {`
`344`	`347`	`added:`
`345`	`348`	`- v15.1.0`
`346`	`349`	`- v14.17.0`
	`350`	`+deprecated: REPLACEME`
`347`	`351`	`changes:`
`348`	`352`	`- version: v16.14.0`
`349`	`353`	`pr-url: https://github.com/nodejs/node/pull/40433`
`350`	`354`	`description: Added return value. Added to channels without subscribers.`
`351`	`355`	`-->`
`352`	`356`
	`357`	+> Stability: 0 - Deprecated: Use [`diagnostics_channel.unsubscribe(name, onMessage)`][]
	`358`	`+`
`353`	`359`	* `onMessage` {Function} The previous subscribed handler to remove
`354`	`360`	* Returns: {boolean} `true` if the handler was found, `false` otherwise.
`355`	`361`
`@@ -421,5 +427,6 @@ Emitted when server sends a response.`
`421`	`427`
`422`	`428`	[`'uncaughtException'`]: process.md#event-uncaughtexception
`423`	`429`	[`channel.subscribe(onMessage)`]: #channelsubscribeonmessage
`424`		-[`diagnostics_channel.subscribe(name, onMessage)`]: #diagnostics_channelunsubscribename_onmessage
`425`	`430`	[`diagnostics_channel.channel(name)`]: #diagnostics_channelchannelname
	`431`	+[`diagnostics_channel.subscribe(name, onMessage)`]: #diagnostics_channelsubscribename-onmessage
	`432`	+[`diagnostics_channel.unsubscribe(name, onMessage)`]: #diagnostics_channelunsubscribename-onmessage

0 commit comments

Comments

0 (0)

You are visitor 01402503 — GeezerVison does not store the pages you look up.
Best viewed with Netscape Navigator 4.7 or Internet Explorer 6 at 800×600. No cookies required.