expressAdapter

expressAdapter<TEventMap>(router, options): (req, res, next) => Promise<void>

Defined in: express/src/index.ts:41

Creates an Express middleware for handling webhooks

IMPORTANT: This adapter requires req.body to be a raw Buffer or string. Use express.raw({ type: 'application/json' }) middleware on your webhook route.

Type Parameters

TEventMap

TEventMap extends Record<string, WebhookEvent>

Parameters

router

WebhookRouter<TEventMap>

The WebhookRouter instance

options

ExpressAdapterOptions<TEventMap[keyof TEventMap]>

Adapter options including a verifier function

Returns

Express middleware function

(req, res, next): Promise<void>

Parameters

req

Request

res

Response

next

NextFunction

Returns

Promise<void>

Example

import express from 'express';
import { expressAdapter } from '@kotodayori/express';
import { createStripeVerifier, StripeWebhookRouter } from '@kotodayori/stripe';

const router = new StripeWebhookRouter();
const app = express();

app.post('/webhook',
  express.raw({ type: 'application/json' }),
  expressAdapter(router, {
    verifier: createStripeVerifier(stripe, 'whsec_...'),
  })
);