When you build plugins for Fastify and you want them to be accessible in the same context where you require them, you have two ways:
Use the skip-override hidden property
Use this module
Note: the v4.x series of this module covers Fastify v4Note: the v2.x & v3.x series of this module covers Fastify v3. For Fastify v2 support, refer to the v1.x series.
Install
npm i fastify-plugin
Usage
fastify-plugin can do three things for you:
Add the skip-override hidden property
Check the bare-minimum version of Fastify
Pass some custom metadata of the plugin to Fastify
const fp = require('fastify-plugin')// A callback function param is not required for async functionsmodule.exports = fp(async function (fastify, opts) { // Wait for an async function to fulfill promise before proceeding await exampleAsyncFunction()})
Metadata
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.
Fastify version
If you need to set a bare-minimum version of Fastify for your plugin, just add the semver range that you need:
Fastify uses this option to validate the dependency graph, allowing it to ensure that no name collisions occur and making it possible to perform dependency checks.
By default, fastify-plugin breaks the encapsulation but you can optionally keep the plugin encapsulated.
This allows you to set the plugin's name and validate its dependencies without making the plugin accessible.
TypeScript can sometimes infer the types of the arguments for these functions. Plugins in Fastify are recommended to be typed using either FastifyPluginCallback or FastifyPluginAsync. These two definitions only differ in two ways:
The third argument done (the callback part)
The return type FastifyPluginCallback or FastifyPluginAsync
At this time, TypeScript inference is not smart enough to differentiate by definition argument length alone.
Thus, if you are a TypeScript developer please use on the following patterns instead:
// Callback// Assign type directlyconst pluginCallback: FastifyPluginCallback = (fastify, options, done) => { }fp(pluginCallback)// or define your own function declaration that satisfies the existing definitionsconst pluginCallbackWithTypes = (fastify: FastifyInstance, options: FastifyPluginOptions, done: (error?: FastifyError) => void): void => { }fp(pluginCallbackWithTypes)// or inlinefp((fastify: FastifyInstance, options: FastifyPluginOptions, done: (error?: FastifyError) => void