@octokit/webhooks

  • Version 14.1.3
  • Published
  • 184 kB
  • 3 dependencies
  • MIT license

Install

npm i @octokit/webhooks
yarn add @octokit/webhooks
pnpm add @octokit/webhooks

Overview

GitHub webhook events toolset for Node.js

Index

Classes

class Webhooks

class Webhooks<TTransformed = unknown> {}

    constructor

    constructor(options: any);

      property on

      on: <E extends EmitterWebhookEventName>(
      event: E | E[],
      callback: HandlerFunction<E, TTransformed>
      ) => void;

        property onAny

        onAny: (
        callback: (
        event: TTransformed extends unknown
        ? EmitterWebhookEvent
        : EmitterWebhookEvent & TTransformed
        ) => any
        ) => void;

          property onError

          onError: (
          callback: (event: WebhookEventHandlerError<TTransformed>) => any
          ) => void;

            property receive

            receive: (event: EmitterWebhookEvent) => Promise<void>;

              property removeListener

              removeListener: <E extends unknown>(
              event: E | E[],
              callback: RemoveHandlerFunction<E, TTransformed>
              ) => void;

                property sign

                sign: (payload: string) => Promise<string>;

                  property verify

                  verify: (eventPayload: string, signature: string) => Promise<boolean>;

                    property verifyAndReceive

                    verifyAndReceive: (
                    options: EmitterWebhookEventWithStringPayloadAndSignature
                    ) => Promise<void>;

                      Package Files (1)

                      Dependencies (3)

                      Dev Dependencies (13)

                      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/@octokit/webhooks.

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