Interface WebhookRouter

interface WebhookRouter {
    on(type: string, handler: WebhookHandler): WebhookRouter;
    onUnhandled(handler: WebhookHandler): WebhookRouter;
    handle(event: StripeWebhookEvent): Promise<HandleResult>;
}

Index

Methods

on onUnhandled handle

Methods

on

on(type: string, handler: WebhookHandler): WebhookRouter
register (or replace) the handler for an event type; chainable.
Parameters
- type: string
- handler: WebhookHandler
Returns WebhookRouter
- Defined in stripe-webhook.ts:62

onUnhandled

onUnhandled(handler: WebhookHandler): WebhookRouter
register a fallback for types with no specific handler; chainable.
Parameters
- handler: WebhookHandler
Returns WebhookRouter
- Defined in stripe-webhook.ts:64

handle

handle(event: StripeWebhookEvent): Promise<HandleResult>
dispatch one verified event to its handler.
Parameters
- event: StripeWebhookEvent
Returns Promise<HandleResult>
- Defined in stripe-webhook.ts:66