Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
1 parent
e1e1515
commit ff796cc
Showing
1 changed file
with
53 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,53 @@ | ||
|
||
# koa-conditional-get | ||
|
||
[![Build Status](https://travis-ci.org/koajs/conditional-get.png)](https://travis-ci.org/koajs/conditional-get) | ||
|
||
Conditional GET support for koa. | ||
|
||
|
||
## Installation | ||
|
||
```bash | ||
# npm | ||
$ npm install koa-conditional-get | ||
# yarn | ||
$ yarn add koa-conditional-get | ||
``` | ||
|
||
|
||
## Example | ||
|
||
```js | ||
const conditional = require('koa-conditional-get'); | ||
const etag = require('koa-etag'); | ||
const Koa = require('koa'); | ||
const app = new Koa(); | ||
|
||
// use it upstream from etag so | ||
// that they are present | ||
app.use(conditional()); | ||
|
||
// add etags | ||
app.use(etag()); | ||
|
||
// respond | ||
app.use(async function(ctx, next){ | ||
await next(); | ||
|
||
ctx.body = { | ||
name: 'tobi', | ||
species: 'ferret', | ||
age: 2 | ||
}; | ||
}) | ||
|
||
app.listen( | ||
3000, | ||
console.log('listening on port 3000') | ||
) | ||
``` | ||
|
||
## License | ||
|
||
[MIT](LICENSE) |