README.md

fastify-referrer-policy

Fastify plugin to set the Referrer-Policy HTTP header

Why?

You may know referrer-policy as a referrer-policy middleware used in helmet. And you could use it as a middleware in fastify also. So why i made this plugin?

You may find the reason in benchmark result and wish you like it. :)

Difference

This plugin has passed all referrer-policy test cases. And no difference in options.

Install

Via npm:

npm i fastify-referrer-policy

Via yarn:

yarn add fastify-referrer-policy

Usage

const fastify = require('fastify');
const fastifyReferrerPolicy = require('fastify-referrer-policy');

const app = fastify();
app.register(fastifyReferrerPolicy);

app.listen(3000, err => {
  if (err) throw err;
});

Options

This plugin has the same options as the middleware in helmet.

policy {string}

Set Referrer-Policy to this value if it's a valid one. Default is no-referrer. Will use default value for any invalid input. Valid list:

• no-referrer
• no-referrer-when-downgrade
• same-origin
• origin
• strict-origin
• origin-when-cross-origin
• strict-origin-when-cross-origin
• unsafe-url

You could read the spec for more information.

Changelog

• 0.3.0
  • Fix can't set empty string
  • Update test case
• 0.2.0
  • Add test case
  • Add code coverage
  • Add benchmarks
• 0.1.0:
  • Init version