@turbo-tools/referrer-policy

@turbo-tools/referrer-policy

Pluggable Referrer-Policy header functionality for turbo-http based servers

Getting Started

const referrerPolicy = require('@turbo-tools/referrer-policy')

referrerPolicy(response, policy='no-referrer')

Does set the referrer-policyand defaults to 'no-referrer' if no policy argument is given.

Allowed policies

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

For more information on what each policy means, please consult the MDN page

Example

const referrerPolicy = require('@turbo-tools/referrer-policy')
referrerPolicy(response)

With turbo-http server

const http = require('turbo-http')
const referrerPolicy = require('@turbo-tools/referrer-policy')

// Create server
const server = http.createServer(function (req, res) {
  const text = 'Same origin policy set'
  referrerPolicy(response, 'same-origin')
  res.statusCode = 200
  res.setHeader('Content-Length', text.length)
  res.write(Buffer.from(text))
})

// Listen
server.listen(3000)

Installing

npm install @turbo-tools/referrer-policy --save

Running the tests

All tests are contained in the test.js file, and written using Jest

Run them:

npm test

If you´d like to get the coverage data in addition to runnign the tests, use:

npm run test-coverage

Built With

• NPM - Dependency Management
• Commitizen - Easy semantic commit messages
• Jest - Easy tests
• Semantic Release - Easy software releases

Contributing

Please read CONTRIBUTING.md for details on the process for submitting pull requests to us, and CODE_OF_CONDUCT.md for details on the code of conduct.

Versioning

We use SemVer for versioning. For the versions available, see the tags on this repository.

Authors

• Sebastian Golasch - Initial work - asciidisco

See also the list of contributors who participated in this project.

License

This project is licensed under the MIT License - see the LICENSE.md file for details

Acknowledgments

• Hat tip to @mafintosh for building turbo-net and turbo-http