HttpHeaders interface

Pakiet:

@azure/storage-file-share

Kolekcja par klucz/wartość nagłówka HTTP.

Metody

clone()	Utwórz głęboką klon/kopię tej kolekcji HttpHeaders.
contains(string)	Sprawdź, czy ta kolekcja nagłówków zawiera wpis nagłówka dla podanej nazwy nagłówka.
get(string)	Pobierz wartość nagłówka dla podanej nazwy nagłówka lub niezdefiniowana, jeśli w tej kolekcji nie ma nagłówka o podanej nazwie.
headerNames()	Pobierz nazwy nagłówków zawarte w tej kolekcji.
headersArray()	Pobierz nagłówki zawarte w tej kolekcji jako tablicę.
headerValues()	Pobierz wartości nagłówków zawarte w tej kolekcji.
rawHeaders()	Pobierz nagłówki, które są zawarte w tej kolekcji jako obiekt.
remove(string)	Usuń nagłówek z podaną nazwą nagłówka. Zwróć informację, czy nagłówek istniał i został usunięty.
set(string, string | number)	Ustaw nagłówek w tej kolekcji z podaną nazwą i wartością. Nazwa nie uwzględnia wielkości liter.
toJson({ preserveCase?: boolean })	Pobierz reprezentację obiektu JSON dla tej kolekcji nagłówków HTTP. Wynik jest taki sam jak rawHeaders().

Szczegóły metody

clone()

Utwórz głęboką klon/kopię tej kolekcji HttpHeaders.

function clone(): HttpHeadersLike

Zwraca

HttpHeaders

contains(string)

Sprawdź, czy ta kolekcja nagłówków zawiera wpis nagłówka dla podanej nazwy nagłówka.

function contains(headerName: string): boolean

Parametry

headerName

string

Zwraca

boolean

get(string)

Pobierz wartość nagłówka dla podanej nazwy nagłówka lub niezdefiniowana, jeśli w tej kolekcji nie ma nagłówka o podanej nazwie.

function get(headerName: string): undefined | string

Parametry

headerName

string

Nazwa nagłówka.

Zwraca

undefined | string

headerNames()

Pobierz nazwy nagłówków zawarte w tej kolekcji.

function headerNames(): string[]

Zwraca

string[]

headersArray()

Pobierz nagłówki zawarte w tej kolekcji jako tablicę.

function headersArray(): HttpHeader[]

Zwraca

HttpHeader[]

headerValues()

Pobierz wartości nagłówków zawarte w tej kolekcji.

function headerValues(): string[]

Zwraca

string[]

rawHeaders()

Pobierz nagłówki, które są zawarte w tej kolekcji jako obiekt.

function rawHeaders(): RawHttpHeaders

Zwraca

RawHttpHeaders

remove(string)

Usuń nagłówek z podaną nazwą nagłówka. Zwróć informację, czy nagłówek istniał i został usunięty.

function remove(headerName: string): boolean

Parametry

headerName

string

Nazwa nagłówka do usunięcia.

Zwraca

boolean

set(string, string | number)

Ustaw nagłówek w tej kolekcji z podaną nazwą i wartością. Nazwa nie uwzględnia wielkości liter.

function set(headerName: string, headerValue: string | number)

Parametry

headerName

string

Nazwa nagłówka do ustawienia. Ta wartość nie uwzględnia wielkości liter.

headerValue

string | number

Wartość nagłówka do ustawienia.

toJson({ preserveCase?: boolean })

Pobierz reprezentację obiektu JSON dla tej kolekcji nagłówków HTTP. Wynik jest taki sam jak rawHeaders().

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

Parametry

options

{ preserveCase?: boolean }

Zwraca

RawHttpHeaders