Palak Handa / startUpJalsa-Backend

Blame view

node_modules/vary/README.md 2.65 KB
edit raw normal view history
f7563de62   Palak Handa   first commit 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
 
  # vary
  
  [![NPM Version][npm-image]][npm-url]
  [![NPM Downloads][downloads-image]][downloads-url]
  [![Node.js Version][node-version-image]][node-version-url]
  [![Build Status][travis-image]][travis-url]
  [![Test Coverage][coveralls-image]][coveralls-url]
  
  Manipulate the HTTP Vary header
  
  ## Installation
  
  This is a [Node.js](https://nodejs.org/en/) module available through the
  [npm registry](https://www.npmjs.com/). Installation is done using the
  [`npm install` command](https://docs.npmjs.com/getting-started/installing-npm-packages-locally): 
  
  ```sh
  $ npm install vary
  ```
  
  ## API
  
  <!-- eslint-disable no-unused-vars -->
  
  ```js
  var vary = require('vary')
  ```
  
  ### vary(res, field)
  
  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.
  
  <!-- eslint-disable no-undef -->
  
  ```js
  // Append "Origin" to the Vary header of the response
  vary(res, 'Origin')
  ```
  
  ### vary.append(header, field)
  
  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.
  
  <!-- eslint-disable no-undef -->
  
  ```js
  // Get header string appending "Origin" to "Accept, User-Agent"
  vary.append('Accept, User-Agent', 'Origin')
  ```
  
  ## Examples
  
  ### Updating the Vary header when content is based on it
  
  ```js
  var http = require('http')
  var vary = require('vary')
  
  http.createServer(function onRequest (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')
  })
  ```
  
  ## Testing
  
  ```sh
  $ npm test
  ```
  
  ## License
  
  [MIT](LICENSE)
  
  [npm-image]: https://img.shields.io/npm/v/vary.svg
  [npm-url]: https://npmjs.org/package/vary
  [node-version-image]: https://img.shields.io/node/v/vary.svg
  [node-version-url]: https://nodejs.org/en/download
  [travis-image]: https://img.shields.io/travis/jshttp/vary/master.svg
  [travis-url]: https://travis-ci.org/jshttp/vary
  [coveralls-image]: https://img.shields.io/coveralls/jshttp/vary/master.svg
  [coveralls-url]: https://coveralls.io/r/jshttp/vary
  [downloads-image]: https://img.shields.io/npm/dm/vary.svg
  [downloads-url]: https://npmjs.org/package/vary