@readme/http-headers

Utility to find descriptions for HTTP headers.

Installation

1npm install --save @readme/http-headers

Usage

HTTP-Headers pulls header descriptions directly from MDN's header documentation.

1import getHeader from '@readme/http-headers';
2
3//  A typical header
4console.log(getHeader('Connection'));
5/**
6{
7    description: 'Controls whether the network connection stays open after the current transaction finishes.',
8    link: 'https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Connection',
9}
10**/
11
12// A header with a markdown-flavored description
13console.log(getHeader('Cookie'));
14/**
15{
16    description: 'Contains stored HTTP cookies previously sent by the server with the Set-Cookie header.',
17    link: 'https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Cookie',
18    markdown:
19      'Contains stored [HTTP cookies](/en-US/docs/Web/HTTP/Cookies) previously sent by the server with the "Set-Cookie" header',
20}
21**/
22
23// A header with additional decorations
24console.log(getHeader('DPR'));
25/**
26{
27    deprecated: true,
28    experimental: true,
29    description:
30      'Client device pixel ratio (DPR), which is the number of physical device pixels corresponding to every CSS pixel.',
31    link: 'https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/DPR',
32}
33**/