Logo for jsDocs.io

@storybook/channel-websocket

  • Version 7.0.18
  • Published
  • 6.64 kB
  • 4 dependencies
  • MIT license

Install

npm i @storybook/channel-websocket
yarn add @storybook/channel-websocket
pnpm add @storybook/channel-websocket

Overview

Storybook Websocket Channel is a channel for Storybook that can be used when the Storybook Renderer should communicate with the Storybook Manager over the network. A channel can be created using the `createChannel` function.

Index

Functions

Classes

Functions

function createChannel

createChannel: ({ url, async, onError }: CreateChannelArgs) => Channel;

    Classes

    class WebsocketTransport

    class WebsocketTransport {}

      constructor

      constructor({ url, onError }: WebsocketTransportArgs);

        method send

        send: (event: any) => void;

          method setHandler

          setHandler: (handler: ChannelHandler) => void;

            Package Files (1)

            Dependencies (4)

            Dev Dependencies (1)

            Peer Dependencies (0)

            No peer dependencies.

            Badge

            To add a badge like this onejsDocs.io badgeto 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/channel-websocket.

            • Markdown
              [![jsDocs.io](https://img.shields.io/badge/jsDocs.io-reference-blue)](https://www.jsdocs.io/package/@storybook/channel-websocket)
            • HTML
              <a href="https://www.jsdocs.io/package/@storybook/channel-websocket"><img src="https://img.shields.io/badge/jsDocs.io-reference-blue" alt="jsDocs.io"></a>