Interface HttpHeaders

Package version

Represents a set of HTTP headers on a request/response. Header names are treated as case insensitive.

Hierarchy

any
- HttpHeaders

Implemented by

HttpHeadersImpl

Index

Methods

Methods

delete

delete(name: string): void

- Defined in mnt/vss/_work/1/s/sdk/core/core-rest-pipeline/src/interfaces.ts:37
Removes a specific header from the collection.

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

get

get(name: string): string | undefined

- Defined in mnt/vss/_work/1/s/sdk/core/core-rest-pipeline/src/interfaces.ts:21
Returns the value of a specific header or undefined if not set.

Parameters
- name: string
  
  The name of the header to retrieve.
Returns string | undefined

has

has(name: string): boolean

- Defined in mnt/vss/_work/1/s/sdk/core/core-rest-pipeline/src/interfaces.ts:26
Returns true if the specified header exists.

Parameters
- name: string
  
  The name of the header to check.
Returns boolean

set

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

- Defined in mnt/vss/_work/1/s/sdk/core/core-rest-pipeline/src/interfaces.ts:32
Sets a specific header with a given value.

Parameters
- name: string
  
  The name of the header to set.
- value: string | number
  
  The value to use for the header.
Returns void

toJSON

toJSON(): RawHttpHeaders

- Defined in mnt/vss/_work/1/s/sdk/core/core-rest-pipeline/src/interfaces.ts:42
Accesses a raw JS object that acts as a simple map of header names to values.

Returns RawHttpHeaders

Generated using TypeDoc