JSPM

koa-parameter

3.0.1
  • ESM via JSPM
  • ES Module Entrypoint
  • Export Map
  • Keywords
  • License
  • Repository URL
  • TypeScript Types
  • README
  • Created
  • Published
  • Downloads 207
  • Score
    100M100P100Q77697F
  • License MIT

parameter validate middleware for koa

Package Exports

  • koa-parameter

This package does not declare an exports field, so the exports above have been automatically detected and optimized by JSPM instead. If any package subpath is missing, it is recommended to post an issue to the original package (koa-parameter) to support the "exports" field. If that is not possible, create a JSPM override to customize the exports field for this package.

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