@ar4mirez/hapi-handlers


Plugin to autoload handlers for hapi.js based on glob patterns.

> Note: This package was previously published as hapi-handlers. The scoped package @ar4mirez/hapi-handlers is the actively maintained version.

Requirements

- Node.js >= 18.0.0
- @hapi/hapi >= 21.0.0

Installation

``bash
npm install @ar4mirez/hapi-handlers
`

Usage

$3

`javascript
const Hapi = require('@hapi/hapi');

const init = async () => {
const server = Hapi.server({ port: 3000 });

await server.register({
plugin: require('@ar4mirez/hapi-handlers'),
options: {
includes: 'path/to/*/Handler.js'
}
});

// Your handlers are now available
server.route({
method: 'GET',
path: '/hello',
handler: {
helloHandler: {
message: 'Hello World!'
}
}
});

await server.start();
console.log('Server running on %s', server.info.uri);
};

init();
`

$3

`javascript
await server.register({
plugin: require('@ar4mirez/hapi-handlers'),
options: {
includes: [
'handlers/*/.js',
'api/**/handler.js'
],
ignores: ['*/.test.js']
}
});
`

$3

`javascript
const manifest = {
server: {
port: 3000
},
register: {
plugins: [
{
plugin: '@ar4mirez/hapi-handlers',
options: {
includes: 'handlers/*/.js',
relativeTo: __dirname
}
}
]
}
};
`

Options

$3

- Type: string | string[]
- Description: The glob pattern(s) to match handler files.

`javascript
// Single pattern
includes: 'handlers/*/.js'

// Multiple patterns
includes: ['handlers//*.js', 'api//handler.js']
`

$3

- Type: string | string[]
- Description: Pattern(s) to exclude from matching.

`javascript
ignores: ['/.test.js', '/.spec.js']
`

$3

- Type: string
- Default: process.cwd()
- Description: The base directory for resolving patterns.

`javascript
relativeTo: __dirname
`

Handler Signature

Handler files should export a function that returns a hapi handler function:

`javascript
// handlers/userHandler.js
'use strict';

module.exports = (route, options) => {
// route: the hapi route configuration
// options: options passed from route handler config

return (request, h) => {
return {
message: options.message || 'Default message',
user: request.params.id
};
};
};
`

$3

`javascript
server.route({
method: 'GET',
path: '/user/{id}',
handler: {
userHandler: {
message: 'User details'
}
}
});
`

$3

`javascript
module.exports = (route, options) => {
return async (request, h) => {
const user = await fetchUser(request.params.id);
return user;
};
};
`

Migration from v2/v3

Version 4.0.0 has breaking changes to support hapi v21+:

$3

`javascript
// v2/v3 (hapi v13-v16)
server.register({
register: require('@ar4mirez/hapi-handlers'),
options: { ... }
}, callback);

// v4 (hapi v21+)
await server.register({
plugin: require('@ar4mirez/hapi-handlers'),
options: { ... }
});
`

$3

`javascript
// v2/v3
module.exports = (route, options) => {
return (request, reply) => {
return reply({ message: 'Hello' });
};
};

// v4
module.exports = (route, options) => {
return (request, h) => {
return { message: 'Hello' };
// or: return h.response({ message: 'Hello' });
};
};
`

$3

`javascript
// v2/v3
const server = new Hapi.Server();
server.connection({ port: 3000 });

// v4
const server = Hapi.server({ port: 3000 });
``

Contributing

See CONTRIBUTING.md for guidelines.

License

MIT - see LICENSE for details.