Class HttpHeadersImpl

Package version

Hierarchy

HttpHeadersImpl

Implements

HttpHeaders

Index

Constructors

constructor

Methods

Constructors

constructor

new HttpHeadersImpl(rawHeaders?: RawHttpHeaders): HttpHeadersImpl

- Defined in mnt/vss/_work/1/s/sdk/core/core-rest-pipeline/src/httpHeaders.ts:11
Parameters
- Optional rawHeaders: RawHttpHeaders
Returns HttpHeadersImpl

Methods

[Symbol.iterator]

[Symbol.iterator](): Iterator<[string, string]>

- Defined in mnt/vss/_work/1/s/sdk/core/core-rest-pipeline/src/httpHeaders.ts:78
Iterate over tuples of header [name, value] pairs.

Returns Iterator<[string, string]>

delete

delete(name: string): void

Implementation of HttpHeaders.delete
- Defined in mnt/vss/_work/1/s/sdk/core/core-rest-pipeline/src/httpHeaders.ts:53
Remove the header with the provided headerName.

Parameters
- name: string
  
  The name of the header to remove.
Returns void

get

get(name: string): string | undefined

Implementation of HttpHeaders.get
- Defined in mnt/vss/_work/1/s/sdk/core/core-rest-pipeline/src/httpHeaders.ts:37
Get the header value for the provided header name, or undefined if no header exists in this collection with the provided name.

Parameters
- name: string
  
  The name of the header. This value is case-insensitive.
Returns string | undefined

has

has(name: string): boolean

Implementation of HttpHeaders.has
- Defined in mnt/vss/_work/1/s/sdk/core/core-rest-pipeline/src/httpHeaders.ts:45
Get whether or not this header collection contains a header entry for the provided header name.

Parameters
- name: string
  
  The name of the header to set. This value is case-insensitive.
Returns boolean

set

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

Implementation of HttpHeaders.set
- Defined in mnt/vss/_work/1/s/sdk/core/core-rest-pipeline/src/httpHeaders.ts:28
Set a header in this collection with the provided name and value. The name is case-insensitive.

Parameters
- name: string
  
  The name of the header to set. This value is case-insensitive.
- value: string | number
  
  The value of the header to set.
Returns void

toJSON

toJSON(): RawHttpHeaders

Implementation of HttpHeaders.toJSON
- Defined in mnt/vss/_work/1/s/sdk/core/core-rest-pipeline/src/httpHeaders.ts:60
Get the JSON object representation of this HTTP header collection.

Returns RawHttpHeaders

toString

toString(): string

- Defined in mnt/vss/_work/1/s/sdk/core/core-rest-pipeline/src/httpHeaders.ts:71
Get the string representation of this HTTP header collection.

Returns string

Generated using TypeDoc