@storybook/channels
- Version 7.0.18
- Published
- 8.31 kB
- No dependencies
- MIT license
Install
npm i @storybook/channels
yarn add @storybook/channels
pnpm add @storybook/channels
Overview
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.
Index
Classes
class Channel
class Channel {}
constructor
constructor({ transport, async }?: ChannelArgs);
property hasTransport
readonly hasTransport: boolean;
property isAsync
readonly isAsync: boolean;
method addListener
addListener: (eventName: string, listener: Listener) => void;
method emit
emit: (eventName: string, ...args: any) => void;
method eventNames
eventNames: () => string[];
method last
last: (eventName: string) => any;
method listenerCount
listenerCount: (eventName: string) => number;
method listeners
listeners: (eventName: string) => Listener[] | undefined;
method off
off: (eventName: string, listener: Listener) => void;
method on
on: (eventName: string, listener: Listener) => void;
method once
once: (eventName: string, listener: Listener) => void;
method removeAllListeners
removeAllListeners: (eventName?: string) => void;
method removeListener
removeListener: (eventName: string, listener: Listener) => void;
Interfaces
interface ChannelEvent
interface ChannelEvent {}
interface ChannelTransport
interface ChannelTransport {}
method send
send: (event: ChannelEvent, options?: any) => void;
method setHandler
setHandler: (handler: ChannelHandler) => void;
interface Listener
interface Listener {}
call signature
(...args: any[]): void;
Type Aliases
type ChannelHandler
type ChannelHandler = (event: ChannelEvent) => void;
Package Files (1)
Dependencies (0)
No dependencies.
Dev Dependencies (1)
Peer Dependencies (0)
No peer dependencies.
Badge
To add a badge like this oneto your package's README, use the codes available below.
You may also use Shields.io to create a custom badge linking to https://www.jsdocs.io/package/@storybook/channels
.
- Markdown[](https://www.jsdocs.io/package/@storybook/channels)
- HTML<a href="https://www.jsdocs.io/package/@storybook/channels"><img src="https://img.shields.io/badge/jsDocs.io-reference-blue" alt="jsDocs.io"></a>
- Updated .
Package analyzed in 1378 ms. - Missing or incorrect documentation? Open an issue for this package.