unsubscribe - diagnostics_channel

function unsubscribe

unsubscribe(name: string | symbol,
onMessage: ChannelListener,
): boolean

Deprecated

Remove a message handler previously registered to this channel with subscribe.

import diagnostics_channel from 'node:diagnostics_channel';

function onMessage(message, name) {
  // Received data
}

diagnostics_channel.subscribe('my-channel', onMessage);

diagnostics_channel.unsubscribe('my-channel', onMessage);

Parameters

name: string | symbol

The channel name

onMessage: ChannelListener

The previous subscribed handler to remove

Return Type

boolean

true if the handler was found, false otherwise.