ensure-request

4.0.0 • Public • Published

ensure-request

Validation for API requests

npm version Codeship Status for stevejay/ensure-request Coverage Status bitHound Overall Score bitHound Dependencies bitHound Dev Dependencies

NPM

Install

$ npm install --save ensure-request

Usage

const ensure = require('ensure-request');
 
const constraint = {
    name: {
        presence: true,
        string: true
    }
};
 
const request = {
    name: 123
};
 
// You can get a return value...
const errors = ensure(request, constraint); // null if no errors, an object of errors if not
 
// ... or pass an error handler function.
ensure(request, constraint, errors => { /* do what you like here, like throw */});

API

ensure(object, constraint)

Validates object according to the constraint object, throwing an Error exception if validation fails.

object

Type: Object

The object to validate.

constraint

Type: Object

The constraint object that specifies the constraints to apply to the object.

License

MIT

Acknowledgements

This package was heavily influenced by the package Validate.js. This package takes a different approach to how it walks nested objects and arrays, and how constraints are specified for them both.

Readme

Keywords

Package Sidebar

Install

npm i ensure-request

Weekly Downloads

1

Version

4.0.0

License

MIT

Last publish

Collaborators

  • middleengine