Skip to main content

bindStore

method Channel.prototype.bindStore
unstable
Jump to headingChannel.prototype.bindStore(
store: AsyncLocalStorage<StoreType>,
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 };
});

Parameters Jump to heading

The store to which to bind the context data

optional
Jump to headingtransform: (context: ContextType) => StoreType

Transform context data before setting the store context

Return Type Jump to heading

void
Back to top