Interface IHttpHeaderCollection

Provides a collection of HTTP headers with helper methods

Hierarchy

IHttpHeaderCollection

Implemented by

Index

Methods

Methods

add

add(name: string, value: HttpHeaderValue): void

- Defined in src/interfaces/HttpClientInterfaces.ts:29
Adds a header

Parameters
- name: string
- value: HttpHeaderValue
Returns void

addHeader

addHeader(header: IHttpHeader): void

- Defined in src/interfaces/HttpClientInterfaces.ts:34
Adds a header

Parameters
- header: IHttpHeader
Returns void

get

get(name: string): IHttpHeader | undefined

- Defined in src/interfaces/HttpClientInterfaces.ts:39
Gets a header

Parameters
- name: string
Returns IHttpHeader | undefined

getAll

getAll(): IHttpHeader[]

- Defined in src/interfaces/HttpClientInterfaces.ts:41
Gets all the defined headers

Returns IHttpHeader[]

remove

remove(name: string): boolean

- Defined in src/interfaces/HttpClientInterfaces.ts:46
removes a header

Parameters
- name: string
Returns boolean

toObject

toObject(): object

- Defined in src/interfaces/HttpClientInterfaces.ts:56
converts the headers to an object

Returns object
- [name: string]: HttpHeaderValue

update

update(name: string, value: HttpHeaderValue): void

- Defined in src/interfaces/HttpClientInterfaces.ts:52
Updates a header

Parameters
- name: string
- value: HttpHeaderValue
Returns void

Generated using TypeDoc