HttpHeadersLike interface

パッケージ:

@azure/core-http

HTTP ヘッダーのキーと値のペアのコレクション。

メソッド

clone()	この HttpHeaders コレクションのディープ クローン/コピーを作成します。
contains(string)	このヘッダー コレクションに、指定されたヘッダー名のヘッダー エントリが含まれているかどうかを取得します。
get(string)	指定されたヘッダー名のヘッダー値を取得します。指定された名前のヘッダーがこのコレクションに存在しない場合は undefined を取得します。
headerNames()	このコレクションに含まれるヘッダー名を取得します。
headersArray()	このコレクションに含まれるヘッダーを配列として取得します。
headerValues()	このコレクションに含まれるヘッダー値を取得します。
rawHeaders()	このコレクションに含まれているヘッダーをオブジェクトとして取得します。
remove(string)	指定された headerName を持つヘッダーを削除します。 ヘッダーが存在し、削除されたかどうかを返します。
set(string, string | number)	指定した名前と値を使用して、このコレクションのヘッダーを設定します。 名前の大文字と小文字は区別されます。
toJson({ preserveCase?: boolean })	この HTTP ヘッダー コレクションの JSON オブジェクト表現を取得します。 結果は と同じです rawHeaders()。

メソッドの詳細

clone()

この HttpHeaders コレクションのディープ クローン/コピーを作成します。

function clone(): HttpHeadersLike

戻り値

HttpHeadersLike

contains(string)

このヘッダー コレクションに、指定されたヘッダー名のヘッダー エントリが含まれているかどうかを取得します。

function contains(headerName: string): boolean

パラメーター

headerName

string

戻り値

boolean

get(string)

指定されたヘッダー名のヘッダー値を取得します。指定された名前のヘッダーがこのコレクションに存在しない場合は undefined を取得します。

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