Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/koajs/cluster
Koa clustering and error handling utility
https://github.com/koajs/cluster
Last synced: 2 months ago
JSON representation
Koa clustering and error handling utility
- Host: GitHub
- URL: https://github.com/koajs/cluster
- Owner: koajs
- Created: 2014-04-08T23:21:56.000Z (over 10 years ago)
- Default Branch: master
- Last Pushed: 2021-10-29T10:43:20.000Z (about 3 years ago)
- Last Synced: 2024-04-14T13:08:39.308Z (8 months ago)
- Language: JavaScript
- Homepage:
- Size: 8.79 KB
- Stars: 64
- Watchers: 4
- Forks: 13
- Open Issues: 4
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
- awesome-koa - cluster - Koa clustering and error handling utility (Middleware)
- awesome-koa - koa-cluster - Koa集群和错误处理工具。   (仓库 / 中间件)
README
# Koa Cluster
Lightweight, opinionated clustering for Koa apps.
Use this if you don't want the complexity of other process managers.
## Usage
```bash
koa-cluster app.js
```
## Koa App
You must export your Koa app like:
```js
var app = module.exports = koa()
```
Make sure you don't create a `http` server yourself.
Don't call `app.listen()`.
This will handle it automatically.
### Check Continue
This automatically utilizes the `checkContinue` event.
You should handle this wherever appropriate in your Koa app:
```js
app.use(function* () {
if (this.req.checkContinue) this.res.writeContinue();
var body = yield parse(this);
})
```
### Settings
Custom settings are checked on the `app` that aren't part of Koa.
You can set them however you'd like.
These settings are:
- `name` - your app's name
- `port`
- `hostname`
- `maxHeadersCount`
- `timeout`
## License
The MIT License (MIT)
Copyright (c) 2014 Jonathan Ong [email protected]
Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in
all copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
THE SOFTWARE.