oak-hooks

A wrapper of the oak middleware framework which exposes a functional hook-based API.

This library removes the need to manually manage the Application and Router instances in your code, lets you group middlewares into custom hooks, and lets you instantiate components in different ways according to you needs.

Most importantly, this library is interoperable with existing oak code, so you can adopt it gradually.

Example

The ubiquitous Hello World! program:

import { use, listen } from "oak-hooks";

const App = () => {
  use((ctx) => {
    ctx.response.body = "Hello World!";
  });
}

await listen(App, { port: 8080 });

You would then run this script in Deno like:

> deno run --allow-net helloWorld.ts

listen() and routes()

With oak-hooks, there is no distinction between an Application and a Router component. That distinction is only made when the component is instantiated. Using listen() will instanciate the component as an Application, and using routes() will instanciate the component as a Router.

For convenience, you can use the get, post, head and other HTTP method hooks with the listen() function. Under the hood, a router will be instantiated and automatically used by the application instance.

Altough you shouldn’t need to use them, we also provide the appify() and routerify() functions as escape hatches if you need to access the Application and Router instances directly.

An example:

import { get, use, routes, listen } from "oak-hooks";

const books = new Map<string, any>();
books.set("1", {
  id: "1",
  title: "The Hound of the Baskervilles",
  author: "Conan Doyle, Arthur",
});

const Router = () => {
  get("/book", (context) => {
    context.response.body = Array.from(books.values());
  });
  get("/book/:id", (context) => {
    if (context.params && context.params.id && books.has(context.params.id)) {
      context.response.body = books.get(context.params.id);
    }
  });
}

const App = () => {
  get("/", (context) => {
    context.response.body = "Hello world!";
  });
  
  use(routes(Router));
  use(allowedMethods(Router));
}

await listen(App, { port: 8080});

There are currently plans to provide an interface that could allow anyone to create their own instantiation functions. This could let people instantiate components into mock objects for testing, OpenAPI documentation, or anything else.

API

Hooks

Instantiation functions