Home

Awesome

<div align="center"> <img src="/docs/logo.png" alt="Doa middleware framework for deno"/>

Github Action Status PRs Welcome GitHub license tag tag

<!-- ALL-CONTRIBUTORS-BADGE:START - Do not remove or modify this section -->

All Contributors

<!-- ALL-CONTRIBUTORS-BADGE:END -->

A middleware framework for Deno's http serve. Transplanted from Koa.

</div>

⚡️ Quick start

A basic usage, responding to every request with Hello World;

import { App } from "https://deno.land/x/doa/mod.ts";

const app = new App();

app.use(async ctx => {
  ctx.status = 200;
  ctx.body = "Hello World";
});

app.listen({ port: 8000 });

Adding middlewares through app.use(middleware), will cause all of the middlewares to be executed upon each request in the specified order. When you call the middleware, it passed the context and next method in the stack.

A more complex example with responseTime middleware, which will add x-response-time in the response header:

import { App } from "https://deno.land/x/doa/mod.ts";
import { responseTime } from "https://deno.land/x/response-time/mod.ts";

const app = new App();

app.use(responseTime());

app.use(async ctx => {
  ctx.status = 200;
  ctx.body = "Hello World";
});

app.listen({ port: 8000 });

📑 docs

For more information see https://koajs.com/.

🧪 Running tests

More than 199 test cases( over 90% ) to ensure code quality.

$ deno test --allow-read --allow-write --allow-net --allow-hrtime  

# test result: ok. 199 passed; 0 failed; 0 ignored; 0 measured; 0 filtered out (715ms)

🚀 Running benchmarks

Use wrk to benchmark doa.

$ deno run --allow-net --allow-env  ./example.ts
$ make -C benchmarks 

🎯 Trouble Shooting

Make sure you are using deno 1.1.3 and std 0.59.0. Doa will continue to update deno to the latest version later.

License

MIT

Contributors ✨

Thanks goes to these wonderful people (emoji key):

<!-- ALL-CONTRIBUTORS-LIST:START - Do not remove or modify this section --> <!-- prettier-ignore-start --> <!-- markdownlint-disable --> <table> <tr> <td align="center"><a href="https://github.com/JohannLai"><img src="https://avatars0.githubusercontent.com/u/10769405?v=4" width="100px;" alt=""/><br /><sub><b>JohannLai</b></sub></a><br /><a href="https://github.com/JohannLai/doa/commits?author=JohannLai" title="Code">💻</a></td> </tr> </table> <!-- markdownlint-enable --> <!-- prettier-ignore-end --> <!-- ALL-CONTRIBUTORS-LIST:END -->

This project follows the all-contributors specification. Contributions of any kind welcome!