UNPKG

1.91 kBTypeScriptView Raw
1import { createEventHandler } from "./event-handler/index";
2import { EmitterWebhookEvent, EmitterWebhookEventName, HandlerFunction, RemoveHandlerFunction, Options, WebhookError, WebhookEventHandlerError, EmitterWebhookEventWithStringPayloadAndSignature, EmitterWebhookEventWithSignature } from "./types";
3export { createNodeMiddleware } from "./middleware/node/index";
4export { emitterEventNames } from "./generated/webhook-names";
5export type Iverify = {
6 /** @deprecated Passing a JSON payload object to `verify()` is deprecated and the functionality will be removed in a future release of `@octokit/webhooks`. */
7 (eventPayload: object, signature: string): Promise<boolean>;
8 (eventPayload: string, signature: string): Promise<boolean>;
9};
10export type IverifyAndReceive = {
11 /** @deprecated Passing a JSON payload object to `verifyAndReceive()` is deprecated and the functionality will be removed in a future release of `@octokit/webhooks`. */
12 (options: EmitterWebhookEventWithSignature): Promise<void>;
13 (options: EmitterWebhookEventWithStringPayloadAndSignature): Promise<void>;
14};
15declare class Webhooks<TTransformed = unknown> {
16 sign: (payload: string | object) => Promise<string>;
17 verify: Iverify;
18 on: <E extends EmitterWebhookEventName>(event: E | E[], callback: HandlerFunction<E, TTransformed>) => void;
19 onAny: (callback: (event: EmitterWebhookEvent) => any) => void;
20 onError: (callback: (event: WebhookEventHandlerError) => any) => void;
21 removeListener: <E extends EmitterWebhookEventName | "*">(event: E | E[], callback: RemoveHandlerFunction<E, TTransformed>) => void;
22 receive: (event: EmitterWebhookEvent) => Promise<void>;
23 verifyAndReceive: IverifyAndReceive;
24 constructor(options: Options<TTransformed> & {
25 secret: string;
26 });
27}
28export { createEventHandler, Webhooks, EmitterWebhookEvent, EmitterWebhookEventName, WebhookError, };