https://github.com/idiocc/vary
[fork] Manipulate the HTTP Vary header
https://github.com/idiocc/vary
Last synced: about 1 year ago
JSON representation
[fork] Manipulate the HTTP Vary header
- Host: GitHub
- URL: https://github.com/idiocc/vary
- Owner: idiocc
- License: other
- Created: 2019-04-20T10:43:41.000Z (about 7 years ago)
- Default Branch: master
- Last Pushed: 2019-04-20T12:00:33.000Z (about 7 years ago)
- Last Synced: 2025-04-03T13:13:29.147Z (about 1 year ago)
- Language: JavaScript
- Homepage: https://idio.cc
- Size: 35.2 KB
- Stars: 1
- Watchers: 0
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
README
# @goa/vary
[](https://npmjs.org/package/@goa/vary)
`@goa/vary` is a [fork](https://github.com/jshttp/vary) of Manipulate the HTTP Vary header rewritten in ES6 Modules.
```sh
yarn add @goa/vary
```
The original module has been updated to be used in [`@goa/koa`](https://artdecocode.com/goa/): _Koa_ web server compiled with _Google Closure Compiler_ using [**Depack**](https://artdecocode.com/depack/) into a single file library (0 dependencies).
## Table Of Contents
- [Table Of Contents](#table-of-contents)
- [API](#api)
- [`vary(res: http.ServerResponse, field: string|Array)`](#varyres-httpserverresponsefield-stringarraystring-void)
- [`append(header: string, field: string|Array): string`](#appendheader-stringfield-stringarraystring-string)
- [Copyright](#copyright)
## API
The package is available by importing its default and named functions:
```js
import vary, { append } from '@goa/vary'
```
## `vary(`
`res: http.ServerResponse,`
`field: string|Array,`
`): void`
Adds the given header `field` to the _Vary_ response header of `res`. This can be a string of a single field, a string of a valid _Vary_ header, or an array of multiple fields.
This will append the header if not already listed, otherwise leaves it listed in the current location.
```js
/* alanode example/ */
import vary from '@goa/vary'
import aqt from '@rqt/aqt'
import { createServer } from 'http'
const server = createServer((req, res) => {
// about to user-agent sniff
vary(res, 'User-Agent')
var ua = req.headers['user-agent'] || ''
var isMobile = /mobi|android|touch|mini/i.test(ua)
// serve site, depending on isMobile
res.setHeader('Content-Type', 'text/html')
res.end('You are (probably) ' + (isMobile ? '' : 'not ') + 'a mobile user')
})
server.listen(async () => {
const url = `http://localhost:${server.address().port}`
const { headers } = await aqt(url)
console.log(headers)
server.close()
})
```
```js
{ vary: 'User-Agent',
'content-type': 'text/html',
date: 'Sat, 20 Apr 2019 11:57:51 GMT',
connection: 'close',
'content-length': '36' }
```
## `append(`
`header: string,`
`field: string|Array,`
`): string`
Adds the given header `field` to the _Vary_ response header string `header`. This can be a string of a single field, a string of a valid _Vary_ header, or an array of multiple fields.
This will append the header if not already listed, otherwise leaves it listed in the current location. The new header string is returned.
```js
append('Accept, User-Agent', 'Origin')
```
```js
import { append } from '@goa/vary'
// Get header string appending "Origin" to "Accept, User-Agent"
console.log(append('Accept, User-Agent', 'Origin'))
console.log(append('Accept-Encoding, Accept', '*'))
console.log(append('Accept-Encoding, Accept, *', 'Origin'))
```
```
Accept, User-Agent, Origin
*
*
```
## Copyright
Original Author: [Douglas Wilson](https://github.com/dougwilson)
---
© Art Deco for Idio 2019
Tech Nation Visa Sucks
