Class HttpRequest<T>

constructor

• new HttpRequest<T>(
      method: HttpMethod,
      url: string,
      options?: {
          body?: T;
          context?: HttpContext;
          headers?:
              | string
              | HttpHeaders
              | { [name: string]: string
              | number
              | (string | number)[] }
              | Headers;
          params?:
              | null
              | string
              | HttpParams
              | {
                  [param: string]: | string
                  | number
                  | boolean
                  | readonly (string | number | boolean)[];
              };
          reportProgress?: boolean;
          responseType?: HttpResponseType;
          withCredentials?: boolean;
      },
  ): HttpRequest<T>

  Type Parameters

  • T

  Parameters

  • method: HttpMethod
  • url: string
  • Optionaloptions: {
        body?: T;
        context?: HttpContext;
        headers?:
            | string
            | HttpHeaders
            | { [name: string]: string
            | number
            | (string | number)[] }
            | Headers;
        params?:
            | null
            | string
            | HttpParams
            | {
                [param: string]: | string
                | number
                | boolean
                | readonly (string | number | boolean)[];
            };
        reportProgress?: boolean;
        responseType?: HttpResponseType;
        withCredentials?: boolean;
    }

  Returns HttpRequest<T>

Readonlybody

Readonlycontext

Readonlyheaders

Readonlymethod

Readonlyparams

ReadonlyreportProgress

ReadonlyresponseType

Readonlyurl

ReadonlyurlWithParams

ReadonlywithCredentials

clone

• clone<D = T>(
      update?: Partial<PickProperty<HttpRequest<unknown>>>,
  ): HttpRequest<D>

  Type Parameters

  • D = T

  Parameters

  • update: Partial<PickProperty<HttpRequest<unknown>>> = {}

  Returns HttpRequest<D>

detectContentTypeHeader

• detectContentTypeHeader(): null | string

  Examine the body and attempt to infer an appropriate MIME type for it. If no such type can be inferred, this method will return null.

  Returns null | string

serializeBody

• serializeBody(): null | string | ArrayBuffer | Blob | FormData | URLSearchParams

  Transform the free-form body into a serialized format suitable for transmission to the server.

  Returns null | string | ArrayBuffer | Blob | FormData | URLSearchParams