Class Headers

constructor

• new Headers(init?): Headers

• Parameters

  • init: string[] = []

  Returns Headers

Optional _headers

_init

_getHeaders

• _getHeaders(): HeaderBuffer

• Returns HeaderBuffer

append

• append(name, value): Headers

• Append header value.

  Parameters

  • name: string

  • value: string

  Returns Headers

clone

• clone(): Headers

• Clone headers.

  Returns Headers

dehop

• dehop(): Headers

• Remove hop-by-hop headers that should not be retransmitted.

  Returns Headers

get

• get(name): null | string

• Get header value.

  Parameters

  • name: string

  Returns null | string

getAll

• getAll(name): string[]

• Get all headers values individually.

  Parameters

  • name: string

  Returns string[]

getLinks

• getLinks(): Record<string, Record<string, string>>

• Get web links from Link header according to RFC5988.

  Returns Record<string, Record<string, string>>

  Link

  http://tools.ietf.org/html/rfc5988

  Example

  // Extract information about next page
  const {link, title} = headers.getLinks().next;
  Copy

remove

• remove(name): Headers

• Remove header.

  Parameters

  • name: string

  Returns Headers

set

• set(name, value): Headers

• Set header value.

  Parameters

  • name: string

  • value: string

  Returns Headers

setLinks

• setLinks(links): Headers

• Set web links to Link header according to RFC5988.

  Parameters

  • links: Record<string, string>

  Returns Headers

  Link

  http://tools.ietf.org/html/rfc5988

  Example

  // Link to next and previous page
  headers.setLinks({next: 'http://example.com/foo', prev: 'http://example.com/bar'});
  Copy

toArray

• toArray(): string[]

• Convert headers into a plain array of name/value pairs.

  Returns string[]

toObject

• toObject(): Record<string, string>

• Convert headers into a plain object.

  Returns Record<string, string>

toString

• toString(): string

• Convert headers to string.

  Returns string