restaq

Install

pnpm add restaq

npm install restaq

yarn add restaq

bun add restaq

Exports

Functions

restaq

function restaq<const TPlugins extends readonly RelayPlugin<any>[] = []>(
  config: RelayConfig<TPlugins>,
): Relay<EventMapOf<TPlugins>>;

Creates a Restaq runtime instance. This is the main entry point for developers: register event handlers via restaq.on(), receive provider webhooks through restaq.handler, and configure persistence via config.database — a Postgres/SQLite/MySQL client (auto-detected), a { dialect } Kysely escape hatch, or a custom ExecutionStore. The relay's event types are inferred from the plugins you register—typed plugins make restaq.on() autocomplete event names and narrow event payloads.

restaq/next-js

Next.js support is a subpath export of this package — no separate install.

function toNextJsHandler<TEventMap extends Record<string, unknown>>(
  relay: Relay<TEventMap>,
): {
  POST: (req: Request, ctx: { params: Promise<{ all: string[] }> }) => Promise<Response>;
};

Adapts a relay instance to a Next.js App Router catch-all route. Returns an object with a POST handler that integrates the relay's webhook handler. Uses only web-standard Request/Response plus Next.js's promise-shaped route params—no import from 'next' is required.

// app/api/webhook/[...all]/route.ts
import { toNextJsHandler } from 'restaq/next-js';
import { restaq } from '@/relay';

export const { POST } = toNextJsHandler(restaq);

Provider webhooks are then received at /api/webhook/<provider> (e.g., /api/webhook/stripe).

Other framework adapters

Express, Hono, and NestJS support are subpath exports of this package — no separate installs.

import { toExpressHandler } from 'restaq/express';
import { toHonoHandler } from 'restaq/hono';
import { toNestJsHandler } from 'restaq/nestjs';

See the framework guides for setup examples and raw-body notes.

See also

• @restaq/core
• Installation
• Next.js guide
• Express guide
• Hono guide
• NestJS guide
• Plugins