koa-req-validation

!Node.js CI
!Libraries.io dependency status for latest release

A [validator][validator-site] middleware for [koa][koa-site]. Inspired by [express-validator][express-validator-site].

- koa-req-validation
- Installation
- Getting started
- Documentation
- Issues
- Changelog
- Contribution
- Licence

Installation

The koa-req-validation requires [validator][validator-site], [@koa/router][koa-router-site] and [koa-bodyparser][koa-bodyparser-site] as peer dependencies.

Install peer dependencies

``
npm install validator@13 koa-bodyparser@4 @koa/router@10
`

Install koa-req-validation

`
npm install koa-req-validation
`

Getting started

A basic usage example

`typescript
import Router, { RouterContext } from "@koa/router";
import { query, validationResults } from "koa-req-validation";

// ...

const router = new Router();

router.get(
"/api/hello",
query("name")
.isLength({ min: 3, max: 20 })
.withMessage("The name has to be between 3 and 20 characters")
.build(), // <-- This is required at the end of each validation
async (ctx: RouterContext) => {
const result = validationResults(ctx);
if (result.hasErrors()) {
throw new RequestError(422, result.mapped());
}
const { name } = ctx.query;
ctx.body = Hello ${name};
}
);
`

See the [demo][demo-link] for other examples.

Documentation

This module offers various validation and sanitation functions. Please note the following things:

- Nested objects can now be validated
- Support has been added to the ValidationResult.passedData() output as well
- The order matters
- The validations and sanitations are being run in order they've been called in the validation chain
- No sanitations are run for a chain after some of the validations has failed
- This is due to the fact that some of the sanitizers rely on "valid" value (for example valid email address)
- The sanitized values can be accessed only through ValidationResult.passedData()
- The request body is treated as immutable in the validation middleware

`typescript
const result = validationResults(ctx);
if (result.hasErrors()) {
throw new RequestError(422, result.mapped());
}
const passed = result.passedData();
``

See the [generated TypeDoc][typedocs] and [ValidationChain][validation-chain] for API documentation.

Issues

We use [GitHub][issue-site] for issue tracking. Please look from [previously submitted issues][issue-all-filter-site] if someone else has already submitted the same issue.

Changelog

Please see [releases][releases-site].

Contribution

All contributions to the project are welcome.

Licence

[ISC Licence][licence-link]

[demo-link]: https://github.com/ppeerttu/koa-req-validation/blob/master/demo/index.ts
[licence-link]: https://github.com/ppeerttu/koa-req-validation/blob/master/LICENCE
[typedocs]: https://ppeerttu.github.io/koa-req-validation/
[validation-chain]: https://ppeerttu.github.io/koa-req-validation/classes/lib_validationchain.default.html
[issue-site]: https://github.com/ppeerttu/koa-req-validation/issues
[issue-all-filter-site]: https://github.com/ppeerttu/koa-req-validation/issues?utf8=%E2%9C%93&q=is%3Aissue
[releases-site]: https://github.com/ppeerttu/koa-req-validation/releases
[koa-site]: https://koajs.com/
[koa-router-site]: https://github.com/koajs/router
[koa-bodyparser-site]: https://github.com/koajs/bodyparser
[validator-site]: https://github.com/chriso/validator.js
[express-validator-site]: https://github.com/express-validator/express-validator