hapi-async-routes

Introduction

This plugin is used to solve 2 problems.

1. Use async function as handler instead of thunk. Therefore, you can use await/ yield inside your handler without any wrapper.

2. server.route by scanning directory.

Install

npm install --save hapi-async-routes

The traditional way of route config used by Hapi

The route config

```javascript { method: 'GET', path: '/hello', config: { handler: function (request, reply) { reply('Hello World!'); } } }; ```

With this plugin, you can write like this (with babel-register and preset es2015 or es2015-node5).

```javascript { method: 'GET', path: '/hello', config: { handler: { async: async function (request, reply) { reply('Hello World!'); } } } }; ``` or ```javascript { method: 'GET', path: '/hello', config: { handler: { async: Promise.coroutine(function *(request, reply) { // If you are using native Promise, you may use co.wrap instead reply('Hello World!'); } } } }; ```

With this plugin, we don't have to wrap our function to support await or yield to prevent callback hell.

## Options

routes (Optional): This is the array of dir path you want to scan the routes, it is much convenient if you don't want to server.route manually.

The file inside the directory should module.exports or export default the following

1. A route config instance

2. An array of route config instance

Example:

```javascript module.exports = [ { method: 'GET', path: '/hello', config: { handler: { async: async function (request, reply) { const asyncHello = async function() { return 'Hello World!'; }; reply(await asyncHello()); } } } }, { method: 'GET', path: '/bye', config: { handler: { async: async function (request, reply) { const asyncBye = async function() { return 'Good Bye!'; }; reply(await asyncBye()); } } } }, { method: 'GET', path: '/error', config: { handler: { async: async function () { throw Error('error'); } } } } ]; ```

handlerName (Optional): This is the custom handler name, default is async

For example, if changed to "promise", your handler would be like ```javascript { method: 'GET', path: '/hello', config: { handler: { promise: async function (request, reply) { reply('Hello World!'); } } } }; ```

defaultErrorHandler (Optional): This is the default error handler which is a function accepts

err: the error thrown from the async handler
request: the request object
reply: the reply object
If not specified, The default error handler is like that
```javascript function (err, request, reply) { reply(err); } ```

Example

Please visit the test case for example reference.

Example usage

LICENSE

The MIT License (MIT)

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

hapi-async-routes