be-hapi v1.1.0

be-hapi

Decorated class-based controllers for Hapi with IoC support (like InversifyJS).

Installation

You can get latest release with type definitions from NPM:

npm install be-hapi reflect-metadata --save

be-hapi requires TypeScript >= 2.0 and the experimentalDecorators, lib and types compilation option.

{
    "compilerOptions": {
        "target": "es5",
        "lib": ["es6"],
        "types": ["reflect-metadata"],
        "module": "commonjs",
        "moduleResolution": "node",
        "experimentalDecorators": true
    }
}

Usage

Very basic usage:

1. Create your first controller class

//controller.ts
import { controller, get, param } from 'be-hapi'

@controller()
class HelloController {

  @get('/{name?}')
  public index(
    @param('name', 'You') name: string
  ) {
    return `Hi, ${name}!`
  }

}

2. Register the plugin with Hapi

// server.ts
import { Server } from '@hapi/hapi' 
import beHapi from 'be-hapi'

// import previously created controller
import './controller'

(async () => {
    const server = new Server({ port: 3000 })
    await server.register(beHapi)
    await server.start()
})()

Now, compile, start the app and go to http://localhost:3000/.

More examples

• simple app
• app with validation
• example usage with InversifyJS

API

Plugin options

Available decorators

Footnotes:

Class* - you can decorate controller with method decorators to set base route specification for all routes in decorated controller.

Helpers

useInversify(container) - returns plugin options to easy integrate InversifyJS. See example.