Logo for jsDocs.io

smee-client

  • Version 3.1.1
  • Published
  • 8.37 kB
  • 4 dependencies
  • ISC license

Install

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

Overview

Client to proxy webhooks to localhost

Index

Classes

Classes

class Client

class Client {}

    constructor

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

      method createChannel

      static createChannel: ({
          fetch,
      }?: {
          fetch?: typeof undiciFetch | undefined;
      }) => Promise<string>;

        method onerror

        onerror: (err: ErrorEvent) => void;

          method onmessage

          onmessage: (msg: MessageEvent) => Promise<void>;

            method onopen

            onopen: () => void;

              method start

              start: () => EventSource;

                Package Files (1)

                Dependencies (4)

                Dev Dependencies (8)

                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>