Hapijs – Plugins

hapi has dozens of plugin system. like ,

Authentication, Documentation, Localization/Internationalization, Logging/Metrics, Messaging, Security, Session, Templating, Utility, Validation….

– you can write your own plugin.
– plugins are objects with a register function, and has a signature function (server, options, next).
– register function has an attributes object.
– this object provides some additional information about the plugin, such as name and version.

let’s see an example

[cc lang=”‘javascript”]

var pluginName = {
register: function (server, options, next) {
next();
}
};
pluginName.register.attributes = { 7 name: ‘pluginName’,
version: ‘1.0.0’
};

[/cc]
– In register methods, three parameters pass
– server object is a reference to that is being loaded in server.
– The options parameter whatever options the user passes it is passed directly to your register method.
– next method called when your plugin has completed. This method accepts only one parameter, err, if an error occurred while registering of.
– and if when you written plugin as an external module:

[cc lang=”‘javascript”]
exports.register = function (server, options, next) {
next();
};
exports.register.attributes = {
pkg: require(‘./package.json’)
};
[/cc]

Loading a plugin

– Plugins can be loaded using “server.register()“ method,
– one at a time, or as a group in an array. for example ,

[cc lang=”‘javascript”]
// load one plugin server.register(require(‘pluginName’), function (err) { if (err) { console.error(‘Failed to load plugin:’, err); } });

// load multiple plugins server.register([require(‘pluginName1’), require(‘pluginName2’)], function (err) { if (err) { console.error(‘Failed to load a plugins :’, err); } });
[/cc]

you can pass options to your plugin, with register and options keys, such as:

[cc lang=”‘javascript”]
server.register({
register: require(‘pluginName’),
options: {
message: ‘hello’
}
}, function (err) {
});
[/cc]

Or you can pass object using array also.
[cc lang=”‘javascript”]
server.register([{
register: require(‘plugin1’),
options: {}
}, {
register: require(‘plugin2’),
options: {}
}], function (err) {
});
[/cc]

plugins options

-if You want to pass an optional parameter to server.register() you can pass it, before the callback.
– These options object is used by hapi.
– and is not passed to the plugin(s) being loaded.
– It allows you to pre-select servers based on one or more labels,
– as well as apply vhost or prefix modifiers to any routes that your plugins register.

For example, let’s say we have a plugin that looks like this:

[cc lang=”‘javascript”]
exports.register = function (server, options, next) {
server.route({
method: ‘GET’,
path: ‘xyz’,
handler: function (request, reply) {
reply(‘run’);
}
});
next();
};
exports.register.attributes = {
pkg: require(‘./package.json’)
};
[/cc]
When this plugin is loaded a new route is created at /xyz. You can changed this by using option’s prefix setting, which will prepend a string to all routes created in the plugin:

[cc lang=”‘javascript”]
server.register({ register: require(‘pluginName’) }, {
routes: {
prefix: ‘/plugins’
}
}, function (err) {
});
[/cc]

When the plugin is load completly, the GET route will be created at /plugins/Name.

The select parameter works exactly the same way as server.select() does, in that you may pass one label or an array of labels for the plugin to be associated with.

[cc lang=”‘javascript”]

server.register({ register: require(‘pluginName’) }, {
select: [‘webserver’, ‘admin’]
}, function (err) {
});

[/cc]

This allows you to attach a plugin to specific connections in a server without having to change the code of the plugin.


by

Comments

One response to “Hapijs – Plugins”

  1. At the beginning, I was still puzzled. Since I read your article, I have been very impressed. It has provided a lot of innovative ideas for my thesis related to gate.io. Thank u. But I still have some doubts, can you help me? Thanks.

Recent Post

  • Linguistics and NLP: Enhancing AI Chatbots for Multilingual Support

    In today’s interconnected world, businesses and individuals often communicate across linguistic boundaries. The growing need for seamless communication has driven significant advancements in artificial intelligence (AI), particularly in natural language processing (NLP) and linguistics. AI chatbots with multilingual support, are revolutionizing global customer engagement and service delivery. This blog explores how linguistics and NLP are […]

  • How Reinforcement Learning is Shaping the Next Generation of AI Chatbots?

    AI chatbots are no longer just about answering “What are your working hours?” or guiding users through FAQs. They’re becoming conversation partners, problem solvers and even reporting managers and sales agents. What’s driving this transformation? Enter Reinforcement Learning (RL)—a type of machine learning that’s changing the way chatbots think, learn, and respond. At Codalien Technologies, […]

  • AI Chatbots for Sales Team Automation: The Critical Role of AI Sales Assistants in Automating Your Sales Team

    Sales teams are the heart of any successful business, but managing them effectively can often feel like trying to juggle flaming swords. The constant pressure to generate leads, maintain relationships, and close deals leaves your team overwhelmed, spending more time on administrative tasks than actual selling. Here’s where AI-powered sales assistants step in to completely […]

  • Transforming HR with AI Assistants: The Comprehensive Guide

    The role of Human Resources (HR) is critical for the smooth functioning of any organization, from handling administrative tasks to shaping workplace culture and driving strategic decisions. However, traditional methods often fall short of meeting the demands of a modern, dynamic workforce. This is where our Human Resource AI assistants enter —a game-changing tool that […]

  • How Conversational AI Chatbots Improve Conversion Rates in E-Commerce?

    The digital shopping experience has evolved, with Conversational AI Chatbots revolutionizing customer interactions in e-commerce. These AI-powered systems offer personalized, real-time communication with customers, streamlining the buying process and increasing conversion rates. But how do Conversational AI Chatbots improve e-commerce conversion rates, and what are the real benefits for customers? In this blog, we’ll break […]

  • 12 Essential SaaS Metrics to Track Business Growth

    In the dynamic landscape of Software as a Service (SaaS), the ability to leverage data effectively is paramount for long-term success. As SaaS businesses grow, tracking the right SaaS metrics becomes essential for understanding performance, optimizing strategies, and fostering sustainable growth. This comprehensive guide explores 12 essential SaaS metrics that every SaaS business should track […]

Click to Copy