Interface IHttpRequestHeaderCollection

A collection of headers that only apply to a request

Hierarchy

IHttpHeaderCollection
- IHttpRequestHeaderCollection

Implemented by

HttpRequestHeaderCollection

Index

Properties

authorization

Methods

Properties

authorization

authorization: string | undefined

the authorization header on a request

Methods

add

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

Inherited from IHttpHeaderCollection.add
- Defined in src/interfaces/HttpClientInterfaces.ts:29
Adds a header

Parameters
- name: string
- value: HttpHeaderValue
Returns void

addHeader

addHeader(header: IHttpHeader): void

Inherited from IHttpHeaderCollection.addHeader
- Defined in src/interfaces/HttpClientInterfaces.ts:34
Adds a header

Parameters
- header: IHttpHeader
Returns void

get

get(name: string): IHttpHeader | undefined

Inherited from IHttpHeaderCollection.get
- Defined in src/interfaces/HttpClientInterfaces.ts:39
Gets a header

Parameters
- name: string
Returns IHttpHeader | undefined

getAll

getAll(): IHttpHeader[]

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

Returns IHttpHeader[]

remove

remove(name: string): boolean

Inherited from IHttpHeaderCollection.remove
- Defined in src/interfaces/HttpClientInterfaces.ts:46
removes a header

Parameters
- name: string
Returns boolean

toObject

toObject(): object

Inherited from IHttpHeaderCollection.toObject
- 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

Inherited from IHttpHeaderCollection.update
- Defined in src/interfaces/HttpClientInterfaces.ts:52
Updates a header

Parameters
- name: string
- value: HttpHeaderValue
Returns void

Generated using TypeDoc