Spec-Zone.ru › Angular

HttpClient

Выполняет HTTP-запросы. Этот сервис доступен в виде внедряемого класса с методами для выполнения HTTP-запросов. Каждый метод запроса имеет несколько сигнатур, а возвращаемый тип зависит от используемой сигнатуры (в основном от значений observe и responseType).

Руководство по HTTPHTTP-запрос

API

class HttpClient {
  constructor(handler: HttpHandler): HttpClient;
  request<R>(req: HttpRequest<any>): Observable<HttpEvent<R>>;
  request(method: string, url: string, options: { body?: any; observe?: "body" | undefined; responseType: "arraybuffer"; } & HttpClientCommonOptions): Observable<ArrayBuffer>;
  request(method: string, url: string, options: { body?: any; observe?: "body" | undefined; responseType: "blob"; } & HttpClientCommonOptions): Observable<Blob>;
  request(method: string, url: string, options: { body?: any; observe?: "body" | undefined; responseType: "text"; } & HttpClientCommonOptions): Observable<string>;
  request(method: string, url: string, options: { body?: any; observe: "events"; responseType: "arraybuffer"; } & HttpClientCommonOptions): Observable<HttpEvent<ArrayBuffer>>;
  request(method: string, url: string, options: { body?: any; observe: "events"; responseType: "blob"; } & HttpClientCommonOptions): Observable<HttpEvent<Blob>>;
  request(method: string, url: string, options: { body?: any; observe: "events"; responseType: "text"; } & HttpClientCommonOptions): Observable<HttpEvent<string>>;
  request(method: string, url: string, options: { body?: any; observe: "events"; responseType?: "json" | undefined; } & HttpClientCommonOptions): Observable<HttpEvent<any>>;
  request<R>(method: string, url: string, options: { body?: any; observe: "events"; responseType?: "json" | undefined; } & HttpClientCommonOptions): Observable<HttpEvent<R>>;
  request(method: string, url: string, options: { body?: any; observe: "response"; responseType: "arraybuffer"; } & HttpClientCommonOptions): Observable<HttpResponse<ArrayBuffer>>;
  request(method: string, url: string, options: { body?: any; observe: "response"; responseType: "blob"; } & HttpClientCommonOptions): Observable<HttpResponse<Blob>>;
  request(method: string, url: string, options: { body?: any; observe: "response"; responseType: "text"; } & HttpClientCommonOptions): Observable<HttpResponse<string>>;
  request(method: string, url: string, options: { body?: any; observe: "response"; responseType?: "json" | undefined; } & HttpClientCommonOptions): Observable<HttpResponse<Object>>;
  request<R>(method: string, url: string, options: { body?: any; observe: "response"; responseType?: "json" | undefined; } & HttpClientCommonOptions): Observable<HttpResponse<R>>;
  request(method: string, url: string, options?: ({ body?: any; observe?: "body" | undefined; responseType?: "json" | undefined; } & HttpClientCommonOptions) | undefined): Observable<Object>;
  request<R>(method: string, url: string, options?: ({ body?: any; observe?: "body" | undefined; responseType?: "json" | undefined; } & HttpClientCommonOptions) | undefined): Observable<R>;
  request(method: string, url: string, options?: ({ body?: any; observe?: "body" | "events" | "response" | undefined; responseType?: "arraybuffer" | "blob" | "json" | "text" | undefined; } & HttpClientCommonOptions) | undefined): Observable<any>;
  delete(url: string, options: { observe?: "body" | undefined; responseType: "arraybuffer"; body?: any; } & HttpClientCommonOptions): Observable<ArrayBuffer>;
  delete(url: string, options: { observe?: "body" | undefined; responseType: "blob"; body?: any; } & HttpClientCommonOptions): Observable<Blob>;
  delete(url: string, options: { observe?: "body" | undefined; responseType: "text"; body?: any; } & HttpClientCommonOptions): Observable<string>;
  delete(url: string, options: { observe: "events"; responseType: "arraybuffer"; body?: any; } & HttpClientCommonOptions): Observable<HttpEvent<ArrayBuffer>>;
  delete(url: string, options: { observe: "events"; responseType: "blob"; body?: any; } & HttpClientCommonOptions): Observable<HttpEvent<Blob>>;
  delete(url: string, options: { observe: "events"; responseType: "text"; body?: any; } & HttpClientCommonOptions): Observable<HttpEvent<string>>;
  delete(url: string, options: { observe: "events"; responseType?: "json" | undefined; body?: any; } & HttpClientCommonOptions): Observable<HttpEvent<Object>>;
  delete<T>(url: string, options: { observe: "events"; responseType?: "json" | undefined; body?: any; } & HttpClientCommonOptions): Observable<HttpEvent<T>>;
  delete(url: string, options: { observe: "response"; responseType: "arraybuffer"; body?: any; } & HttpClientCommonOptions): Observable<HttpResponse<ArrayBuffer>>;
  delete(url: string, options: { observe: "response"; responseType: "blob"; body?: any; } & HttpClientCommonOptions): Observable<HttpResponse<Blob>>;
  delete(url: string, options: { observe: "response"; responseType: "text"; body?: any; } & HttpClientCommonOptions): Observable<HttpResponse<string>>;
  delete(url: string, options: { observe: "response"; responseType?: "json" | undefined; body?: any; } & HttpClientCommonOptions): Observable<HttpResponse<Object>>;
  delete<T>(url: string, options: { observe: "response"; responseType?: "json" | undefined; body?: any; } & HttpClientCommonOptions): Observable<HttpResponse<T>>;
  delete(url: string, options?: ({ observe?: "body" | undefined; responseType?: "json" | undefined; body?: any; } & HttpClientCommonOptions) | undefined): Observable<Object>;
  delete<T>(url: string, options?: ({ observe?: "body" | undefined; responseType?: "json" | undefined; body?: any; } & HttpClientCommonOptions) | undefined): Observable<T>;
  get(url: string, options: { observe?: "body" | undefined; responseType: "arraybuffer"; } & HttpClientCommonOptions): Observable<ArrayBuffer>;
  get(url: string, options: { observe?: "body" | undefined; responseType: "blob"; } & HttpClientCommonOptions): Observable<Blob>;
  get(url: string, options: { observe?: "body" | undefined; responseType: "text"; } & HttpClientCommonOptions): Observable<string>;
  get(url: string, options: { observe: "events"; responseType: "arraybuffer"; } & HttpClientCommonOptions): Observable<HttpEvent<ArrayBuffer>>;
  get(url: string, options: { observe: "events"; responseType: "blob"; } & HttpClientCommonOptions): Observable<HttpEvent<Blob>>;
  get(url: string, options: { observe: "events"; responseType: "text"; } & HttpClientCommonOptions): Observable<HttpEvent<string>>;
  get(url: string, options: { observe: "events"; responseType?: "json" | undefined; } & HttpClientCommonOptions): Observable<HttpEvent<Object>>;
  get<T>(url: string, options: { observe: "events"; responseType?: "json" | undefined; } & HttpClientCommonOptions): Observable<HttpEvent<T>>;
  get(url: string, options: { observe: "response"; responseType: "arraybuffer"; } & HttpClientCommonOptions): Observable<HttpResponse<ArrayBuffer>>;
  get(url: string, options: { observe: "response"; responseType: "blob"; } & HttpClientCommonOptions): Observable<HttpResponse<Blob>>;
  get(url: string, options: { observe: "response"; responseType: "text"; } & HttpClientCommonOptions): Observable<HttpResponse<string>>;
  get(url: string, options: { observe: "response"; responseType?: "json" | undefined; } & HttpClientCommonOptions): Observable<HttpResponse<Object>>;
  get<T>(url: string, options: { observe: "response"; responseType?: "json" | undefined; } & HttpClientCommonOptions): Observable<HttpResponse<T>>;
  get(url: string, options?: ({ observe?: "body" | undefined; responseType?: "json" | undefined; } & HttpClientCommonOptions) | undefined): Observable<Object>;
  get<T>(url: string, options?: ({ observe?: "body" | undefined; responseType?: "json" | undefined; } & HttpClientCommonOptions) | undefined): Observable<T>;
  head(url: string, options: { observe?: "body" | undefined; responseType: "arraybuffer"; } & HttpClientCommonOptions): Observable<ArrayBuffer>;
  head(url: string, options: { observe?: "body" | undefined; responseType: "blob"; } & HttpClientCommonOptions): Observable<Blob>;
  head(url: string, options: { observe?: "body" | undefined; responseType: "text"; } & HttpClientCommonOptions): Observable<string>;
  head(url: string, options: { observe: "events"; responseType: "arraybuffer"; } & HttpClientCommonOptions): Observable<HttpEvent<ArrayBuffer>>;
  head(url: string, options: { observe: "events"; responseType: "blob"; } & HttpClientCommonOptions): Observable<HttpEvent<Blob>>;
  head(url: string, options: { observe: "events"; responseType: "text"; } & HttpClientCommonOptions): Observable<HttpEvent<string>>;
  head(url: string, options: { observe: "events"; responseType?: "json" | undefined; } & HttpClientCommonOptions): Observable<HttpEvent<Object>>;
  head<T>(url: string, options: { observe: "events"; responseType?: "json" | undefined; } & HttpClientCommonOptions): Observable<HttpEvent<T>>;
  head(url: string, options: { observe: "response"; responseType: "arraybuffer"; } & HttpClientCommonOptions): Observable<HttpResponse<ArrayBuffer>>;
  head(url: string, options: { observe: "response"; responseType: "blob"; } & HttpClientCommonOptions): Observable<HttpResponse<Blob>>;
  head(url: string, options: { observe: "response"; responseType: "text"; } & HttpClientCommonOptions): Observable<HttpResponse<string>>;
  head(url: string, options: { observe: "response"; responseType?: "json" | undefined; } & HttpClientCommonOptions): Observable<HttpResponse<Object>>;
  head<T>(url: string, options: { observe: "response"; responseType?: "json" | undefined; } & HttpClientCommonOptions): Observable<HttpResponse<T>>;
  head(url: string, options?: HttpClientCommonOptions | undefined): Observable<Object>;
  head<T>(url: string, options?: HttpClientCommonOptions | undefined): Observable<T>;
  jsonp(url: string, callbackParam: string): Observable<Object>;
  jsonp<T>(url: string, callbackParam: string): Observable<T>;
  options(url: string, options: { observe?: "body" | undefined; responseType: "arraybuffer"; } & HttpClientCommonOptions): Observable<ArrayBuffer>;
  options(url: string, options: { observe?: "body" | undefined; responseType: "blob"; } & HttpClientCommonOptions): Observable<Blob>;
  options(url: string, options: { observe?: "body" | undefined; responseType: "text"; } & HttpClientCommonOptions): Observable<string>;
  options(url: string, options: { observe: "events"; responseType: "arraybuffer"; } & HttpClientCommonOptions): Observable<HttpEvent<ArrayBuffer>>;
  options(url: string, options: { observe: "events"; responseType: "blob"; } & HttpClientCommonOptions): Observable<HttpEvent<Blob>>;
  options(url: string, options: { observe: "events"; responseType: "text"; } & HttpClientCommonOptions): Observable<HttpEvent<string>>;
  options(url: string, options: { observe: "events"; responseType?: "json" | undefined; } & HttpClientCommonOptions): Observable<HttpEvent<Object>>;
  options<T>(url: string, options: { observe: "events"; responseType?: "json" | undefined; } & HttpClientCommonOptions): Observable<HttpEvent<T>>;
  options(url: string, options: { observe: "response"; responseType: "arraybuffer"; } & HttpClientCommonOptions): Observable<HttpResponse<ArrayBuffer>>;
  options(url: string, options: { observe: "response"; responseType: "blob"; } & HttpClientCommonOptions): Observable<HttpResponse<Blob>>;
  options(url: string, options: { observe: "response"; responseType: "text"; } & HttpClientCommonOptions): Observable<HttpResponse<string>>;
  options(url: string, options: { observe: "response"; responseType?: "json" | undefined; } & HttpClientCommonOptions): Observable<HttpResponse<Object>>;
  options<T>(url: string, options: { observe: "response"; responseType?: "json" | undefined; } & HttpClientCommonOptions): Observable<HttpResponse<T>>;
  options(url: string, options?: HttpClientCommonOptions | undefined): Observable<Object>;
  options<T>(url: string, options?: HttpClientCommonOptions | undefined): Observable<T>;
  patch(url: string, body: any, options: { observe?: "body" | undefined; responseType: "arraybuffer"; } & HttpClientCommonOptions): Observable<ArrayBuffer>;
  patch(url: string, body: any, options: { observe?: "body" | undefined; responseType: "blob"; } & HttpClientCommonOptions): Observable<Blob>;
  patch(url: string, body: any, options: { observe?: "body" | undefined; responseType: "text"; } & HttpClientCommonOptions): Observable<string>;
  patch(url: string, body: any, options: { observe: "events"; responseType: "arraybuffer"; } & HttpClientCommonOptions): Observable<HttpEvent<ArrayBuffer>>;
  patch(url: string, body: any, options: { observe: "events"; responseType: "blob"; } & HttpClientCommonOptions): Observable<HttpEvent<Blob>>;
  patch(url: string, body: any, options: { observe: "events"; responseType: "text"; } & HttpClientCommonOptions): Observable<HttpEvent<string>>;
  patch(url: string, body: any, options: { observe: "events"; responseType?: "json" | undefined; } & HttpClientCommonOptions): Observable<HttpEvent<Object>>;
  patch<T>(url: string, body: any, options: { observe: "events"; responseType?: "json" | undefined; } & HttpClientCommonOptions): Observable<HttpEvent<T>>;
  patch(url: string, body: any, options: { observe: "response"; responseType: "arraybuffer"; } & HttpClientCommonOptions): Observable<HttpResponse<ArrayBuffer>>;
  patch(url: string, body: any, options: { observe: "response"; responseType: "blob"; } & HttpClientCommonOptions): Observable<HttpResponse<Blob>>;
  patch(url: string, body: any, options: { observe: "response"; responseType: "text"; } & HttpClientCommonOptions): Observable<HttpResponse<string>>;
  patch(url: string, body: any, options: { observe: "response"; responseType?: "json" | undefined; } & HttpClientCommonOptions): Observable<HttpResponse<Object>>;
  patch<T>(url: string, body: any, options: { observe: "response"; responseType?: "json" | undefined; } & HttpClientCommonOptions): Observable<HttpResponse<T>>;
  patch(url: string, body: any, options?: HttpClientCommonOptions | undefined): Observable<Object>;
  patch<T>(url: string, body: any, options?: HttpClientCommonOptions | undefined): Observable<T>;
  post(url: string, body: any, options: { observe?: "body" | undefined; responseType: "arraybuffer"; } & HttpClientCommonOptions): Observable<ArrayBuffer>;
  post(url: string, body: any, options: { observe?: "body" | undefined; responseType: "blob"; } & HttpClientCommonOptions): Observable<Blob>;
  post(url: string, body: any, options: { observe?: "body" | undefined; responseType: "text"; } & HttpClientCommonOptions): Observable<string>;
  post(url: string, body: any, options: { observe: "events"; responseType: "arraybuffer"; } & HttpClientCommonOptions): Observable<HttpEvent<ArrayBuffer>>;
  post(url: string, body: any, options: { observe: "events"; responseType: "blob"; } & HttpClientCommonOptions): Observable<HttpEvent<Blob>>;
  post(url: string, body: any, options: { observe: "events"; responseType: "text"; } & HttpClientCommonOptions): Observable<HttpEvent<string>>;
  post(url: string, body: any, options: { observe: "events"; responseType?: "json" | undefined; } & HttpClientCommonOptions): Observable<HttpEvent<Object>>;
  post<T>(url: string, body: any, options: { observe: "events"; responseType?: "json" | undefined; } & HttpClientCommonOptions): Observable<HttpEvent<T>>;
  post(url: string, body: any, options: { observe: "response"; responseType: "arraybuffer"; } & HttpClientCommonOptions): Observable<HttpResponse<ArrayBuffer>>;
  post(url: string, body: any, options: { observe: "response"; responseType: "blob"; } & HttpClientCommonOptions): Observable<HttpResponse<Blob>>;
  post(url: string, body: any, options: { observe: "response"; responseType: "text"; } & HttpClientCommonOptions): Observable<HttpResponse<string>>;
  post(url: string, body: any, options: { observe: "response"; responseType?: "json" | undefined; } & HttpClientCommonOptions): Observable<HttpResponse<Object>>;
  post<T>(url: string, body: any, options: { observe: "response"; responseType?: "json" | undefined; } & HttpClientCommonOptions): Observable<HttpResponse<T>>;
  post(url: string, body: any, options?: HttpClientCommonOptions | undefined): Observable<Object>;
  post<T>(url: string, body: any, options?: HttpClientCommonOptions | undefined): Observable<T>;
  put(url: string, body: any, options: { observe?: "body" | undefined; responseType: "arraybuffer"; } & HttpClientCommonOptions): Observable<ArrayBuffer>;
  put(url: string, body: any, options: { observe?: "body" | undefined; responseType: "blob"; } & HttpClientCommonOptions): Observable<Blob>;
  put(url: string, body: any, options: { observe?: "body" | undefined; responseType: "text"; } & HttpClientCommonOptions): Observable<string>;
  put(url: string, body: any, options: { observe: "events"; responseType: "arraybuffer"; } & HttpClientCommonOptions): Observable<HttpEvent<ArrayBuffer>>;
  put(url: string, body: any, options: { observe: "events"; responseType: "blob"; } & HttpClientCommonOptions): Observable<HttpEvent<Blob>>;
  put(url: string, body: any, options: { observe: "events"; responseType: "text"; } & HttpClientCommonOptions): Observable<HttpEvent<string>>;
  put(url: string, body: any, options: { observe: "events"; responseType?: "json" | undefined; } & HttpClientCommonOptions): Observable<HttpEvent<Object>>;
  put<T>(url: string, body: any, options: { observe: "events"; responseType?: "json" | undefined; } & HttpClientCommonOptions): Observable<HttpEvent<T>>;
  put(url: string, body: any, options: { observe: "response"; responseType: "arraybuffer"; } & HttpClientCommonOptions): Observable<HttpResponse<ArrayBuffer>>;
  put(url: string, body: any, options: { observe: "response"; responseType: "blob"; } & HttpClientCommonOptions): Observable<HttpResponse<Blob>>;
  put(url: string, body: any, options: { observe: "response"; responseType: "text"; } & HttpClientCommonOptions): Observable<HttpResponse<string>>;
  put(url: string, body: any, options: { observe: "response"; responseType?: "json" | undefined; } & HttpClientCommonOptions): Observable<HttpResponse<Object>>;
  put<T>(url: string, body: any, options: { observe: "response"; responseType?: "json" | undefined; } & HttpClientCommonOptions): Observable<HttpResponse<T>>;
  put(url: string, body: any, options?: HttpClientCommonOptions | undefined): Observable<Object>;
  put<T>(url: string, body: any, options?: HttpClientCommonOptions | undefined): Observable<T>;
}

constructor

HttpClient
@paramhandlerHttpHandler
@returnsHttpClient

request

17 перегрузок

Отправляет HttpRequest и возвращает поток HttpEventов.

@paramreqHttpRequest<any>
@returnsObservable<HttpEvent<R>>

Создаёт запрос, интерпретирующий тело как ArrayBuffer, и возвращает ответ в виде ArrayBuffer.

@parammethodstring

Метод HTTP.

@paramurlstring

URL конечной точки.

@paramoptions{ body?: any; observe?: "body" | undefined; responseType: "arraybuffer"; } & HttpClientCommonOptions

Параметры HTTP, передаваемые вместе с запросом.

@returnsObservable<ArrayBuffer>

Создаёт запрос, интерпретирующий тело как blob, и возвращает ответ в виде blob.

@parammethodstring

Метод HTTP.

@paramurlstring

URL конечной точки.

@paramoptions{ body?: any; observe?: "body" | undefined; responseType: "blob"; } & HttpClientCommonOptions

Параметры HTTP, передаваемые вместе с запросом.

@returnsObservable<Blob>

Создаёт запрос, интерпретирующий тело как текстовую строку, и возвращает строковое значение.

@parammethodstring

Метод HTTP.

@paramurlstring

URL конечной точки.

@paramoptions{ body?: any; observe?: "body" | undefined; responseType: "text"; } & HttpClientCommonOptions

Параметры HTTP, передаваемые вместе с запросом.

@returnsObservable<string>

Создаёт запрос, интерпретирующий тело как ArrayBuffer, и возвращает полный поток событий.

@parammethodstring

Метод HTTP.

@paramurlstring

URL конечной точки.

@paramoptions{ body?: any; observe: "events"; responseType: "arraybuffer"; } & HttpClientCommonOptions

Параметры HTTP, передаваемые вместе с запросом.

@returnsObservable<HttpEvent<ArrayBuffer>>

Создаёт запрос, интерпретирующий тело как Blob, и возвращает полный поток событий.

@parammethodstring

Метод HTTP.

@paramurlstring

URL конечной точки.

@paramoptions{ body?: any; observe: "events"; responseType: "blob"; } & HttpClientCommonOptions

Параметры HTTP, передаваемые вместе с запросом.

@returnsObservable<HttpEvent<Blob>>

Создаёт запрос, интерпретирующий тело как текстовую строку, и возвращает полный поток событий.

@parammethodstring

Метод HTTP.

@paramurlstring

URL конечной точки.

@paramoptions{ body?: any; observe: "events"; responseType: "text"; } & HttpClientCommonOptions

Параметры HTTP, передаваемые вместе с запросом.

@returnsObservable<HttpEvent<string>>

Создаёт запрос, интерпретирующий тело как объект JavaScript, и возвращает полный поток событий.

@parammethodstring

Метод HTTP.

@paramurlstring

URL конечной точки.

@paramoptions{ body?: any; observe: "events"; responseType?: "json" | undefined; } & HttpClientCommonOptions

Параметры HTTP, передаваемые вместе с запросом.

@returnsObservable<HttpEvent<any>>

Создаёт запрос, интерпретирующий тело как объект JavaScript, и возвращает полный поток событий.

@parammethodstring

Метод HTTP.

@paramurlstring

URL конечной точки.

@paramoptions{ body?: any; observe: "events"; responseType?: "json" | undefined; } & HttpClientCommonOptions

Параметры HTTP, передаваемые вместе с запросом.

@returnsObservable<HttpEvent<R>>

Создаёт запрос, интерпретирующий тело как ArrayBuffer, и возвращает полный HttpResponse.

@parammethodstring

Метод HTTP.

@paramurlstring

URL конечной точки.

@paramoptions{ body?: any; observe: "response"; responseType: "arraybuffer"; } & HttpClientCommonOptions

Параметры HTTP, передаваемые вместе с запросом.

@returnsObservable<HttpResponse<ArrayBuffer>>

Создаёт запрос, интерпретирующий тело как Blob, и возвращает полный HttpResponse.

@parammethodstring

Метод HTTP.

@paramurlstring

URL конечной точки.

@paramoptions{ body?: any; observe: "response"; responseType: "blob"; } & HttpClientCommonOptions

Параметры HTTP, передаваемые вместе с запросом.

@returnsObservable<HttpResponse<Blob>>

Создаёт запрос, интерпретирующий тело как текстовый поток, и возвращает полный HttpResponse.

@parammethodstring

Метод HTTP.

@paramurlstring

URL конечной точки.

@paramoptions{ body?: any; observe: "response"; responseType: "text"; } & HttpClientCommonOptions

Параметры HTTP, передаваемые вместе с запросом.

@returnsObservable<HttpResponse<string>>

Создаёт запрос, интерпретирующий тело как объект JavaScript, и возвращает полный HttpResponse.

@parammethodstring

Метод HTTP.

@paramurlstring

URL конечной точки.

@paramoptions{ body?: any; observe: "response"; responseType?: "json" | undefined; } & HttpClientCommonOptions

Параметры HTTP, передаваемые вместе с запросом.

@returnsObservable<HttpResponse<Object>>

Создаёт запрос, интерпретирующий тело как объект JavaScript, и возвращает полный HttpResponse с телом ответа запрошенного типа.

@parammethodstring

Метод HTTP.

@paramurlstring

URL конечной точки.

@paramoptions{ body?: any; observe: "response"; responseType?: "json" | undefined; } & HttpClientCommonOptions

Параметры HTTP, передаваемые вместе с запросом.

@returnsObservable<HttpResponse<R>>

Создаёт запрос, интерпретирующий тело как объект JavaScript, и возвращает полный HttpResponse в виде объекта JavaScript.

@parammethodstring

Метод HTTP.

@paramurlstring

URL конечной точки.

@paramoptions({ body?: any; observe?: "body" | undefined; responseType?: "json" | undefined; } & HttpClientCommonOptions) | undefined

Параметры HTTP, передаваемые вместе с запросом.

@returnsObservable<Object>

Создаёт запрос, интерпретирующий тело как объект JavaScript с телом ответа запрошенного типа.

@parammethodstring

Метод HTTP.

@paramurlstring

URL конечной точки.

@paramoptions({ body?: any; observe?: "body" | undefined; responseType?: "json" | undefined; } & HttpClientCommonOptions) | undefined

Параметры HTTP, передаваемые вместе с запросом.

@returnsObservable<R>

Создаёт запрос, для которого тип ответа и запрошенный Observable неизвестны статически.

@parammethodstring

Метод HTTP.

@paramurlstring

URL конечной точки.

@paramoptions({ body?: any; observe?: "body" | "events" | "response" | undefined; responseType?: "arraybuffer" | "blob" | "json" | "text" | undefined; } & HttpClientCommonOptions) | undefined

Параметры HTTP, передаваемые вместе с запросом.

@returnsObservable<any>

delete

15 перегрузок

Создаёт запрос DELETE, интерпретирующий тело как ArrayBuffer и возвращающий ответ в виде ArrayBuffer.

@paramurlstring

URL конечной точки.

@paramoptions{ observe?: "body" | undefined; responseType: "arraybuffer"; body?: any; } & HttpClientCommonOptions

Параметры HTTP, передаваемые вместе с запросом.

@returnsObservable<ArrayBuffer>

Создаёт запрос DELETE, интерпретирующий тело как Blob и возвращающий ответ в виде Blob.

@paramurlstring

URL конечной точки.

@paramoptions{ observe?: "body" | undefined; responseType: "blob"; body?: any; } & HttpClientCommonOptions

Параметры HTTP, передаваемые вместе с запросом.

@returnsObservable<Blob>

Создаёт запрос DELETE, интерпретирующий тело как текстовую строку и возвращающий строку.

@paramurlstring

URL конечной точки.

@paramoptions{ observe?: "body" | undefined; responseType: "text"; body?: any; } & HttpClientCommonOptions

Параметры HTTP, передаваемые вместе с запросом.

@returnsObservable<string>

Создаёт запрос DELETE, интерпретирующий тело как ArrayBuffer и возвращающий полный поток событий.

@paramurlstring

URL конечной точки.

@paramoptions{ observe: "events"; responseType: "arraybuffer"; body?: any; } & HttpClientCommonOptions

Параметры HTTP, передаваемые вместе с запросом.

@returnsObservable<HttpEvent<ArrayBuffer>>

Создаёт запрос DELETE, интерпретирующий тело как Blob и возвращающий полный поток событий.

@paramurlstring

URL конечной точки.

@paramoptions{ observe: "events"; responseType: "blob"; body?: any; } & HttpClientCommonOptions

Параметры HTTP, передаваемые вместе с запросом.

@returnsObservable<HttpEvent<Blob>>

Создаёт запрос DELETE, интерпретирующий тело как текстовую строку и возвращающий полный поток событий.

@paramurlstring

URL конечной точки.

@paramoptions{ observe: "events"; responseType: "text"; body?: any; } & HttpClientCommonOptions

Параметры HTTP, передаваемые вместе с запросом.

@returnsObservable<HttpEvent<string>>

Создаёт запрос DELETE, интерпретирующий тело как JSON и возвращающий полный поток событий.

@paramurlstring

URL конечной точки.

@paramoptions{ observe: "events"; responseType?: "json" | undefined; body?: any; } & HttpClientCommonOptions

Параметры HTTP, передаваемые вместе с запросом.

@returnsObservable<HttpEvent<Object>>

Создаёт запрос DELETE, интерпретирующий тело как JSON и возвращающий полный поток событий.

@paramurlstring

URL конечной точки.

@paramoptions{ observe: "events"; responseType?: "json" | undefined; body?: any; } & HttpClientCommonOptions

Параметры HTTP, передаваемые вместе с запросом.

@returnsObservable<HttpEvent<T>>

Создаёт запрос DELETE, интерпретирующий тело как ArrayBuffer и возвращающий полный HttpResponse.

@paramurlstring

URL конечной точки.

@paramoptions{ observe: "response"; responseType: "arraybuffer"; body?: any; } & HttpClientCommonOptions

Параметры HTTP, передаваемые вместе с запросом.

@returnsObservable<HttpResponse<ArrayBuffer>>

Создаёт запрос DELETE, интерпретирующий тело как Blob и возвращающий полный HttpResponse.

@paramurlstring

URL конечной точки.

@paramoptions{ observe: "response"; responseType: "blob"; body?: any; } & HttpClientCommonOptions

Параметры HTTP, передаваемые вместе с запросом.

@returnsObservable<HttpResponse<Blob>>

Создаёт запрос DELETE, интерпретирующий тело как текстовый поток и возвращающий полный HttpResponse.

@paramurlstring

URL конечной точки.

@paramoptions{ observe: "response"; responseType: "text"; body?: any; } & HttpClientCommonOptions

Параметры HTTP, передаваемые вместе с запросом.

@returnsObservable<HttpResponse<string>>

Создаёт запрос DELETE, интерпретирующий тело как объект JavaScript и возвращающий полный HttpResponse.

@paramurlstring

URL конечной точки.

@paramoptions{ observe: "response"; responseType?: "json" | undefined; body?: any; } & HttpClientCommonOptions

Параметры HTTP, передаваемые вместе с запросом.

@returnsObservable<HttpResponse<Object>>

Создаёт запрос DELETE, интерпретирующий тело как JSON и возвращающий полный HttpResponse.

@paramurlstring

URL конечной точки.

@paramoptions{ observe: "response"; responseType?: "json" | undefined; body?: any; } & HttpClientCommonOptions

Параметры HTTP, передаваемые вместе с запросом.

@returnsObservable<HttpResponse<T>>

Создаёт запрос DELETE, интерпретирующий тело как JSON и возвращающий тело ответа в виде объекта, полученного из JSON.

@paramurlstring

URL конечной точки.

@paramoptions({ observe?: "body" | undefined; responseType?: "json" | undefined; body?: any; } & HttpClientCommonOptions) | undefined

Параметры HTTP, передаваемые вместе с запросом.

@returnsObservable<Object>

Создаёт запрос DELETE, интерпретирующий тело как JSON и возвращающий ответ в заданном типе.

@paramurlstring

URL конечной точки.

@paramoptions({ observe?: "body" | undefined; responseType?: "json" | undefined; body?: any; } & HttpClientCommonOptions) | undefined

Параметры HTTP, передаваемые вместе с запросом.

@returnsObservable<T>

get

15 перегрузок

Создаёт запрос GET, интерпретирующий тело как ArrayBuffer и возвращающий ответ в виде ArrayBuffer.

@paramurlstring

URL конечной точки.

@paramoptions{ observe?: "body" | undefined; responseType: "arraybuffer"; } & HttpClientCommonOptions

Параметры HTTP, передаваемые вместе с запросом.

@returnsObservable<ArrayBuffer>

Создаёт запрос GET, интерпретирующий тело как Blob и возвращающий ответ в виде Blob.

@paramurlstring

URL конечной точки.

@paramoptions{ observe?: "body" | undefined; responseType: "blob"; } & HttpClientCommonOptions

Параметры HTTP, передаваемые вместе с запросом.

@returnsObservable<Blob>

Создаёт запрос GET, интерпретирующий тело как текстовую строку и возвращающий ответ в виде строкового значения.

@paramurlstring

URL конечной точки.

@paramoptions{ observe?: "body" | undefined; responseType: "text"; } & HttpClientCommonOptions

Параметры HTTP, передаваемые вместе с запросом.

@returnsObservable<string>

Создаёт запрос GET, интерпретирующий тело как ArrayBuffer и возвращающий полный поток событий.

@paramurlstring

URL конечной точки.

@paramoptions{ observe: "events"; responseType: "arraybuffer"; } & HttpClientCommonOptions

Параметры HTTP, передаваемые вместе с запросом.

@returnsObservable<HttpEvent<ArrayBuffer>>

Создаёт запрос GET, интерпретирующий тело как Blob и возвращающий полный поток событий.

@paramurlstring

URL конечной точки.

@paramoptions{ observe: "events"; responseType: "blob"; } & HttpClientCommonOptions

Параметры HTTP, передаваемые вместе с запросом.

@returnsObservable<HttpEvent<Blob>>

Создаёт запрос GET, интерпретирующий тело как текстовую строку и возвращающий полный поток событий.

@paramurlstring

URL конечной точки.

@paramoptions{ observe: "events"; responseType: "text"; } & HttpClientCommonOptions

Параметры HTTP, передаваемые вместе с запросом.

@returnsObservable<HttpEvent<string>>

Создаёт запрос GET, интерпретирующий тело как JSON и возвращающий полный поток событий.

@paramurlstring

URL конечной точки.

@paramoptions{ observe: "events"; responseType?: "json" | undefined; } & HttpClientCommonOptions

Параметры HTTP, передаваемые вместе с запросом.

@returnsObservable<HttpEvent<Object>>

Создаёт запрос GET, интерпретирующий тело как JSON и возвращающий полный поток событий.

@paramurlstring

URL конечной точки.

@paramoptions{ observe: "events"; responseType?: "json" | undefined; } & HttpClientCommonOptions

Параметры HTTP, передаваемые вместе с запросом.

@returnsObservable<HttpEvent<T>>

Создаёт запрос GET, интерпретирующий тело как ArrayBuffer и возвращающий полный HttpResponse.

@paramurlstring

URL конечной точки.

@paramoptions{ observe: "response"; responseType: "arraybuffer"; } & HttpClientCommonOptions

Параметры HTTP, передаваемые вместе с запросом.

@returnsObservable<HttpResponse<ArrayBuffer>>

Создаёт запрос GET, интерпретирующий тело как Blob и возвращающий полный HttpResponse.

@paramurlstring

URL конечной точки.

@paramoptions{ observe: "response"; responseType: "blob"; } & HttpClientCommonOptions

Параметры HTTP, передаваемые вместе с запросом.

@returnsObservable<HttpResponse<Blob>>

Создаёт запрос GET, интерпретирующий тело как текстовый поток и возвращающий полный HttpResponse.

@paramurlstring

URL конечной точки.

@paramoptions{ observe: "response"; responseType: "text"; } & HttpClientCommonOptions

Параметры HTTP, передаваемые вместе с запросом.

@returnsObservable<HttpResponse<string>>

Создаёт запрос GET, интерпретирующий тело как JSON и возвращающий полный HttpResponse.

@paramurlstring

URL конечной точки.

@paramoptions{ observe: "response"; responseType?: "json" | undefined; } & HttpClientCommonOptions

Параметры HTTP, передаваемые вместе с запросом.

@returnsObservable<HttpResponse<Object>>

Создаёт запрос GET, интерпретирующий тело как JSON и возвращающий полный HttpResponse с телом ответа указанного типа.

@paramurlstring

URL конечной точки.

@paramoptions{ observe: "response"; responseType?: "json" | undefined; } & HttpClientCommonOptions

Параметры HTTP, передаваемые вместе с запросом.

@returnsObservable<HttpResponse<T>>

Создаёт запрос GET, интерпретирующий тело как JSON и возвращающий тело ответа в виде объекта, полученного из JSON.

@paramurlstring

URL конечной точки.

@paramoptions({ observe?: "body" | undefined; responseType?: "json" | undefined; } & HttpClientCommonOptions) | undefined

Параметры HTTP, передаваемые вместе с запросом.

@returnsObservable<Object>

Создаёт запрос GET, интерпретирующий тело как JSON и возвращающий тело ответа в заданном типе.

@paramurlstring

URL конечной точки.

@paramoptions({ observe?: "body" | undefined; responseType?: "json" | undefined; } & HttpClientCommonOptions) | undefined

Параметры HTTP, передаваемые вместе с запросом.

@returnsObservable<T>

head

15 перегрузок

Создаёт запрос HEAD, интерпретирующий тело как ArrayBuffer и возвращающий ответ как ArrayBuffer.

@paramurlstring

URL конечной точки.

@paramoptions{ observe?: "body" | undefined; responseType: "arraybuffer"; } & HttpClientCommonOptions

Параметры HTTP, передаваемые вместе с запросом.

@returnsObservable<ArrayBuffer>

Создаёт запрос `HEAD`, интерпретирующий тело как `Blob` и возвращающий ответ как `Blob`.

@paramurlstring

URL конечной точки.

@paramoptions{ observe?: "body" | undefined; responseType: "blob"; } & HttpClientCommonOptions

Параметры HTTP, передаваемые вместе с запросом.

@returnsObservable<Blob>

Создаёт запрос `HEAD`, интерпретирующий тело как текстовую строку и возвращающий ответ в виде строкового значения.

@paramurlstring

URL конечной точки.

@paramoptions{ observe?: "body" | undefined; responseType: "text"; } & HttpClientCommonOptions

Параметры HTTP, передаваемые вместе с запросом.

@returnsObservable<string>

Создаёт запрос `HEAD`, интерпретирующий тело как `ArrayBuffer` и возвращающий полный поток событий.

@paramurlstring

URL конечной точки.

@paramoptions{ observe: "events"; responseType: "arraybuffer"; } & HttpClientCommonOptions

Параметры HTTP, передаваемые вместе с запросом.

@returnsObservable<HttpEvent<ArrayBuffer>>

Создаёт запрос `HEAD`, интерпретирующий тело как `Blob` и возвращающий полный поток событий.

@paramurlstring

URL конечной точки.

@paramoptions{ observe: "events"; responseType: "blob"; } & HttpClientCommonOptions

Параметры HTTP, передаваемые вместе с запросом.

@returnsObservable<HttpEvent<Blob>>

Создаёт запрос `HEAD`, интерпретирующий тело как текстовую строку и возвращающий полный поток событий.

@paramurlstring

URL конечной точки.

@paramoptions{ observe: "events"; responseType: "text"; } & HttpClientCommonOptions

Параметры HTTP, передаваемые вместе с запросом.

@returnsObservable<HttpEvent<string>>

Создаёт запрос `HEAD`, интерпретирующий тело как JSON и возвращающий полный поток событий HTTP.

@paramurlstring

URL конечной точки.

@paramoptions{ observe: "events"; responseType?: "json" | undefined; } & HttpClientCommonOptions

Параметры HTTP, передаваемые вместе с запросом.

@returnsObservable<HttpEvent<Object>>

Создаёт запрос `HEAD`, интерпретирующий тело как JSON и возвращающий полный поток событий.

@paramurlstring

URL конечной точки.

@paramoptions{ observe: "events"; responseType?: "json" | undefined; } & HttpClientCommonOptions

Параметры HTTP, передаваемые вместе с запросом.

@returnsObservable<HttpEvent<T>>

Создаёт запрос `HEAD`, интерпретирующий тело как `ArrayBuffer` и возвращающий полный ответ HTTP.

@paramurlstring

URL конечной точки.

@paramoptions{ observe: "response"; responseType: "arraybuffer"; } & HttpClientCommonOptions

Параметры HTTP, передаваемые вместе с запросом.

@returnsObservable<HttpResponse<ArrayBuffer>>

Создаёт запрос `HEAD`, интерпретирующий тело как `Blob` и возвращающий полный объект `HttpResponse`.

@paramurlstring

URL конечной точки.

@paramoptions{ observe: "response"; responseType: "blob"; } & HttpClientCommonOptions

Параметры HTTP, передаваемые вместе с запросом.

@returnsObservable<HttpResponse<Blob>>

Создаёт запрос `HEAD`, интерпретирующий тело как поток текста и возвращающий полный объект `HttpResponse`.

@paramurlstring

URL конечной точки.

@paramoptions{ observe: "response"; responseType: "text"; } & HttpClientCommonOptions

Параметры HTTP, передаваемые вместе с запросом.

@returnsObservable<HttpResponse<string>>

Создаёт запрос `HEAD`, интерпретирующий тело как JSON и возвращающий полный объект `HttpResponse`.

@paramurlstring

URL конечной точки.

@paramoptions{ observe: "response"; responseType?: "json" | undefined; } & HttpClientCommonOptions

Параметры HTTP, передаваемые вместе с запросом.

@returnsObservable<HttpResponse<Object>>

Создаёт запрос `HEAD`, интерпретирующий тело как JSON и возвращающий полный объект `HttpResponse`.

@paramurlstring

URL конечной точки.

@paramoptions{ observe: "response"; responseType?: "json" | undefined; } & HttpClientCommonOptions

Параметры HTTP, передаваемые вместе с запросом.

@returnsObservable<HttpResponse<T>>

Создаёт запрос `HEAD`, интерпретирующий тело как JSON и возвращающий тело ответа в виде объекта, созданного при разборе JSON.

@paramurlstring

URL конечной точки.

@paramoptionsHttpClientCommonOptions | undefined

Параметры HTTP, передаваемые вместе с запросом.

@returnsObservable<Object>

Создаёт запрос `HEAD`, интерпретирующий тело как JSON и возвращающий ответ в указанном типе.

@paramurlstring

URL конечной точки.

@paramoptionsHttpClientCommonOptions | undefined

Параметры HTTP, передаваемые вместе с запросом.

@returnsObservable<T>

jsonp

2 перегрузки

Создаёт запрос JSONP для указанного URL и имени параметра обратного вызова.

@paramurlstring

URL ресурса.

@paramcallbackParamstring

Имя функции обратного вызова.

@returnsObservable<Object>

Создаёт запрос JSONP для указанного URL и имени параметра обратного вызова.

@paramurlstring

URL ресурса.

@paramcallbackParamstring

Имя функции обратного вызова.

Необходимо установить подходящий перехватчик, например предоставляемый модулем HttpClientJsonpModule. Если запрос не будет обработан таким перехватчиком, настроенный серверный обработчик может отклонить запрос JSONP.

@returnsObservable<T>

options

15 перегрузок

Создаёт запрос OPTIONS, интерпретирующий тело как ArrayBuffer и возвращающий ответ как ArrayBuffer.

@paramurlstring

URL конечной точки.

@paramoptions{ observe?: "body" | undefined; responseType: "arraybuffer"; } & HttpClientCommonOptions

Параметры HTTP.

@returnsObservable<ArrayBuffer>

Создаёт запрос `OPTIONS`, интерпретирующий тело как `Blob` и возвращающий ответ как `Blob`.

@paramurlstring

URL конечной точки.

@paramoptions{ observe?: "body" | undefined; responseType: "blob"; } & HttpClientCommonOptions

Параметры HTTP.

@returnsObservable<Blob>

Создаёт запрос `OPTIONS`, интерпретирующий тело как текстовую строку и возвращающий строковое значение.

@paramurlstring

URL конечной точки.

@paramoptions{ observe?: "body" | undefined; responseType: "text"; } & HttpClientCommonOptions

Параметры HTTP.

@returnsObservable<string>

Создаёт запрос OPTIONS, интерпретирующий тело как ArrayBuffer и возвращающий полный поток событий.

@paramurlstring

URL конечной точки.

@paramoptions{ observe: "events"; responseType: "arraybuffer"; } & HttpClientCommonOptions

Параметры HTTP.

@returnsObservable<HttpEvent<ArrayBuffer>>

Создаёт запрос `OPTIONS`, интерпретирующий тело как `Blob` и возвращающий полный поток событий.

@paramurlstring

URL конечной точки.

@paramoptions{ observe: "events"; responseType: "blob"; } & HttpClientCommonOptions

Параметры HTTP.

@returnsObservable<HttpEvent<Blob>>

Создаёт запрос `OPTIONS`, интерпретирующий тело как текстовую строку и возвращающий полный поток событий.

@paramurlstring

URL конечной точки.

@paramoptions{ observe: "events"; responseType: "text"; } & HttpClientCommonOptions

Параметры HTTP.

@returnsObservable<HttpEvent<string>>

Создаёт запрос `OPTIONS`, интерпретирующий тело как JSON и возвращающий полный поток событий.

@paramurlstring

URL конечной точки.

@paramoptions{ observe: "events"; responseType?: "json" | undefined; } & HttpClientCommonOptions

Параметры HTTP.

@returnsObservable<HttpEvent<Object>>

Создаёт запрос `OPTIONS`, интерпретирующий тело как JSON и возвращающий полный поток событий.

@paramurlstring

URL конечной точки.

@paramoptions{ observe: "events"; responseType?: "json" | undefined; } & HttpClientCommonOptions

Параметры HTTP.

@returnsObservable<HttpEvent<T>>

Создаёт запрос OPTIONS, интерпретирующий тело как ArrayBuffer и возвращающий полный ответ HTTP.

@paramurlstring

URL конечной точки.

@paramoptions{ observe: "response"; responseType: "arraybuffer"; } & HttpClientCommonOptions

Параметры HTTP.

@returnsObservable<HttpResponse<ArrayBuffer>>

Создаёт запрос `OPTIONS`, интерпретирующий тело как `Blob` и возвращающий полный объект `HttpResponse`.

@paramurlstring

URL конечной точки.

@paramoptions{ observe: "response"; responseType: "blob"; } & HttpClientCommonOptions

Параметры HTTP.

@returnsObservable<HttpResponse<Blob>>

Создаёт запрос `OPTIONS`, интерпретирующий тело как поток текста и возвращающий полный объект `HttpResponse`.

@paramurlstring

URL конечной точки.

@paramoptions{ observe: "response"; responseType: "text"; } & HttpClientCommonOptions

Параметры HTTP.

@returnsObservable<HttpResponse<string>>

Создаёт запрос `OPTIONS`, интерпретирующий тело как JSON и возвращающий полный объект `HttpResponse`.

@paramurlstring

URL конечной точки.

@paramoptions{ observe: "response"; responseType?: "json" | undefined; } & HttpClientCommonOptions

Параметры HTTP.

@returnsObservable<HttpResponse<Object>>

Создаёт запрос `OPTIONS`, интерпретирующий тело как JSON и возвращающий полный объект `HttpResponse`.

@paramurlstring

URL конечной точки.

@paramoptions{ observe: "response"; responseType?: "json" | undefined; } & HttpClientCommonOptions

Параметры HTTP.

@returnsObservable<HttpResponse<T>>

Создаёт запрос `OPTIONS`, интерпретирующий тело как JSON и возвращающий тело ответа в виде объекта, созданного при разборе JSON.

@paramurlstring

URL конечной точки.

@paramoptionsHttpClientCommonOptions | undefined

Параметры HTTP.

@returnsObservable<Object>

Создаёт запрос `OPTIONS`, интерпретирующий тело как JSON и возвращающий ответ в указанном типе.

@paramurlstring

URL конечной точки.

@paramoptionsHttpClientCommonOptions | undefined

Параметры HTTP.

@returnsObservable<T>

patch

15 перегрузок

Создает запрос PATCH, который интерпретирует тело как ArrayBuffer и возвращает ответ в виде ArrayBuffer.

@paramurlstring

URL конечной точки.

@parambodyany

Ресурсы для редактирования.

@paramoptions{ observe?: "body" | undefined; responseType: "arraybuffer"; } & HttpClientCommonOptions

Параметры HTTP.

@returnsObservable<ArrayBuffer>

Создает запрос `PATCH`, который интерпретирует тело как `Blob` и возвращает ответ в виде `Blob`.

@paramurlstring

URL конечной точки.

@parambodyany

Ресурсы для редактирования.

@paramoptions{ observe?: "body" | undefined; responseType: "blob"; } & HttpClientCommonOptions

Параметры HTTP.

@returnsObservable<Blob>

Создает запрос `PATCH`, который интерпретирует тело как текстовую строку и возвращает ответ в виде строкового значения.

@paramurlstring

URL конечной точки.

@parambodyany

Ресурсы для редактирования.

@paramoptions{ observe?: "body" | undefined; responseType: "text"; } & HttpClientCommonOptions

Параметры HTTP.

@returnsObservable<string>

Создает запрос PATCH, который интерпретирует тело как ArrayBuffer и возвращает полный поток событий.

@paramurlstring

URL конечной точки.

@parambodyany

Ресурсы для редактирования.

@paramoptions{ observe: "events"; responseType: "arraybuffer"; } & HttpClientCommonOptions

Параметры HTTP.

@returnsObservable<HttpEvent<ArrayBuffer>>

Создает запрос PATCH, который интерпретирует тело как Blob и возвращает полный поток событий.

@paramurlstring

URL конечной точки.

@parambodyany

Ресурсы для редактирования.

@paramoptions{ observe: "events"; responseType: "blob"; } & HttpClientCommonOptions

Параметры HTTP.

@returnsObservable<HttpEvent<Blob>>

Создает запрос PATCH, который интерпретирует тело как текстовую строку и возвращает полный поток событий.

@paramurlstring

URL конечной точки.

@parambodyany

Ресурсы для редактирования.

@paramoptions{ observe: "events"; responseType: "text"; } & HttpClientCommonOptions

Параметры HTTP.

@returnsObservable<HttpEvent<string>>

Создает запрос PATCH, который интерпретирует тело как JSON и возвращает полный поток событий.

@paramurlstring

URL конечной точки.

@parambodyany

Ресурсы для редактирования.

@paramoptions{ observe: "events"; responseType?: "json" | undefined; } & HttpClientCommonOptions

Параметры HTTP.

@returnsObservable<HttpEvent<Object>>

Создает запрос PATCH, который интерпретирует тело как JSON и возвращает полный поток событий.

@paramurlstring

URL конечной точки.

@parambodyany

Ресурсы для редактирования.

@paramoptions{ observe: "events"; responseType?: "json" | undefined; } & HttpClientCommonOptions

Параметры HTTP.

@returnsObservable<HttpEvent<T>>

Создает запрос PATCH, который интерпретирует тело как ArrayBuffer и возвращает полный HttpResponse.

@paramurlstring

URL конечной точки.

@parambodyany

Ресурсы для редактирования.

@paramoptions{ observe: "response"; responseType: "arraybuffer"; } & HttpClientCommonOptions

Параметры HTTP.

@returnsObservable<HttpResponse<ArrayBuffer>>

Создает запрос PATCH, который интерпретирует тело как Blob и возвращает полный HttpResponse.

@paramurlstring

URL конечной точки.

@parambodyany

Ресурсы для редактирования.

@paramoptions{ observe: "response"; responseType: "blob"; } & HttpClientCommonOptions

Параметры HTTP.

@returnsObservable<HttpResponse<Blob>>

Создает запрос PATCH, который интерпретирует тело как текстовый поток и возвращает полный HttpResponse.

@paramurlstring

URL конечной точки.

@parambodyany

Ресурсы для редактирования.

@paramoptions{ observe: "response"; responseType: "text"; } & HttpClientCommonOptions

Параметры HTTP.

@returnsObservable<HttpResponse<string>>

Создает запрос PATCH, который интерпретирует тело как JSON и возвращает полный HttpResponse.

@paramurlstring

URL конечной точки.

@parambodyany

Ресурсы для редактирования.

@paramoptions{ observe: "response"; responseType?: "json" | undefined; } & HttpClientCommonOptions

Параметры HTTP.

@returnsObservable<HttpResponse<Object>>

Создает запрос PATCH, который интерпретирует тело как JSON и возвращает полный HttpResponse.

@paramurlstring

URL конечной точки.

@parambodyany

Ресурсы для редактирования.

@paramoptions{ observe: "response"; responseType?: "json" | undefined; } & HttpClientCommonOptions

Параметры HTTP.

@returnsObservable<HttpResponse<T>>

Создает запрос `PATCH`, который интерпретирует тело как JSON и возвращает тело ответа в виде объекта, полученного в результате разбора JSON.

@paramurlstring

URL конечной точки.

@parambodyany

Ресурсы для редактирования.

@paramoptionsHttpClientCommonOptions | undefined

Параметры HTTP.

@returnsObservable<Object>

Создает запрос `PATCH`, который интерпретирует тело как JSON и возвращает ответ в указанном типе.

@paramurlstring

URL конечной точки.

@parambodyany

Ресурсы для редактирования.

@paramoptionsHttpClientCommonOptions | undefined

Параметры HTTP.

@returnsObservable<T>

post

15 перегрузок

Создает запрос POST, который интерпретирует тело как ArrayBuffer и возвращает ArrayBuffer.

@paramurlstring

URL конечной точки.

@parambodyany

Содержимое, которым нужно заменить.

@paramoptions{ observe?: "body" | undefined; responseType: "arraybuffer"; } & HttpClientCommonOptions

Параметры HTTP.

@returnsObservable<ArrayBuffer>

Создает запрос `POST`, который интерпретирует тело как `Blob` и возвращает ответ в виде `Blob`.

@paramurlstring

URL конечной точки.

@parambodyany

Содержимое, которым нужно заменить.

@paramoptions{ observe?: "body" | undefined; responseType: "blob"; } & HttpClientCommonOptions

Параметры HTTP

@returnsObservable<Blob>

Создает запрос `POST`, который интерпретирует тело как текстовую строку и возвращает ответ в виде строкового значения.

@paramurlstring

URL конечной точки.

@parambodyany

Содержимое, которым нужно заменить.

@paramoptions{ observe?: "body" | undefined; responseType: "text"; } & HttpClientCommonOptions

Параметры HTTP

@returnsObservable<string>

Создает запрос POST, который интерпретирует тело как ArrayBuffer и возвращает полный поток событий.

@paramurlstring

URL конечной точки.

@parambodyany

Содержимое, которым нужно заменить.

@paramoptions{ observe: "events"; responseType: "arraybuffer"; } & HttpClientCommonOptions

Параметры HTTP

@returnsObservable<HttpEvent<ArrayBuffer>>

Создает запрос POST, который интерпретирует тело как Blob и возвращает ответ в виде наблюдаемого объекта с полным потоком событий.

@paramurlstring

URL конечной точки.

@parambodyany

Содержимое, которым нужно заменить.

@paramoptions{ observe: "events"; responseType: "blob"; } & HttpClientCommonOptions

Параметры HTTP

@returnsObservable<HttpEvent<Blob>>

Создает запрос POST, который интерпретирует тело как текстовую строку и возвращает полный поток событий.

@paramurlstring

URL конечной точки.

@parambodyany

Содержимое, которым нужно заменить.

@paramoptions{ observe: "events"; responseType: "text"; } & HttpClientCommonOptions

Параметры HTTP

@returnsObservable<HttpEvent<string>>

Создает запрос POST, который интерпретирует тело как JSON и возвращает полный поток событий.

@paramurlstring

URL конечной точки.

@parambodyany

Содержимое, которым нужно заменить.

@paramoptions{ observe: "events"; responseType?: "json" | undefined; } & HttpClientCommonOptions

Параметры HTTP

@returnsObservable<HttpEvent<Object>>

Создает запрос POST, который интерпретирует тело как JSON и возвращает полный поток событий.

@paramurlstring

URL конечной точки.

@parambodyany

Содержимое, которым нужно заменить.

@paramoptions{ observe: "events"; responseType?: "json" | undefined; } & HttpClientCommonOptions

Параметры HTTP

@returnsObservable<HttpEvent<T>>

Создает запрос POST, который интерпретирует тело как ArrayBuffer и возвращает полный HttpResponse.

@paramurlstring

URL конечной точки.

@parambodyany

Содержимое, которым нужно заменить.

@paramoptions{ observe: "response"; responseType: "arraybuffer"; } & HttpClientCommonOptions

Параметры HTTP

@returnsObservable<HttpResponse<ArrayBuffer>>

Создает запрос POST, который интерпретирует тело как Blob и возвращает полный HttpResponse.

@paramurlstring

URL конечной точки.

@parambodyany

Содержимое, которым нужно заменить.

@paramoptions{ observe: "response"; responseType: "blob"; } & HttpClientCommonOptions

Параметры HTTP

@returnsObservable<HttpResponse<Blob>>

Создает запрос POST, который интерпретирует тело как текстовый поток и возвращает полный HttpResponse.

@paramurlstring

URL конечной точки.

@parambodyany

Содержимое, которым нужно заменить.

@paramoptions{ observe: "response"; responseType: "text"; } & HttpClientCommonOptions

Параметры HTTP

@returnsObservable<HttpResponse<string>>

Создает запрос POST, который интерпретирует тело как JSON и возвращает полный HttpResponse.

@paramurlstring

URL конечной точки.

@parambodyany

Содержимое, которым нужно заменить.

@paramoptions{ observe: "response"; responseType?: "json" | undefined; } & HttpClientCommonOptions

Параметры HTTP

@returnsObservable<HttpResponse<Object>>

Создает запрос POST, который интерпретирует тело как JSON и возвращает полный HttpResponse.

@paramurlstring

URL конечной точки.

@parambodyany

Содержимое, которым нужно заменить.

@paramoptions{ observe: "response"; responseType?: "json" | undefined; } & HttpClientCommonOptions

Параметры HTTP

@returnsObservable<HttpResponse<T>>

Создает запрос POST, который интерпретирует тело как JSON и возвращает тело ответа в виде объекта, полученного при разборе JSON.

@paramurlstring

URL конечной точки.

@parambodyany

Содержимое, которым нужно заменить.

@paramoptionsHttpClientCommonOptions | undefined

Параметры HTTP

@returnsObservable<Object>

Создает запрос POST, который интерпретирует тело как JSON и возвращает наблюдаемый объект с ответом.

@paramurlstring

URL конечной точки.

@parambodyany

Содержимое, которым нужно заменить.

@paramoptionsHttpClientCommonOptions | undefined

Параметры HTTP

@returnsObservable<T>

put

15 перегрузок

Создает запрос PUT, который интерпретирует тело как ArrayBuffer и возвращает ответ как ArrayBuffer.

@paramurlstring

URL конечной точки.

@parambodyany

Ресурсы для добавления или обновления.

@paramoptions{ observe?: "body" | undefined; responseType: "arraybuffer"; } & HttpClientCommonOptions

Параметры HTTP

@returnsObservable<ArrayBuffer>

Создает запрос PUT, который интерпретирует тело как Blob и возвращает ответ как Blob.

@paramurlstring

URL конечной точки.

@parambodyany

Ресурсы для добавления или обновления.

@paramoptions{ observe?: "body" | undefined; responseType: "blob"; } & HttpClientCommonOptions

Параметры HTTP

@returnsObservable<Blob>

Создает запрос PUT, который интерпретирует тело как текстовую строку и возвращает ответ в виде строкового значения.

@paramurlstring

URL конечной точки.

@parambodyany

Ресурсы для добавления или обновления.

@paramoptions{ observe?: "body" | undefined; responseType: "text"; } & HttpClientCommonOptions

Параметры HTTP

@returnsObservable<string>

Создает запрос PUT, который интерпретирует тело как ArrayBuffer и возвращает полный поток событий.

@paramurlstring

URL конечной точки.

@parambodyany

Ресурсы для добавления или обновления.

@paramoptions{ observe: "events"; responseType: "arraybuffer"; } & HttpClientCommonOptions

Параметры HTTP

@returnsObservable<HttpEvent<ArrayBuffer>>

Создает запрос PUT, который интерпретирует тело как Blob и возвращает полный поток событий.

@paramurlstring

URL конечной точки.

@parambodyany

Ресурсы для добавления или обновления.

@paramoptions{ observe: "events"; responseType: "blob"; } & HttpClientCommonOptions

Параметры HTTP

@returnsObservable<HttpEvent<Blob>>

Создает запрос PUT, который интерпретирует тело как текстовую строку и возвращает полный поток событий.

@paramurlstring

URL конечной точки.

@parambodyany

Ресурсы для добавления или обновления.

@paramoptions{ observe: "events"; responseType: "text"; } & HttpClientCommonOptions

Параметры HTTP

@returnsObservable<HttpEvent<string>>

Создает запрос PUT, который интерпретирует тело как JSON и возвращает полный поток событий.

@paramurlstring

URL конечной точки.

@parambodyany

Ресурсы для добавления или обновления.

@paramoptions{ observe: "events"; responseType?: "json" | undefined; } & HttpClientCommonOptions

Параметры HTTP

@returnsObservable<HttpEvent<Object>>

Создает запрос PUT, который интерпретирует тело как JSON и возвращает полный поток событий.

@paramurlstring

URL конечной точки.

@parambodyany

Ресурсы для добавления или обновления.

@paramoptions{ observe: "events"; responseType?: "json" | undefined; } & HttpClientCommonOptions

Параметры HTTP

@returnsObservable<HttpEvent<T>>

Создает запрос PUT, который интерпретирует тело как ArrayBuffer и возвращает Observable с полным ответом HTTP.

@paramurlstring

URL конечной точки.

@parambodyany

Ресурсы для добавления или обновления.

@paramoptions{ observe: "response"; responseType: "arraybuffer"; } & HttpClientCommonOptions

Параметры HTTP

@returnsObservable<HttpResponse<ArrayBuffer>>

Создает запрос PUT, который интерпретирует тело как Blob и возвращает полный ответ HTTP.

@paramurlstring

URL конечной точки.

@parambodyany

Ресурсы для добавления или обновления.

@paramoptions{ observe: "response"; responseType: "blob"; } & HttpClientCommonOptions

Параметры HTTP

@returnsObservable<HttpResponse<Blob>>

Создает запрос PUT, который интерпретирует тело как текстовый поток и возвращает полный ответ HTTP.

@paramurlstring

URL конечной точки.

@parambodyany

Ресурсы для добавления или обновления.

@paramoptions{ observe: "response"; responseType: "text"; } & HttpClientCommonOptions

Параметры HTTP

@returnsObservable<HttpResponse<string>>

Создает запрос PUT, который интерпретирует тело как JSON и возвращает полный ответ HTTP.

@paramurlstring

URL конечной точки.

@parambodyany

Ресурсы для добавления или обновления.

@paramoptions{ observe: "response"; responseType?: "json" | undefined; } & HttpClientCommonOptions

Параметры HTTP

@returnsObservable<HttpResponse<Object>>

Создает запрос PUT, который интерпретирует тело как экземпляр запрошенного типа и возвращает полный ответ HTTP.

@paramurlstring

URL конечной точки.

@parambodyany

Ресурсы для добавления или обновления.

@paramoptions{ observe: "response"; responseType?: "json" | undefined; } & HttpClientCommonOptions

Параметры HTTP

@returnsObservable<HttpResponse<T>>

Создает запрос PUT, который интерпретирует тело как JSON и возвращает Observable с объектом JavaScript.

@paramurlstring

URL конечной точки.

@parambodyany

Ресурсы для добавления или обновления.

@paramoptionsHttpClientCommonOptions | undefined

Параметры HTTP

@returnsObservable<Object>

Создает запрос PUT, который интерпретирует тело как экземпляр запрошенного типа и возвращает Observable запрошенного типа.

@paramurlstring

URL конечной точки.

@parambodyany

Ресурсы для добавления или обновления.

@paramoptionsHttpClientCommonOptions | undefined

Параметры HTTP

@returnsObservable<T>

Описание

Выполняет HTTP-запросы. Этот сервис доступен в виде внедряемого класса с методами для выполнения HTTP-запросов. У каждого метода запроса есть несколько сигнатур, а тип возвращаемого значения зависит от вызванной сигнатуры (в основном от значений observe и responseType).

Обратите внимание, что значение responseType options — это строка, определяющая единственный тип данных ответа. Для каждого типа ответа предусмотрена отдельная версия перегруженного метода. Значение responseType не может быть объединением типов, несмотря на то, что это может подразумевать объединенная сигнатура.

Примечания по использованию

Пример HTTP-запроса 

 // GET heroes whose name contains search term
searchHeroes(term: string): observable<Hero[]>{

 const params = new HttpParams({fromString: 'name=term'});
   return this.httpClient.request('GET', this.heroesUrl, {responseType:'json', params});
}

Кроме того, строку параметров можно использовать без вызова HttpParams, напрямую добавив ее к URL.

this.httpClient.request('GET', this.heroesUrl + '?' + 'name=term', {responseType:'json'});

Пример JSONP 

requestJsonp(url, callback = 'callback') {
 return this.httpClient.jsonp(this.heroesURL, callback);
}

Пример PATCH 

// PATCH one of the heroes' name
patchHero (id: number, heroName: string): Observable<{}> {
const url = `${this.heroesUrl}/${id}`;   // PATCH api/heroes/42
 return this.httpClient.patch(url, {name: heroName}, httpOptions)
   .pipe(catchError(this.handleError('patchHero')));
}

Super-powered by Google ©2010–2025.
Code licensed under an MIT-style License. Documentation licensed under CC BY 4.0.
https://angular.dev/api/common/http/HttpClient

Spec-Zone.ru

Настройки Оффлайн Что нового Помощь О нас
Spec-Zone .ru
спецификации, руководства, описания, API