Getting started

Introduction Installation Running it Stability

Concepts

Routes Examples are tests Sealed contracts How fast

API

App Routing Context Schemas (t)Problems

Guides

Schemas Streams, events and uploads WebSockets Jobs Storage Running in production Typed client Middleware and groups Hooks, plugins, decorators Writing a plugin Publish a plugin CLI

Middleware

CORS Rate limit Compress Static files

More middleware

Auth Sessions Secure headers ETag Idempotency Proxy Circuit breaker OpenTelemetry

Stores

Redis store PostgreSQL store MongoDB store MySQL store

Integrations

Integrations @inkanjs/vite @inkanjs/next @inkanjs/query @inkanjs/uws Nuxt, SvelteKit, Astro, Remix

Recipes

Integrations

inkan where you already are. One package each, inkan itself keeps no dependencies.

@inkanjs/vite

The API inside vite dev and vite preview, on Vite's port.

@inkanjs/next

Route handlers, the Pages Router and direct(app) for Server Components.

@inkanjs/query

TanStack Query with keys and types from the paths.

@inkanjs/uws

uWebSockets.js instead of node:http, the fastest way to run inkan.

Recipes

Nuxt, SvelteKit, Astro and Remix need no package.

Every package is tested against the published inkan in CI, on Node 22, 24 and 26, and @inkanjs/next once more inside a real next build and next start. The source lives in inkanjs/integrations.

MySQL store

@inkanjs/mysql: an inkan Store on MySQL 8, on your own mysql2 pool. Exact binary keys, the database's clock, prepared statements only.

@inkanjs/vite

Your inkan API inside the Vite dev server: one port, reloaded on every save.