fastify-plugin
Advanced tools
Package description
The fastify-plugin npm package is designed to facilitate the creation of plugins for the Fastify web framework. It ensures that plugins adhere to specific conventions and are compatible with the Fastify ecosystem. This package helps in encapsulating functionality, adding hooks, decorators, and more, in a way that's easily reusable across different Fastify projects.
Plugin Creation
This feature allows developers to create a Fastify plugin. The code sample demonstrates how to use fastify-plugin to decorate the Fastify instance with a new function called 'utility'.
const fp = require('fastify-plugin');
async function myPlugin (fastify, options) {
fastify.decorate('utility', () => 'something useful');
}
module.exports = fp(myPlugin);Plugin Options
This feature enables passing options to the plugin, including specifying Fastify version compatibility. The code sample shows how to pass data through options and use it within the plugin.
const fp = require('fastify-plugin');
async function myPlugin (fastify, options) {
fastify.decorate('usefulData', options.data);
}
module.exports = fp(myPlugin, { name: 'myPlugin', fastify: '3.x' });Encapsulation
This feature ensures that the plugin does not encapsulate its context, allowing the decorators, hooks, and changes made by the plugin to be available in the parent scope. The code sample demonstrates registering another plugin within a fastify-plugin, ensuring dependencies are managed.
const fp = require('fastify-plugin');
async function myPlugin (fastify, options) {
fastify.register(require('some-other-plugin'), options);
}
module.exports = fp(myPlugin, { dependencies: ['some-other-plugin'] });Provides decorators for Fastify, aiming to simplify the creation of controllers, services, and plugins. While it offers a different approach by leveraging TypeScript decorators, it shares the goal of enhancing Fastify's extensibility.
A plugin to add middleware support to Fastify. While fastify-plugin is a tool for creating Fastify plugins, middie focuses specifically on enabling the use of Express/Connect-style middleware within Fastify applications.
Automatically loads plugins and routes, simplifying the application structure. Unlike fastify-plugin, which is about creating plugins, fastify-autoload helps in organizing and loading them efficiently in a Fastify application.
Readme
fastify-plugin is a plugin helper for Fastify.
When you build plugins for Fastify and you want that them to be accessible in the same context where you require them, you have two ways:
skip-override hidden propertyfastify-plugin can do three things for you:
skip-override hidden propertyExample:
const fp = require('fastify-plugin')
module.exports = fp(function (fastify, opts, next) {
// your plugin code
next()
})
In addition if you use this module when creating new plugins, you can declare the dependencies, the name and the expected Fastify version that your plugin needs.
If you need to set a bare-minimum version of Fastify for your plugin, just add the semver range that you need:
const fp = require('fastify-plugin')
module.exports = fp(function (fastify, opts, next) {
// your plugin code
next()
}, { fastify: '1.x' })
If you need to check the Fastify version only, you can pass just the version string.
You can check here how to define a semver range.
Fastify uses this option to validate dependency graph. On one hand it makes sure that no name collision occurs. On the other hand it makes possible to perform dependency check.
const fp = require('fastify-plugin')
function plugin (fastify, opts, next) {
// your plugin code
next()
}
module.exports = fp(plugin, {
fastify: '1.x',
name: 'your-plugin-name'
})
You can also check if the plugins and decorators which your plugin intend to use are present in the dependency graph.
Note: This is the point where registering
nameof the plugins become important, because you can referenceplugindependencies by their name.
const fp = require('fastify-plugin')
function plugin (fastify, opts, next) {
// your plugin code
next()
}
module.exports = fp(plugin, {
fastify: '1.x',
decorators: {
fastify: ['plugin1', 'plugin2'],
reply: ['compress']
},
dependencies: ['plugin1-name', 'plugin2-name']
})
This project is kindly sponsored by:
Licensed under MIT.
FAQs
Plugin helper for Fastify
The npm package fastify-plugin receives a total of 1,487,705 weekly downloads. As such, fastify-plugin popularity was classified as popular.
We found that fastify-plugin demonstrated a healthy version release cadence and project activity because the last version was released less than a year ago. It has 8 open source maintainers collaborating on the project.
Did you know?
Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.
Security News
A hospital in Mobile, Alabama, agreed to a settlement in a landmark ransomware death lawsuit, but is now reportedly reconsidering the agreement and refusing to pay.
Security News
A new report explores how advancements in LLMs are enhancing cyber threats, including polymorphic malware, personalized spearphishing, and the risk of hijacking customer service bots.
Security News
ESLint has approved an RFC that adds support for TypeScript configuration files, which is aimed at improving the developer experience and recognizing changes in the evolving JavaScript ecosystem.