houdin

houdin

Route-level file type validation for hapi parsed in-memory multipart/form-data request payloads. Also works as a standalone module.

Table of Contents

• Installation
• Usage
  • validate(payload, options, fn)
    • Hapi
    • Standalone
• Supported File Types

Installation

Install via NPM.

$ npm install houdin

Usage

validate(payload, options, fn)

Validates all Buffer values in a payload given a whitelist of file types provided in the options. Results in a joi-like ValidationError if some file type is not allowed or unknown otherwise it returns the original parsed payload to account for additional custom validation.

Hapi

const Hapi = require('hapi');
const Houdin = require('houdin');

const server = new Hapi.Server({
    routes: {
        validate: {
            options: {
                whitelist: ['image/png']
            }
        }
    }
});

server.route({
    options: {
        validate: {
            // override the default `failAction` if you want further
            // details about the validation error
            failAction: (request, h, err) => {
                // throw the error as is
                throw err;
            },
            payload: Houdin.validate
        },
        payload: {
            output: 'data',
            parse: true
        }
    }
});

Standalone

const Houdin = require('houdin');

const options = { whitelist: ['image/png'] };
const png = Buffer.from('89504e470d0a1a0a', 'hex');

const payload = Houdin.validate({ file: png }, options);

console.log(payload); // { file: <Buffer 89 50 4e 47 0d 0a 1a 0a> }

const Houdin = require('houdin');

const options = { whitelist: ['image/png'] };
const gif = Buffer.from('474946383761', 'hex');

try {
    Houdin.validate({ file: gif }, options);
}
catch (err) {
    console.log(err); // [ValidationError: child "file" fails because ["file" type is not allowed]]
}

Supported File Types

The same as file-type.

Changelog

v5.0.0 (2017-11-06)

Full Changelog

Closed issues:

• Support hapi v17 #33

Merged pull requests:

• Add package-lock.json to version control #38 (ruiquelhas)
• Add support for hapi v17 API #37 (ruiquelhas)