koa-lite/docs/faq.md

56 lines
2.2 KiB
Markdown
Raw Permalink Normal View History

2013-08-21 05:07:00 +00:00
# Frequently Asked Questions
## Does Koa replace Express?
2013-12-19 06:54:56 +00:00
It's more like Connect, but a lot of the Express goodies
were moved to the middleware level in Koa to help form
a stronger foundation. This makes middleware more enjoyable
2013-12-19 07:08:50 +00:00
and less error-prone to write, for the entire stack, not
just the end application code.
Typically many middleware would
2013-12-19 07:08:14 +00:00
re-implement similar features, or even worse incorrectly implement them,
when features like signed cookie secrets among others are typically application-specific,
not middleware specific.
2013-08-21 05:07:00 +00:00
## Does Koa replace Connect?
No, just a different take on similar functionality
now that generators allow us to write code with less
2013-12-19 06:54:56 +00:00
callbacks. Connect is equally capable, and some may still prefer it,
it's up to what you prefer.
2013-12-19 07:03:11 +00:00
2013-12-19 16:47:40 +00:00
## Do generators decrease performance?
2013-12-19 07:03:11 +00:00
Barely - check out the benchmarks in our readme, the numbers
2013-12-19 21:59:00 +00:00
are more than fine, and there's no substitute for proper
2013-12-19 16:47:40 +00:00
horizontal scaling.
## Does Koa include routing?
No - out of the box Koa has no form of routing, however
many routing middleware are available: https://github.com/koajs/koa/wiki
## Why isn't Koa just Express 4.0?
Koa is a pretty large departure from what people know about Express,
the design is fundamentally much different, so the migration from
Express 3.0 to this Express 4.0 would effectively mean rewriting
the entire application, so we thought it would be more appropriate
2013-12-19 21:59:00 +00:00
to create a new library.
## What custom properties do the Koa objects have?
Koa uses its own custom objects: `this`, `this.request`, and `this.response`.
These objects abstract node's `req` and `res` objects with convenience methods and getters/setters.
Generally, properties added to these objects must obey the following rules:
- They must be either very commonly used and/or must do something useful
- If a property exists as a setter, then it will also exist as a getter, but not vice versa
Many of `this.request` and `this.response`'s properties are delegated to `this`.
If it's a getter/setter, then both the getter and the setter will strictly
correspond to either `this.request` or `this.response`.
Please think about these rules before suggesting additional properties.