Class MessageHeaders

Represents a collection of headers for a Message.

Hierarchy

MessageHeaders

Index

Constructors

constructor

Methods

Constructors

constructor

new MessageHeaders(headers?: object): MessageHeaders

- Defined in messageHeaders.ts:10
Constructs a MessagesHeaders object.

Parameters
- Optional headers: object
  
  Object map of headers. Header keys must be lowercase.
  - [name: string]: string
Returns MessageHeaders

Methods

delete

delete(name: string): void

- Defined in messageHeaders.ts:61
Deletes a header.

Parameters
- name: string
  
  The case insensitive name of the header.
Returns void

get

get(name: string): string

- Defined in messageHeaders.ts:25
Gets a header.

Parameters
- name: string
  
  The case insensitive name of the header.
Returns string

has

has(name: string): boolean

- Defined in messageHeaders.ts:50
Returns true if the collection contains the header; otherwise, returns false.

Parameters
- name: string
  
  The case insensitive name of the header.
Returns boolean

merge

merge(headers: MessageHeaders): void

- Defined in messageHeaders.ts:72
Merges in the messages headers, overwriting any existing headers.

Parameters
- headers: MessageHeaders
  
  The headers to merge
Returns void

set

set(name: string, value: string): void

- Defined in messageHeaders.ts:37
Sets a header.

Parameters
- name: string
  
  The case insensitive name of the header.
- value: string
  
  The value of the header.
Returns void

toObject

toObject(): Object

- Defined in messageHeaders.ts:93
Returns the headers as an object map. Will return undefined if no headers have been set.

Returns Object

Generated using TypeDoc