2.9 KiB

Raw Blame History

fastify-plugin

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:

Use the skip-override hidden property
Use this module

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

Example:

const fp = require('fastify-plugin')

module.exports = fp(function (fastify, opts, next) {
  // your plugin code
  next()
})

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:

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.

Name

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'
})

Dependencies

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 name of the plugins become important, because you can reference plugin dependencies 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']
})

Acknowledgements

This project is kindly sponsored by:

License

Licensed under MIT.

2.9 KiB Raw Blame History