BlueGit

blue-star danique-bot

Files

danique-bot / node_modules / caseless / README.md

README.md

Import template
timfa Tim · pushed by timfa · 4 years ago
c788ad20 History
README.md 1.1 KiB Download Raw

Caseless -- wrap an object to set and get property with caseless semantics but also preserve caseing.

This library is incredibly useful when working with HTTP headers. It allows you to get/set/check for headers in a caseless manner while also preserving the caseing of headers the first time they are set.

Usage

var headers = {}
  , c = caseless(headers)
  ;
c.set('a-Header', 'asdf')
c.get('a-header') === 'asdf'

has(key)

Has takes a name and if it finds a matching header will return that header name with the preserved caseing it was set with.

c.has('a-header') === 'a-Header'

set(key, value[, clobber=true])

Set is fairly straight forward except that if the header exists and clobber is disabled it will add ','+value to the existing header.

c.set('a-Header', 'fdas')
c.set('a-HEADER', 'more', false)
c.get('a-header') === 'fdsa,more'

swap(key)

Swaps the casing of a header with the new one that is passed in.

var headers = {}
  , c = caseless(headers)
  ;
c.set('a-Header', 'fdas')
c.swap('a-HEADER')
c.has('a-header') === 'a-HEADER'
headers === {'a-HEADER': 'fdas'}
Source
1## Caseless -- wrap an object to set and get property with caseless semantics but also preserve caseing.
2
3This library is incredibly useful when working with HTTP headers. It allows you to get/set/check for headers in a caseless manner while also preserving the caseing of headers the first time they are set.
4
5## Usage
6
7```javascript
8var headers = {}
9 , c = caseless(headers)
10 ;
11c.set('a-Header', 'asdf')
12c.get('a-header') === 'asdf'
13```
14
15## has(key)
16
17Has takes a name and if it finds a matching header will return that header name with the preserved caseing it was set with.
18
19```javascript
20c.has('a-header') === 'a-Header'
21```
22
23## set(key, value[, clobber=true])
24
25Set is fairly straight forward except that if the header exists and clobber is disabled it will add `','+value` to the existing header.
26
27```javascript
28c.set('a-Header', 'fdas')
29c.set('a-HEADER', 'more', false)
30c.get('a-header') === 'fdsa,more'
31```
32
33## swap(key)
34
35Swaps the casing of a header with the new one that is passed in.
36
37```javascript
38var headers = {}
39 , c = caseless(headers)
40 ;
41c.set('a-Header', 'fdas')
42c.swap('a-HEADER')
43c.has('a-header') === 'a-HEADER'
44headers === {'a-HEADER': 'fdas'}
45```