Skip to content

tilap/koa-state

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

5 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Koa state NPM version

Simple state layer middleware for Koa 2. As mentionned in official koajs:

ctx.state The recommended namespace for passing information through middleware and to your frontend views.

Install

npm install --save koa-state

Usage

const Koa = require('Koa');
const koaState = require('koa-state');

const app = new Koa();
app.use(koaState());

app.use(async (ctx, next) => {
  if (!ctx.hasState('my-key-state')) {
    ctx.setState('my-key-state', 'anything-as-value');
  }

  await next();
});

app.use(async (ctx, next) => {
  console.log(ctx.getState('my-key-state'));
  await next();
});

app.listen(3000);

Options

You can customize the context key with app.use(koaState('contextKey'));

License

MIT

About

Simple state layer middleware for Koa 2

Resources

License

Stars

Watchers

Forks

Packages

No packages published