HttpHeaders interface

パッケージ:

@azure/core-rest-pipeline

要求/応答の HTTP ヘッダーのセットを表します。 ヘッダー名は、大文字と小文字が区別されないものとして扱われます。

Extends

Iterable<[string, string]>

メソッド

delete(string)	コレクションから特定のヘッダーを削除します。
get(string)	特定のヘッダーの値を返すか、設定されていない場合は未定義を返します。
has(string)	指定したヘッダーが存在する場合は true を返します。
set(string, string | number | boolean)	特定の値を持つ特定のヘッダーを設定します。
toJSON({ preserveCase?: boolean })	ヘッダー名の値への単純なマップとして機能する生の JS オブジェクトにアクセスします。

継承されたメソッド

[iterator]()

メソッドの詳細

delete(string)

コレクションから特定のヘッダーを削除します。

function delete(name: string)

パラメーター

name

string

削除するヘッダーの名前。

get(string)

特定のヘッダーの値を返すか、設定されていない場合は未定義を返します。

function get(name: string): undefined | string

パラメーター

name

string

取得するヘッダーの名前。

戻り値

undefined | string

has(string)

指定したヘッダーが存在する場合は true を返します。

function has(name: string): boolean

パラメーター

name

string

チェックするヘッダーの名前。

戻り値

boolean

set(string, string | number | boolean)

特定の値を持つ特定のヘッダーを設定します。

function set(name: string, value: string | number | boolean)

パラメーター

name

string

設定するヘッダーの名前。

value

string | number | boolean

ヘッダーに使用する値。

toJSON({ preserveCase?: boolean })

ヘッダー名の値への単純なマップとして機能する生の JS オブジェクトにアクセスします。

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

パラメーター

options

{ preserveCase?: boolean }

戻り値

RawHttpHeaders

継承済みメソッドの詳細

[iterator]()

function [iterator](): Iterator<[string, string], any, undefined>

戻り値

Iterator<[string, string], any, undefined>

Iterable.__@iterator@202 から継承された