Class Headers

constructor

• new Headers(init?: string[]): Headers

  Parameters

  • init: string[] = []

  Returns Headers

Optional_headers

_init

_getHeaders

• _getHeaders(): HeaderBuffer

  Returns HeaderBuffer

append

• append(name: string, value: string): this

  Append header value.

  Parameters

  • name: string
  • value: string

  Returns this

clone

• clone(): Headers

  Clone headers.

  Returns Headers

dehop

• dehop(): this

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

  Returns this

get

• get(name: string): string | null

  Get header value.

  Parameters

  • name: string

  Returns string | null

getAll

• getAll(name: string): 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: string): this

  Remove header.

  Parameters

  • name: string

  Returns this

set

• set(name: string, value: string): this

  Set header value.

  Parameters

  • name: string
  • value: string

  Returns this

setLinks

• setLinks(links: Record<string, string>): this

  Set web links to Link header according to RFC5988.

  Parameters

  • links: Record<string, string>

  Returns this

  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