UNPKG

1.45 kBTypeScriptView Raw
1/// <reference types="node" />
2import { createEventHandler } from "./event-handler/index";
3import { createMiddleware } from "./middleware/index";
4import { sign } from "./sign/index";
5import { verify } from "./verify/index";
6import { Options, WebhookEvent, WebhookError, HandlerFunction } from "./types";
7import { EventNames } from "./generated/event-names";
8import { IncomingMessage, ServerResponse } from "http";
9declare class Webhooks<T extends WebhookEvent = WebhookEvent> {
10 sign: (payload: string | object) => string;
11 verify: (eventPayload?: object, signature?: string) => boolean;
12 on: <E extends EventNames.All>(event: E | E[], callback: HandlerFunction<E, T>) => void;
13 removeListener: <E extends EventNames.All>(event: E | E[], callback: HandlerFunction<E, T>) => void;
14 receive: (options: {
15 id: string;
16 name: string;
17 payload: any;
18 }) => Promise<void>;
19 middleware: (request: IncomingMessage, response: ServerResponse, next?: (err?: any) => void) => void | Promise<void>;
20 verifyAndReceive: (options: WebhookEvent & {
21 signature: string;
22 }) => Promise<void>;
23 constructor(options?: Options<T>);
24}
25declare const createWebhooksApi: Function;
26export { EventNames } from "./generated/event-names";
27export { EventPayloads } from "./generated/event-payloads";
28export { createEventHandler, createMiddleware, createWebhooksApi, Webhooks, WebhookEvent, WebhookError, sign, verify, };