HttpHeaders interface

  • Reference
Balíček:
@azure/core-rest-pipeline

Představuje sadu hlaviček HTTP v požadavku nebo odpovědi. Názvy hlaviček se považují za nerozlišující malá a velká písmena.

Extends

Iterable<[string, string]>

Metody

delete(string)

Odebere z kolekce konkrétní hlavičku.
get(string)

Vrátí hodnotu konkrétní hlavičky nebo nedefinované, pokud není nastavena.
has(string)

Vrátí hodnotu true, pokud zadaná hlavička existuje.
set(string, string | number | boolean)

Nastaví konkrétní hlavičku s danou hodnotou.
toJSON({ preserveCase?: boolean })

Přistupuje k nezpracovaným objektu JS, který funguje jako jednoduchá mapa názvů hlaviček na hodnoty.

Zděděné metody

[iterator]()

Podrobnosti metody

delete(string)

Odebere z kolekce konkrétní hlavičku.

function delete(name: string)

Parametry

name

string

Název záhlaví, které chcete odstranit.

get(string)

Vrátí hodnotu konkrétní hlavičky nebo nedefinované, pokud není nastavena.

function get(name: string): undefined | string

Parametry

name

string

Název hlavičky, která se má načíst.

Návraty

undefined | string

has(string)

Vrátí hodnotu true, pokud zadaná hlavička existuje.

function has(name: string): boolean

Parametry

name

string

Název záhlaví, které chcete zkontrolovat.

Návraty

boolean

set(string, string | number | boolean)

Nastaví konkrétní hlavičku s danou hodnotou.

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

Parametry

name

string

Název hlavičky, která se má nastavit.

value

string | number | boolean

Hodnota, kterou chcete použít pro záhlaví.

toJSON({ preserveCase?: boolean })

Přistupuje k nezpracovaným objektu JS, který funguje jako jednoduchá mapa názvů hlaviček na hodnoty.

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

Parametry

options

{ preserveCase?: boolean }

Návraty

RawHttpHeaders

Podrobnosti zděděných metod

[iterator]() 

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

Návraty

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

zděděno ze Iterable.__@iterator@202