npm package discovery and stats viewer.

Discover Tips

  • General search

    [free text search, go nuts!]

  • Package details

    pkg:[package-name]

  • User packages

    @[username]

Sponsor

Optimize Toolset

I’ve always been into building performant and accessible sites, but lately I’ve been taking it extremely seriously. So much so that I’ve been building a tool to help me optimize and monitor the sites that I build to make sure that I’m making an attempt to offer the best experience to those who visit them. If you’re into performant, accessible and SEO friendly sites, you might like it too! You can check it out at Optimize Toolset.

About

Hi, 👋, I’m Ryan Hefner  and I built this site for me, and you! The goal of this site was to provide an easy way for me to check the stats on my npm packages, both for prioritizing issues and updates, and to give me a little kick in the pants to keep up on stuff.

As I was building it, I realized that I was actually using the tool to build the tool, and figured I might as well put this out there and hopefully others will find it to be a fast and useful way to search and browse npm packages as I have.

If you’re interested in other things I’m working on, follow me on Twitter or check out the open source projects I’ve been publishing on GitHub.

I am also working on a Twitter bot for this site to tweet the most popular, newest, random packages from npm. Please follow that account now and it will start sending out packages soon–ish.

Open Software & Tools

This site wouldn’t be possible without the immense generosity and tireless efforts from the people who make contributions to the world and share their work via open source initiatives. Thank you 🙏

© 2024 – Pkg Stats / Ryan Hefner

koa-ajv

v0.1.1

Published

Route validator middleware for KoaJS based on ajv

Downloads

9

Readme

koa-ajv

Travis David Codecov Code Climate Prs

Koa validator middleware based on ajv JSON-schema validator. You will need support for async/await so Node >=7.6 and Koa2 is the ideal combo.

Overview

The middleware allows you to define parameter validation rules for all of your routes and enforces them as defined in your JSON-schema like configuration. It leverages Ajvs superb performance qualities to efficiently validate route parameters against a compiled set of your custom validation rules.

You can install koa-ajv directly via NPM:

npm install koa-ajv

Examples

To validate parameters, you need to provide a JSON-schema definition for each route. A simple example:


const KoaAjv = require('koa-ajv');

const routes = {
  '/my/test/route/:param': {
    param: {
      type: 'string'
    }
  }
};

// Returns the validator middleware
KoaAjv({routes: routes});

You can use all directives supported by JSON-schema. To distinguish between request methods (defaults to GET), prefix your route validation definition with the request method:

{
  'POST /my/test/route': {
    param: {
      type: 'string',
      maxLength: 8
    }
  }
}

If the validation succeeds, filtered params are available in ctx.vparams and the request is passed downstream. Should the validation fail the middleware throws an error:

ctx.throw(400, 'validation error', ...);

The error object will contain validationErrors object with full details about the error. You should catch this error upstream and handle accordingly.

See some more examples

Configuration

The middleware accepts the following configuration options (default values here):


// Strict mode: require all routes to have their validation
// rules defined
strict: true,

// Log debug information
debug: false,

// Show extended error information. extended=false formats
// the errors into human-readable strings
extended: true,

// Routes config
routes: {},

// Additional config passed directly to 'ajv'
// See 'ajv' on NPM for further reference
validator: {

// Support v5 JSON schemas
  v5: true,

// Set to true to return all validation errors before failing
  allErrors: false,

// Parameters are coerced to their expected types
  coerceTypes: true,

// Omit all additional parameters not defined in route config
  removeAdditional: 'all',
}