Skip to content

Commit

Permalink
docs: add table of contents for guide.md (#1267)
Browse files Browse the repository at this point in the history
  • Loading branch information
ZYSzys authored and dead-horse committed Nov 9, 2018
1 parent 9905199 commit 325792a
Showing 1 changed file with 11 additions and 2 deletions.
13 changes: 11 additions & 2 deletions docs/guide.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,17 @@

This guide covers Koa topics that are not directly API related, such as best practices for writing middleware and application structure suggestions. In these examples we use async functions as middleware - you can also use commonFunction or generatorFunction which will be a little different.

## Table of Contents

- [Writing Middleware](#writing-middleware)
- [Middleware Best Practices](#middleware-best-practices)
- [Middleware options](#middleware-options)
- [Named middleware](#named-middleware)
- [Combining multiple middleware with koa-compose](#combining-multiple-middleware-with-koa-compose)
- [Response Middleware](#response-middleware)
- [Async operations](#async-operations)
- [Debugging Koa](#debugging-koa)

## Writing Middleware

Koa middleware are simple functions which return a `MiddlewareFunction` with signature (ctx, next). When
Expand Down Expand Up @@ -123,8 +134,6 @@ const all = compose([random, backwards, pi]);
app.use(all);
```



### Response Middleware

Middleware that decide to respond to a request and wish to bypass downstream middleware may
Expand Down

0 comments on commit 325792a

Please sign in to comment.