supervizor

supervizor

Server-level request payload validation for hapi.

Table of Contents

• Installation
• Usage
  • Example

Installation

Install via NPM.

$ npm install supervizor

Usage

Register the package as a server plugin and provide a validation function via the options that will be attached to each route.

If the validation fails, a joi-like 400 Bad Request error is returned alongside an additional content-validation: failure response header. If everything is ok, the response will ultimately contain a content-validation: success header.

Example

const Hapi = require('hapi');
const Supervizor = require('supervizor');

server = new Hapi.Server();
server.connection({
    // go nuts
});

const plugin = {
    register: Supervizor,
    options: {
        validator: (payload, options, next) => {
            // In this example, the payload must contain `valid: true`.
            if (!payload.valid) {
                // Be nice to everyone and provide details about the issue.
                const error = new Error('invalid payload');
                error.details = [{ path: 'valid' }];

                return next(error);
            }

            // Be nice to yourself and allow further validation.
            next(null, payload);
        });
    }
};

server.register(plugin, (err) => {

    if (err) {
        throw err;
    }

    server.start(() => {
        // go nuts
    });
});

Changelog

v1.0.6 (2017-11-01)

Full Changelog

Merged pull requests:

• Update dependencies and badges #8 (ruiquelhas)