HttpHeaders interface

套件:

@azure/storage-queue

HTTP 標頭索引鍵/值組的集合。

方法

clone()	建立這個 HttpHeaders 集合的深層複製/複本。
contains(string)	取得這個標頭集合是否包含所提供標頭名稱的標頭專案。
get(string)	取得所提供標頭名稱的標頭值，如果這個集合中沒有提供的名稱，則為未定義。
headerNames()	取得這個集合中包含的標頭名稱。
headersArray()	取得這個集合中包含的標頭做為陣列。
headerValues()	取得這個集合中包含的標頭值。
rawHeaders()	取得包含此集合做為 對象的標頭。
remove(string)	拿掉具有所提供 headerName 的標頭。 傳回標頭是否存在且已移除。
set(string, string | number)	使用提供的名稱和值，設定此集合中的標頭。 名稱不區分大小寫。
toJson({ preserveCase?: boolean })	取得這個 HTTP 標頭集合的 JSON 物件表示。 結果與相同 rawHeaders()。

方法詳細資料

clone()

建立這個 HttpHeaders 集合的深層複製/複本。

function clone(): HttpHeadersLike

傳回

HttpHeaders

contains(string)

取得這個標頭集合是否包含所提供標頭名稱的標頭專案。

function contains(headerName: string): boolean

參數

headerName

string

傳回

boolean

get(string)

取得所提供標頭名稱的標頭值，如果這個集合中沒有提供的名稱，則為未定義。

function get(headerName: string): undefined | string

參數

headerName

string

標頭的名稱。

傳回

undefined | string

headerNames()

取得這個集合中包含的標頭名稱。

function headerNames(): string[]

傳回

string[]

headersArray()

取得這個集合中包含的標頭做為陣列。

function headersArray(): HttpHeader[]

傳回

HttpHeader[]

headerValues()

取得這個集合中包含的標頭值。

function headerValues(): string[]

傳回

string[]

rawHeaders()

取得包含此集合做為 對象的標頭。

function rawHeaders(): RawHttpHeaders

傳回

RawHttpHeaders

remove(string)

拿掉具有所提供 headerName 的標頭。 傳回標頭是否存在且已移除。

function remove(headerName: string): boolean

參數

headerName

string

要移除之標頭的名稱。

傳回

boolean

set(string, string | number)

使用提供的名稱和值，設定此集合中的標頭。 名稱不區分大小寫。

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

參數

headerName

string

要設定之標頭的名稱。 這個值不區分大小寫。

headerValue

string | number

要設定之標頭的值。

toJson({ preserveCase?: boolean })

取得這個 HTTP 標頭集合的 JSON 物件表示。 結果與相同 rawHeaders()。

function toJson(options?: { preserveCase?: boolean }): RawHttpHeaders

參數

options

{ preserveCase?: boolean }

傳回

RawHttpHeaders