HttpHeaders class

パッケージ:

@azure/ms-rest-js

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

コンストラクター

HttpHeaders(RawHttpHeaders)

メソッド

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

コンストラクターの詳細

HttpHeaders(RawHttpHeaders)

new HttpHeaders(rawHeaders?: RawHttpHeaders)

パラメーター

rawHeaders

RawHttpHeaders

メソッドの詳細

clone()

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

function clone(): HttpHeaders

戻り値

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()

この HTTP ヘッダー コレクションの JSON オブジェクト表現を取得します。

function toJson(): RawHttpHeaders

戻り値

RawHttpHeaders

toString()

この HTTP ヘッダー コレクションの文字列形式を取得します。

function toString(): string

戻り値

string