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');

server = new Hapi.Server();

server.connection({
    routes: {
        validate: {
            options: {
                whitelist: ['png']
            }
        }
    }
});

server.route({
    config: {
        validate: {
            payload: Houdin.validate
        },
        payload: {
            output: 'data',
            parse: true
        }
    }
});

Standalone

const Houdin = require('houdin');

const options = { whitelist: ['png'] };

Houdin.validate({ file: new Buffer([0x89, 0x50]) }, options, (err, value) => {

    console.log(err); // null
    console.log(value); // { file: <Buffer 89 50> }
});

Houdin.validate({ file: new Buffer([0x47, 0x49]) }, options, (err, value) => {

    console.log(err); // [ValidationError: child "file" fails because ["file" type is not allowed]]
    console.log(value); // undefined
});

Supported File Types

The same as magik.

Changelog

v1.1.1 (2015-12-19)

Full Changelog

Closed issues:

• Fix broken link in the contribution guidelines #6
• Add supported file types to the documentation #5
• Update documentation code style #4
• Update package keywords #3

Merged pull requests:

• Update package keywords #9 (ruiquelhas)
• Fix broken link in the contribution guidelines #8 (ruiquelhas)
• Update documentation #7 (ruiquelhas)