Electrode Hapi 16/17/18 utility
npm install electrode-hapi-compatA utility function that detects the Hapi version and return the appropriate plugin function.
Hapi 17 changed the signature of Plugins. This utility provides a simple wrapper for your plugin to support both Hapi 16 and Hapi 17+.
If you have module that can export plugins for hapi 16 or 17+, you can use the API universalHapiPlugin to let this module automatically determine which of your plugins to use depending on the version of Hapi detected.
``js
const {universalHapiPlugin} = require("electrode-hapi-compat");
const registers = {
hapi16: (server, options, next) => {...},
hapi17OrUp: (server, options) => {...}
};
const pkg = {
name: "MyPackage",
version: "1.0.0"
};
module.exports = universalHapiPlugin(registers, pkg);
`
`js
const { isHapi17OrUp } = require("electrode-hapi-compat");
if (isHapi17OrUp()) {
// hapi 17 or @hapi/hapi >= 18
} else {
// hapi 16
}
`
`js
// this is to identify if @hapi/hapi v18 and above
const { isHapi18OrUp } = require("electrode-hapi-compat");
if (isHapi18OrUp()) {
// @hapi/hapi >= 18
} else {
// hapi 16/17
}
`
If you need to manually force a certain version of Hapi for testing etc,
you can manually set the Hapi major version this module should use with the hapiVersion property:
`js
// Set to use Hapi major version 18
require("electrode-hapi-compat").hapiVersion = 18;
// Get Hapi major version
const hapiVersion = require("electrode-hapi-compat").hapiVersion;
`
`bash`
$ npm install --save electrode-hapi-compat
1. Clone this repo
2. Make updates
3. Run tests (requires 100% test coverage)
4. Submit PR
5. Sign CLA
To run tests
`bash`
$ npm run test
1. Run npm version to bump the version.CHANGELOG.md
2. Update the npm publish
3. Make sure your npmrc is pointing to external npm.
4. Run (make sure you have permission to github and npm).git push origin master --tags` to commit changes.
5. Run
Built with :heart: by Team Electrode @WalmartLabs.
[hapi]: https://www.npmjs.com/package/hapi