koa-parameter

parameter validate middleware for koa, powered by parameter

Showing:

Popularity

Downloads/wk

383

GitHub Stars

51

Maintenance

Last Commit

4yrs ago

Contributors

5

Package

Dependencies

1

Size (min+gzip)

2.2KB

License

MIT

Type Definitions

Tree-Shakeable

No?

Categories

Readme

koa-parameter

NPM version build status Test coverage David deps node version Gittip

parameter validate middleware for koa, powered by parameter.

Installation

$ npm install koa-parameter --save

Usage

const Koa = require('koa');
const parameter = require('koa-parameter');

const app = new Koa();

parameter(app); // add verifyParams method, but don't add middleware to catch the error
// app.use(parameter(app)); // also add a middleware to catch the error.

app.use(async function (ctx) {
  ctx.verifyParams({
    name: 'string'
  });
});

Checkout parameter to get all the rules.

Translate

You can override the translate method of parameter to implement I18n, by passing a function like this :

const Koa = require('koa');
const parameter = require('koa-parameter');

const app = new Koa();

parameter(app, function() {
  // Same example with node-parameter
  var args = Array.prototype.slice.call(arguments);
  // Assume there have I18n.t method for convert language.
  return I18n.t.apply(I18n, args);
});

app.use(async function (ctx) {
  ctx.verifyParams({
    name: 'string'
  });
});

Example

License

MIT

Rate & Review

Great Documentation0
Easy to Use0
Performant0
Highly Customizable0
Bleeding Edge0
Responsive Maintainers0
Poor Documentation0
Hard to Use0
Slow0
Buggy0
Abandoned0
Unwelcoming Community0
100