Nearly-Pickled Module

    hapi-joier

    1.1.0 • Public • Published

    Hapi Joier

    Coverage Status Travis

    Better Joi error messages for your 400 responses.

    Usage

    Just register hapi-joier and be hapi.

    server.register({
      register: require('hapi-joier'),
      options: {
        enable: true
      }
    })

    Now your 400 replies should have better information about the invalid data.

    {
      "statusCode":400,
      "error":"Bad Request",
      "message":"child \"name\" fails because [\"name\" length must be at least 10 characters long]",
      "validation":[
        {
          "message":"\"name\" length must be at least 10 characters long",
          "path":"name",
          "type":"string.min",
          "context":{
            "limit":10,
            "key":"name"
          }
        }
      ]
    }

    As you can see, we can now detect which test failed, this is much better to display the correct error message in the frontend.

    Installation

    Install this module with the command npm install --save hapi-joier, after that you are ready to register this module as a Hapi plugin.

    Testing

    Type the following lines inside your command line.

    git clone git@github.com:alanhoff/node-hapi-joier.git
    cd node-hapi-joier
    npm install
    npm test

    Configuration

    Every configuration can be made when you server.register or individually on each route.

    • enable Boolean Enable hapi-joier, if used in the server.register it will enable the plugin for every route. Default: false
    • map Function The function used to construct each validation object inside de response. It receives a Joi detail as the first parameter.

    Examples

    Enable hapi-joi for only one route:

    // Do not pass "enable" as a option, so it won't be globally enabled
    server.register(require('hapi-joi'), function()...);
    
    server.route({
      method: 'GET',
      path: '/upload',
      method: function(request, reply){
        reply('Hello world!');
      },
      config: {
        plugins: {
          joier: {
            enable: true
          }
        }
      }
    });

    Change the response object with a custom map

    // Do not pass "enable" as a option, so it won't be globally enabled
    server.register(require('hapi-joi'), function()...);
    
    server.route({
      method: 'GET',
      path: '/upload',
      method: function(request, reply){
        reply('Hello world!');
      },
      config: {
        plugins: {
          joier: {
            enable: true,
            map: function(detail){
              return 'Something is wrong with ' + detail.path;
            }
          }
        }
      }
    });

    Enable Joier for all routes and intercept every Bomm + Joi response:

    server.register({
      register: require('hapi-joi'),
      options: {
        enable: true
      }
    }, function()...);

    License MIT

    Copyright (c) 2015, Alan Hoffmeister alanhoffmeister@gmail.com

    Permission to use, copy, modify, and distribute this software for any purpose with or without fee is hereby granted, provided that the above copyright notice and this permission notice appear in all copies.

    THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.

    Keywords

    none

    Install

    npm i hapi-joier

    DownloadsWeekly Downloads

    9

    Version

    1.1.0

    License

    ISC

    Last publish

    Collaborators

    • alanhoff