Getting Started

Quick Start (CLI)

Create a server entry:

export default {
  fetch(req: Request) {
    return Response.json({ hello: "world!" });
  },
};

Then, run the server using your favorite runtime:

npx srvx

pnpx srvx

yarn dlx srvx

deno -A npm:srvx

bunx --bun srvx

Quick Start (API)

Instead of using the srvx CLI, you can directly import the serve method to define a self-listening server entry.

Create a server entry:

import { serve } from "srvx";

const server = serve({
  fetch(request) {
    return Response.json({ hello: "world!" });
  },
});

Install srvx as a dependency:

npm i srvx

yarn add srvx

pnpm i srvx

bun i srvx

deno i npm:srvx

Then, run the server using your favorite runtime:

node server.mjs

deno run --allow-env --allow-net server.mjs

bun run server.mjs

TypeScript

Each entry only pulls in the types of the runtime it targets. The ambient type packages below are declared as optional peerDependencies, so nothing is installed unless you ask for it:

Everything else — srvx/types, srvx/service-worker, srvx/static, srvx/log, srvx/body-limit, srvx/tracing, srvx/mtls and srvx/cli — needs none of them, so a project can type check with skipLibCheck: false:

import { serve } from "srvx/node"; // only needs `@types/node`
import { staticMiddleware } from "srvx/static"; // needs nothing
import type { ServerRequest } from "srvx/types"; // needs nothing

Runtime specific fields such as server.node, request.runtime.deno or the bun option are typed as soon as the types of that runtime are loaded, and stay loosely typed (Record<string, unknown>) otherwise — importing srvx/<runtime> anywhere in your project is enough to type them everywhere.

declare module "cloudflare:workers" {
  export const env: Record<string, unknown>;
}

Starter Examples