negotiator
An HTTP content negotiator for Node.js
Installation
$ npm install negotiator
API
var Negotiator = require('negotiator')
Accept Negotiation
availableMediaTypes = ['text/html', 'text/plain', 'application/json']
negotiator = new Negotiator(request)
negotiator.mediaTypes()
negotiator.mediaTypes(availableMediaTypes)
negotiator.mediaType(availableMediaTypes)
You can check a working example at examples/accept.js
.
Methods
mediaTypes(availableMediaTypes):
Returns an array of preferred media types ordered by priority from a list of available media types.
mediaType(availableMediaType):
Returns the top preferred media type from a list of available media types.
Accept-Language Negotiation
negotiator = new Negotiator(request)
availableLanguages = 'en', 'es', 'fr'
negotiator.languages()
negotiator.languages(availableLanguages)
language = negotiator.language(availableLanguages)
You can check a working example at examples/language.js
.
Methods
languages(availableLanguages):
Returns an array of preferred languages ordered by priority from a list of available languages.
language(availableLanguages):
Returns the top preferred language from a list of available languages.
Accept-Charset Negotiation
availableCharsets = ['utf-8', 'iso-8859-1', 'iso-8859-5']
negotiator = new Negotiator(request)
negotiator.charsets()
negotiator.charsets(availableCharsets)
negotiator.charset(availableCharsets)
You can check a working example at examples/charset.js
.
Methods
charsets(availableCharsets):
Returns an array of preferred charsets ordered by priority from a list of available charsets.
charset(availableCharsets):
Returns the top preferred charset from a list of available charsets.
Accept-Encoding Negotiation
availableEncodings = ['identity', 'gzip']
negotiator = new Negotiator(request)
negotiator.encodings()
negotiator.encodings(availableEncodings)
negotiator.encoding(availableEncodings)
You can check a working example at examples/encoding.js
.
Methods
encodings(availableEncodings):
Returns an array of preferred encodings ordered by priority from a list of available encodings.
encoding(availableEncodings):
Returns the top preferred encoding from a list of available encodings.
License
MIT