Skip to content

fastify/accept-negotiator

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

2 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

@fastify/accept-negotiator

CI NPM version js-standard-style

A negotiator for the accept-headers

Install

npm i @fastify/accept-negotiator

Usage

The module exports a function that you can use for negotiating an accept-header, e.g. accept-encoding. It takes 2 parameters:

negotiate(header, supportedValues)
  • header (string, required) - The accept-header, e.g. accept-encoding
  • supportedValues (string[], required) - The values, which are supported
const negotiate = require('@fastify/accept-encoding').negotiate
const encoding = negotiate('gzip, deflate, br', ['br'])
console.log(encoding) // 'br*

The module also exports a class that you can use for negotiating an accept-header, e.g. accept-encoding, and use caching for better performance.

Negotiate(supportedValues)
  • supportedValues (string[], required) - The values, which are supported
  • cache ({ set: Function; get: Function; has: Function }, optional) - A Cache-Store, e.g. ES6-Map or mnemonist LRUCache
const Negotiator = require('@fastify/accept-encoding').Negotiator
const encodingNegotiator = new Negotiator({ supportedValues: ['br'], cache: new Map() })

const encoding = encodingNegotiator.negotiate('gzip, deflate, br')
console.log(encoding) // 'br*

License

Licensed under MIT.