hapi-modularize
Helper for modular plugin based Hapi servers.
If your plugin is executed then it automatically starts a new server with the defined connections and server settings (with a generated glue manifest). If the plugin is required then it just exports the plugin (to be used in another server/connection).
Common use case
You create one repository/module/plugin with your browser-client application. Another one with your api. You can execute them independently or use them as plugins for a upper-level application.
Installation
npm install hapi-modularize
Usage
;
Creates a new Plugin where:
-
options
- the configuration where:-
attributes
- a plugin properties object. See http://hapijs.com/api#plugins -
pkg
- alternatively, theattributes.name
andattributes.version
can be included via thepkg
attribute containing the 'package.json' file for the module which already has the name and version included. -
server
- an object containing the options passed tonew Server([options])
-
connections
- an array of connection options, passed individually in calls toserver.connection([options])
-
register
- a plugin configuration object can have: * any option fromserver.register
options *options
- an object to use as the plugin options which get passed to the plugin's registration function when called. -
relativeTo
- a file-system path string that is used to resolve relative loading modules. -
preConnections
- a callback function that is called prior to adding connections to the server. The function signature isfunction (server, next)
where: -
server
- is the server object returned fromnew Server(options)
. -
next
- the callback function the method must call to return control over to glue -
prePlugins
- a callback function that is called prior to registering plugins with the server. The function signature isfunction (server, next)
where:server
- is the server object with all connections selected.next
- the callback function the method must call to return control over to glue
-
-
plugin
: a plugin is a function with the signaturefunction(server, options, next)
where:server
- the server object the plugin is being registered to.options
- an options object passed to the plugin during registration.next
- a callback method the function must call to return control back to the framework to complete the registration process with signaturefunction(error)
where:error
- any plugin registration error.
Examples
In this example, myApp
will listen on port 80
and will have client
and api
registered as plugins. But you can also execute client
or api
independently, and they will respectively listen on port 3000
and 3001
.
/client/index.js
// ES6 syntax /** * Import dependencies */;; /** * Connections configuration */const connections = port: 3000 labels: pkgname ; /** * Export plugin */pkg connections { // ... do something with your client plugin ;};
/api/index.js
// ES6 syntax /** * Import dependencies */; /** * Plugin attributes */const attributes = name: 'api' version: '1.0.0' /** * Connections configuration */const connections = port: 3001 labels: attributesname ; /** * Export plugin */attributes connections { // ... do something with your api plugin ;};
/production/myApp.js
var Glue = ; var manifest = connections: port: 80 labels: 'myApp' server: // ... some server options plugins: '../../api/index.js': // ... some plugin configuration '../../client/index.js': {} // ... some production specific plugins Glue;
Licence
The MIT License (MIT)
Copyright (c) 2015 Simon Degraeve
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.