smee-client

  • Version 1.2.2
  • Published
  • 6.74 kB
  • 5 dependencies
  • ISC license

Install

npm i smee-client
yarn add smee-client
pnpm add smee-client

Overview

Client to proxy webhooks to local host

Index

Classes

class Client

class Client {}

    constructor

    constructor({ source, target, logger }: Options);

      property events

      events: EventSource;

        property logger

        logger: Pick<Console, Severity>;

          property source

          source: string;

            property target

            target: string;

              method createChannel

              static createChannel: () => Promise<any>;

                method onerror

                onerror: (err: any) => void;

                  method onmessage

                  onmessage: (msg: any) => void;

                    method onopen

                    onopen: () => void;

                      method start

                      start: () => EventSource;

                        Package Files (1)

                        Dependencies (5)

                        Dev Dependencies (15)

                        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/smee-client.

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