http-header

1.1.0 • Public • Published

http-header

Travis build status Coveralls NPM version Canonical Code Style Twitter Follow

Utilities for working with HTTP headers.

API

import {
  deleteHeader,
  getHeader,
  getHeaderName,
  hasHeader,
  HeaderNotFoundError,
  InvalidHeaderNameError,
  InvalidHeaderValueError,
  setHeader,
  setHeaderName
} from 'http-header';
import type {
  HeaderNameType,
  HeadersType,
  HeaderValueType
} from 'http-header';
 
deleteHeader(headers: HeadersType, name: HeaderNameType) => HeadersType;
getHeader(headers: HeadersType, name: HeaderNameType) => HeaderValueType;
getHeaderName(headers: HeadersType, name: HeaderNameType) => HeaderNameType;
hasHeader(headers: HeadersType, name: HeaderNameType) => boolean;
setHeader(headers: HeadersType, name: HeaderNameType, value: HeaderValueType) => HeadersType;
setHeaderName(headers: HeadersType, oldName: HeaderNameType, newName: HeaderNameType) => HeadersType;
 

Behaviour

HeaderNotFoundError error

getHeader and getHeaderName throw HeaderNotFoundError if the specified header cannot be found.

Use hasHeader to check if the header exists before using getHeader or getHeaderName, e.g.

import {
  hasHeader,
  getHeader
} from 'http-header';
 
if (hasHeader('Content-Type')) {
  getHeader('Content-Type');
}
 

Readme

Keywords

Package Sidebar

Install

npm i http-header

Weekly Downloads

6

Version

1.1.0

License

BSD-3-Clause

Unpacked Size

37.1 kB

Total Files

56

Last publish

Collaborators

  • gajus