Koa Context Cache Control

August 28, 2017 ยท View on GitHub

NPM version Build status Test coverage Greenkeeper badge Dependency Status License Downloads

Augments Koa with ctx.cacheControl() and ctx.response.cacheControl().

Example

const Koa = require('koa')

const app = new Koa()

require('koa-ctx-cache-control')(app)

app.use(async (ctx, next) => {
  ctx.cacheControl(false) // no cache

  await next()
})

API

ctx.cacheControl()

If it's a time ms can parse, then it uses that time as the max age:

ctx.cacheControl('1 second') // => max-age=1

Otherwise, it sets the header directly:

ctx.cacheControl('max-age=0') // => max-age=0

ctx.cacheControl(ms)

Sets the max age with a number in milliseconds.

ctx.cacheControl(1000) // => max-age=1

ctx.cacheControl(false)

Sets a no cache directive.