Udostępnij za pośrednictwem

HttpHeaders interface

  • Odwołanie
Pakiet:
@azure/core-rest-pipeline

Reprezentuje zestaw nagłówków HTTP dla żądania/odpowiedzi. Nazwy nagłówków są traktowane jako bez uwzględniania wielkości liter.

Rozszerzenie

Iterable<[string, string]>

Metody

delete(string)

Usuwa określony nagłówek z kolekcji.
get(string)

Zwraca wartość określonego nagłówka lub niezdefiniowanego, jeśli nie zostanie ustawiona.
has(string)

Zwraca wartość true, jeśli określony nagłówek istnieje.
set(string, string | number | boolean)

Ustawia określony nagłówek z daną wartością.
toJSON({ preserveCase?: boolean })

Uzyskuje dostęp do nieprzetworzonego obiektu JS, który działa jako prosta mapa nazw nagłówków do wartości.

Metody dziedziczone

[iterator]()

Szczegóły metody

delete(string)

Usuwa określony nagłówek z kolekcji.

function delete(name: string)

Parametry

name

string

Nazwa nagłówka do usunięcia.

get(string)

Zwraca wartość określonego nagłówka lub niezdefiniowanego, jeśli nie zostanie ustawiona.

function get(name: string): undefined | string

Parametry

name

string

Nazwa nagłówka do pobrania.

Zwraca

undefined | string

has(string)

Zwraca wartość true, jeśli określony nagłówek istnieje.

function has(name: string): boolean

Parametry

name

string

Nazwa nagłówka do sprawdzenia.

Zwraca

boolean

set(string, string | number | boolean)

Ustawia określony nagłówek z daną wartością.

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

Parametry

name

string

Nazwa nagłówka do ustawienia.

value

string | number | boolean

Wartość do użycia dla nagłówka.

toJSON({ preserveCase?: boolean })

Uzyskuje dostęp do nieprzetworzonego obiektu JS, który działa jako prosta mapa nazw nagłówków do wartości.

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

Parametry

options

{ preserveCase?: boolean }

Zwraca

RawHttpHeaders

Szczegóły metody dziedziczonej

[iterator]() 

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

Zwraca

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

dziedziczone z Iterable.__@iterator@206