Storybook Channel

---

Storybook Channel is similar to an EventEmitter. Channels are used with Storybook implementations to send/receive events between the Storybook Manager and the Storybook Renderer.

1class Channel {
2  addListener(type, listener) {}
3  addPeerListener(type, listener) {} // ignore events from itself
4  emit(type, ...args) {}
5  eventNames() {}
6  listenerCount(type) {}
7  listeners(type) {}
8  on(type, listener) {}
9  once(type, listener) {}
10  prependListener(type, listener) {}
11  prependOnceListener(type, listener) {}
12  removeAllListeners(type) {}
13  removeListener(type, listener) {}
14}

The channel takes a Transport object as a parameter which will be used to send/receive messages. The transport object should implement this interface.

1class Transport {
2  send(event) {}
3  setHandler(handler) {}
4}

Currently, channels are baked into storybook implementations and therefore this module is not designed to be used directly by addon developers. When developing addons, use the getChannel method exported by @nlabs/storybook-addons module. For this to work, Storybook implementations should use the setChannel method before loading addons.

1import addons from '@nlabs/storybook-addons';
2
3const channel = addons.getChannel();

---

For more information visit: storybook.nitrogenlabs.com