Interface HttpHeadersLike

Package version

A collection of HTTP header key/value pairs.

Hierarchy

HttpHeadersLike

Implemented by

HttpHeaders

Index

Methods

Methods

clone

clone(): HttpHeadersLike

- Defined in mnt/vss/_work/1/s/sdk/servicebus/service-bus/src/util/compat/httpHeaders.ts:77
Create a deep clone/copy of this HttpHeaders collection.

Returns HttpHeadersLike

contains

contains(headerName: string): boolean

- Defined in mnt/vss/_work/1/s/sdk/servicebus/service-bus/src/util/compat/httpHeaders.ts:51
Get whether or not this header collection contains a header entry for the provided header name.

Parameters
- headerName: string
Returns boolean

get

get(headerName: string): string | undefined

- Defined in mnt/vss/_work/1/s/sdk/servicebus/service-bus/src/util/compat/httpHeaders.ts:47
Get the header value for the provided header name, or undefined if no header exists in this collection with the provided name.

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

headerNames

headerNames(): string[]

- Defined in mnt/vss/_work/1/s/sdk/servicebus/service-bus/src/util/compat/httpHeaders.ts:69
Get the header names that are contained in this collection.

Returns string[]

headerValues

headerValues(): string[]

- Defined in mnt/vss/_work/1/s/sdk/servicebus/service-bus/src/util/compat/httpHeaders.ts:73
Get the header values that are contained in this collection.

Returns string[]

headersArray

headersArray(): HttpHeader[]

- Defined in mnt/vss/_work/1/s/sdk/servicebus/service-bus/src/util/compat/httpHeaders.ts:65
Get the headers that are contained in this collection as an array.

Returns HttpHeader[]

rawHeaders

rawHeaders(): RawHttpHeaders

- Defined in mnt/vss/_work/1/s/sdk/servicebus/service-bus/src/util/compat/httpHeaders.ts:61
Get the headers that are contained this collection as an object.

Returns RawHttpHeaders

remove

remove(headerName: string): boolean

- Defined in mnt/vss/_work/1/s/sdk/servicebus/service-bus/src/util/compat/httpHeaders.ts:57
Remove the header with the provided headerName. Return whether or not the header existed and was removed.

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

set

set(headerName: string, headerValue: string | number): void

- Defined in mnt/vss/_work/1/s/sdk/servicebus/service-bus/src/util/compat/httpHeaders.ts:41
Set a header in this collection with the provided name and value. The name is case-insensitive.

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

toJson

toJson(options?: undefined | { preserveCase?: undefined | false | true }): RawHttpHeaders

- Defined in mnt/vss/_work/1/s/sdk/servicebus/service-bus/src/util/compat/httpHeaders.ts:82
Get the JSON object representation of this HTTP header collection. The result is the same as rawHeaders().

Parameters
- Optional options: undefined | { preserveCase?: undefined | false | true }
Returns RawHttpHeaders

Generated using TypeDoc