Skip to main content

@keq-request/headers

Provides middleware for modifying HTTP request headers.

Installation

Usage

import { request } from 'keq'
import {
  setHeader,
  setHeaders,
  appendHeader,
  appendHeaders,
  insertHeader,
  insertHeaders,
} from 'keq-headers'


request
  .use(setHeader('x-user-name', 'Kerry'))
  .use(appendHeader('x-user-name', 'Marry'))
  .use(insertHeader('x-user-name', 'J'))
  .use(setHeaders({
    'x-user-name': 'Kerry',
    'x-user-id': '1'
  }))
  .use(appendHeaders({
    'x-user-name': 'Marray',
    'x-user-id': '1',
  }))
  .use(insertHeaders({
    'x-user-name': 'J',
    'x-user-id': 1,
  }))
MiddlewareDescription
setHeaderAdds a header, overwriting if it already exists
setHeadersAdds multiple headers, overwriting if they already exist
appendHeaderAdds a header without affecting existing headers
appendHeadersAdds multiple headers without affecting existing headers
insertHeaderAdds a header only if it doesn't already exist
insertHeadersAdds multiple headers only if they don't already exist