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

  • How to Implement File Uploads in Node.js with Multer?

    For many web applications that let users share papers, photos, and other types of material, file uploads are a necessary functionality. Multer is a well-liked middleware used for Handling file uploads in Node.js using Multer middleware.in the Node.js environment to effectively handle file uploads. We’ll look at how to use Multer to create file uploads […]

  • How to Use Local Storage to Persist Data in a JavaScript Application?

    Data persistence is a key aspect of web applications. In JavaScript, one of the primary tools for achieving this is Local Storage, a part of the Web Storage API. This JavaScript data persistence tool provides a simple key-value storage mechanism within the user’s browser. Unlike session storage, which persists data only during a session, Local […]

  • How to Use WordPress API?

    WordPress stands out as a leading content management system, celebrated for its dynamic capabilities in website and blog development. Renowned for its rich feature set and extensive customization options, WordPress empowers creators to fashion captivating online experiences. In recent times, WordPress has expanded its horizons into the realm of APIs, granting developers a potent tool […]

  • How to Use Post and Pre Hooks in Mongoose?

    In Mongoose, a widely-used library for working with MongoDB, there are valuable tools called “Pre and Post Hooks.” These hooks, also known as “Mongoose Middleware” or “Mongoose Model Hooks,” allow developers to run their own code just before or after specific actions on the database. With “Pre Hooks,” you can customize actions before they happen, […]

  • How To Create Reusable Components in React: Best Practices

    Rеact is a popular library for building usеr intеrfacеs with JavaScript. One of the main benefits of Rеact is its ability to create reusable componеnts that can be used in different parts of your application. Reusable componеnts can help you savе timе, rеducе codе duplication, and еnsurе consistеncy in your UI. However, creating rеusablе componеnts […]

  • Implementing Higher Order Components in Class-Based Components for Code Reusability in ReactJS

    Rеact is a powerful library for building usеr intеrfacеs, and one of its corе strengths liеs in its componеnt-basеd architеcturе. Componеnts arе thе building blocks of Rеact applications, and thеy allow you to crеatе modular and rеusablе piеcеs of UI. Howеvеr, as your application grows, you may find thе nееd for rеusing cеrtain functionalitiеs across […]