温馨提示：本站仅提供公开网络链接索引服务，不存储、不篡改任何第三方内容，所有内容版权归原作者所有
AI智能索引来源：http://www.bun.com/reference/node/diagnostics_channel/Channel
点击访问原文链接

Node diagnostics_channel.Channel class | API Reference | Bun

进入原网站 导航首页
Node diagnostics_channel.Channel class | API Reference | BunBuildDocsReferenceGuidesBlogDiscord/node:diagnostics_channel/ChannelMbindStorePhasSubscribersPnameMpublishMrunStoresMsubscribeMunbindStoreMunsubscribe

Search the reference...

/

BuildDocsReferenceGuidesBlogDiscord/node:diagnostics_channel/ChannelMbindStorePhasSubscribersPnameMpublishMrunStoresMsubscribeMunbindStoreMunsubscribe

class

diagnostics_channel.Channelclass ChannelStoreType = unknown, ContextType = StoreType>The class Channel represents an individual named channel within the data pipeline. It is used to track subscribers and to publish messages when there are subscribers present. It exists as a separate object to avoid channel lookups at publish time, enabling very fast publish speeds and allowing for heavy use while incurring very minimal cost. Channels are created with channel, constructing a channel directly with new Channel(name) is not supported.

readonly hasSubscribers: booleanCheck if there are active subscribers to this channel. This is helpful if the message you want to send might be expensive to prepare.

This API is optional but helpful when trying to publish messages from very performance-sensitive code.

import diagnostics_channel from 'node:diagnostics_channel'; const channel = diagnostics_channel.channel('my-channel'); if (channel.hasSubscribers) { // There are subscribers, prepare and publish message } readonly name: string | symbol { return { data }; }); ```" data-algolia-static="false" data-algolia-merged="false" data-type="Method">bindStore(store: AsyncLocalStorageStoreType>,transform?: (context: ContextType) => StoreType): void;When channel.runStores(context, ...) is called, the given context data will be applied to any store bound to the channel. If the store has already been bound the previous transform function will be replaced with the new one. The transform function may be omitted to set the given context data as the context directly.

import diagnostics_channel from 'node:diagnostics_channel'; import { AsyncLocalStorage } from 'node:async_hooks'; const store = new AsyncLocalStorage(); const channel = diagnostics_channel.channel('my-channel'); channel.bindStore(store, (data) => { return { data }; }); @param storeThe store to which to bind the context data

@param transformTransform context data before setting the store context

publish(message: unknown): void;Publish a message to any subscribers to the channel. This will trigger message handlers synchronously so they will execute within the same context.

import diagnostics_channel from 'node:diagnostics_channel'; const channel = diagnostics_channel.channel('my-channel'); channel.publish({ some: 'message', }); @param messageThe message to send to the channel subscribers

{ const parent = store.getStore(); return new Span(message, parent); }); channel.runStores({ some: 'message' }, () => { store.getStore(); // Span({ some: 'message' }) }); ```" data-algolia-static="false" data-algolia-merged="false" data-type="Method">runStoresThisArg = any, Args extends any[] = any[], Result = any>(context: ContextType,fn: (this: ThisArg, ...args: Args) => Result,thisArg?: ThisArg,...args: Args): Result;Applies the given data to any AsyncLocalStorage instances bound to the channel for the duration of the given function, then publishes to the channel within the scope of that data is applied to the stores.

If a transform function was given to channel.bindStore(store) it will be applied to transform the message data before it becomes the context value for the store. The prior storage context is accessible from within the transform function in cases where context linking is required.

The context applied to the store should be accessible in any async code which continues from execution which began during the given function, however there are some situations in which context loss may occur.

import diagnostics_channel from 'node:diagnostics_channel'; import { AsyncLocalStorage } from 'node:async_hooks'; const store = new AsyncLocalStorage(); const channel = diagnostics_channel.channel('my-channel'); channel.bindStore(store, (message) => { const parent = store.getStore(); return new Span(message, parent); }); channel.runStores({ some: 'message' }, () => { store.getStore(); // Span({ some: 'message' }) }); @param contextMessage to send to subscribers and bind to stores

@param fnHandler to run within the entered storage context

@param thisArgThe receiver to be used for the function call.

@param argsOptional arguments to pass to the function.

{ // Received data }); ```" data-algolia-static="false" data-algolia-merged="false" data-type="Method">subscribe(onMessage: ChannelListener): void;Register a message handler to subscribe to this channel. This message handler will be run synchronously whenever a message is published to the channel. Any errors thrown in the message handler will trigger an 'uncaughtException'.

import diagnostics_channel from 'node:diagnostics_channel'; const channel = diagnostics_channel.channel('my-channel'); channel.subscribe((message, name) => { // Received data }); @param onMessageThe handler to receive channel messages

unbindStore(store: AsyncLocalStorageStoreType>): boolean;Remove a message handler previously registered to this channel with channel.bindStore(store).

import diagnostics_channel from 'node:diagnostics_channel'; import { AsyncLocalStorage } from 'node:async_hooks'; const store = new AsyncLocalStorage(); const channel = diagnostics_channel.channel('my-channel'); channel.bindStore(store); channel.unbindStore(store); @param storeThe store to unbind from the channel.

@returnstrue if the store was found, false otherwise.

unsubscribe(onMessage: ChannelListener): void;Remove a message handler previously registered to this channel with channel.subscribe(onMessage).

import diagnostics_channel from 'node:diagnostics_channel'; const channel = diagnostics_channel.channel('my-channel'); function onMessage(message, name) { // Received data } channel.subscribe(onMessage); channel.unsubscribe(onMessage); @param onMessageThe previous subscribed handler to remove

@returnstrue if the handler was found, false otherwise.

Resources

ReferenceDocsGuidesDiscordMerch StoreGitHubBlog 

Toolkit

RuntimePackage managerTest runnerBundlerPackage runner

Project

Bun 1.0Bun 1.1Bun 1.2Bun 1.3RoadmapContributingLicenseBaked with ❤️ in San Francisco

We're hiring →

智能索引记录