README.md

Aqua

Aqua is a minimal and fast web framework.

⚠️ This version is a WIP and has not yet been released. Please refer to the main branch for the current documentation.

Example usage

It starts easy,

import { Aqua } from "...";

const app = new Aqua({
  listen: {
    port: 80,
  },
});

app.route("/").respond(Method.GET, (_event) => {
  return new Response("Hello, World!");
});

... and stays easy.

const v1 = app.route("/v1").step(async (event) => {
  if (!event.request.headers.has("X-Api-Key")) {
    event.response = Response.json(
      { error: "MISSING_API_KEY" },
      {
        status: 400,
      }
    );
    return event.end();
  }

  const user = await getUserByRequest(event.request);
  //    ^ type User

  return {
    ...event,
    user,
  };
});

v1.route("/user").respond(Method.GET, (event) => {
  return Response.json({ data: { user: event.user } });
  //                                         ^ type User
});