Class HttpClient

Hierarchy

HttpClient

Index

Methods

delete get head options patch post put request

Methods

delete

delete<T>(url: StringOrRef, options?: VHttpReqOptions): Observable<T>
Triggers a DELETE method call that is executed when the observable is subscribed to
Type Parameters
- T
Parameters
- url: StringOrRef
- Optional options: VHttpReqOptions
Returns Observable<T>
delete<T>(url: StringOrRef, options?: { body?: URLSearchParams; headers?: Record<string, StringOrRef>; observe?: "response"; queryParams?: Record<string, StringOrRef>; responseType?: RequestResponseType }): Observable<VHttpEvent<T>>
Type Parameters
- T
Parameters
- url: StringOrRef
- Optional options: { body?: URLSearchParams; headers?: Record<string, StringOrRef>; observe?: "response"; queryParams?: Record<string, StringOrRef>; responseType?: RequestResponseType }
  - Optional body?: URLSearchParams
  - Optional headers?: Record<string, StringOrRef>
  - Optional observe?: "response"
  - Optional queryParams?: Record<string, StringOrRef>
  - Optional responseType?: RequestResponseType
Returns Observable<VHttpEvent<T>>

get

get<T>(url: StringOrRef, options: { body?: URLSearchParams; headers?: Record<string, StringOrRef>; observe?: "response"; queryParams?: Record<string, StringOrRef>; responseType?: RequestResponseType }): Observable<VHttpEvent<T>>
Triggers a GET method call that is executed when the observable is subscribed to

Returns
Type Parameters
- T
Parameters
- url: StringOrRef
- options: { body?: URLSearchParams; headers?: Record<string, StringOrRef>; observe?: "response"; queryParams?: Record<string, StringOrRef>; responseType?: RequestResponseType }
  - Optional body?: URLSearchParams
  - Optional headers?: Record<string, StringOrRef>
  - Optional observe?: "response"
  - Optional queryParams?: Record<string, StringOrRef>
  - Optional responseType?: RequestResponseType
Returns Observable<VHttpEvent<T>>
get<T>(url: StringOrRef, options?: VHttpReqOptions): Observable<T>
Type Parameters
- T
Parameters
- url: StringOrRef
- Optional options: VHttpReqOptions
Returns Observable<T>

head

head<T>(url: StringOrRef, options?: VHttpReqOptions): Observable<T>
Triggers a HEAD method call that is executed when the observable is subscribed to

Returns
Type Parameters
- T
Parameters
- url: StringOrRef
- Optional options: VHttpReqOptions
Returns Observable<T>
head<T>(url: StringOrRef, options?: { body?: URLSearchParams; headers?: Record<string, StringOrRef>; observe?: "response"; queryParams?: Record<string, StringOrRef>; responseType?: RequestResponseType }): Observable<VHttpEvent<T>>
Type Parameters
- T
Parameters
- url: StringOrRef
- Optional options: { body?: URLSearchParams; headers?: Record<string, StringOrRef>; observe?: "response"; queryParams?: Record<string, StringOrRef>; responseType?: RequestResponseType }
  - Optional body?: URLSearchParams
  - Optional headers?: Record<string, StringOrRef>
  - Optional observe?: "response"
  - Optional queryParams?: Record<string, StringOrRef>
  - Optional responseType?: RequestResponseType
Returns Observable<VHttpEvent<T>>

options

options<T>(url: StringOrRef, options?: VHttpReqOptions): Observable<T>
Triggers an OPTIONS method call that is executed when the observable is subscribed to

Returns
Type Parameters
- T
Parameters
- url: StringOrRef
- Optional options: VHttpReqOptions
Returns Observable<T>
options<T>(url: StringOrRef, options?: { body?: URLSearchParams; headers?: Record<string, StringOrRef>; observe?: "response"; queryParams?: Record<string, StringOrRef>; responseType?: RequestResponseType }): Observable<VHttpEvent<T>>
Type Parameters
- T
Parameters
- url: StringOrRef
- Optional options: { body?: URLSearchParams; headers?: Record<string, StringOrRef>; observe?: "response"; queryParams?: Record<string, StringOrRef>; responseType?: RequestResponseType }
  - Optional body?: URLSearchParams
  - Optional headers?: Record<string, StringOrRef>
  - Optional observe?: "response"
  - Optional queryParams?: Record<string, StringOrRef>
  - Optional responseType?: RequestResponseType
Returns Observable<VHttpEvent<T>>

patch

patch<T>(url: StringOrRef, body: RequestBody, options?: VHttpReqOptions): Observable<T>
Triggers a PATCH method call that is executed when the observable is subscribed to

Returns
Type Parameters
- T
Parameters
- url: StringOrRef
- body: RequestBody
- Optional options: VHttpReqOptions
Returns Observable<T>
patch<T>(url: StringOrRef, body: RequestBody, options?: { body?: URLSearchParams; headers?: Record<string, StringOrRef>; observe?: "response"; queryParams?: Record<string, StringOrRef>; responseType?: RequestResponseType }): Observable<VHttpEvent<T>>
Type Parameters
- T
Parameters
- url: StringOrRef
- body: RequestBody
- Optional options: { body?: URLSearchParams; headers?: Record<string, StringOrRef>; observe?: "response"; queryParams?: Record<string, StringOrRef>; responseType?: RequestResponseType }
  - Optional body?: URLSearchParams
  - Optional headers?: Record<string, StringOrRef>
  - Optional observe?: "response"
  - Optional queryParams?: Record<string, StringOrRef>
  - Optional responseType?: RequestResponseType
Returns Observable<VHttpEvent<T>>

post

post<T>(url: StringOrRef, body: RequestBody, options?: VHttpReqOptions): Observable<T>
Triggers a POST method call that is executed when the observable is subscribed to

Returns
Type Parameters
- T
Parameters
- url: StringOrRef
- body: RequestBody
- Optional options: VHttpReqOptions
Returns Observable<T>
post<T>(url: StringOrRef, body: RequestBody, options?: { body?: URLSearchParams; headers?: Record<string, StringOrRef>; observe?: "response"; queryParams?: Record<string, StringOrRef>; responseType?: RequestResponseType }): Observable<VHttpEvent<T>>
Type Parameters
- T
Parameters
- url: StringOrRef
- body: RequestBody
- Optional options: { body?: URLSearchParams; headers?: Record<string, StringOrRef>; observe?: "response"; queryParams?: Record<string, StringOrRef>; responseType?: RequestResponseType }
  - Optional body?: URLSearchParams
  - Optional headers?: Record<string, StringOrRef>
  - Optional observe?: "response"
  - Optional queryParams?: Record<string, StringOrRef>
  - Optional responseType?: RequestResponseType
Returns Observable<VHttpEvent<T>>

put

put<T>(url: StringOrRef, body: RequestBody, options?: VHttpReqOptions): Observable<T>
Triggers a PUT method call that is executed when the observable is subscribed to

Returns
Type Parameters
- T
Parameters
- url: StringOrRef
- body: RequestBody
- Optional options: VHttpReqOptions
Returns Observable<T>
put<T>(url: StringOrRef, body: RequestBody, options?: { body?: URLSearchParams; headers?: Record<string, StringOrRef>; observe?: "response"; queryParams?: Record<string, StringOrRef>; responseType?: RequestResponseType }): Observable<VHttpEvent<T>>
Type Parameters
- T
Parameters
- url: StringOrRef
- body: RequestBody
- Optional options: { body?: URLSearchParams; headers?: Record<string, StringOrRef>; observe?: "response"; queryParams?: Record<string, StringOrRef>; responseType?: RequestResponseType }
  - Optional body?: URLSearchParams
  - Optional headers?: Record<string, StringOrRef>
  - Optional observe?: "response"
  - Optional queryParams?: Record<string, StringOrRef>
  - Optional responseType?: RequestResponseType
Returns Observable<VHttpEvent<T>>

request

request<T>(method: RequestMethod, url: StringOrRef, body: RequestBody, options?: VHttpReqOptions): Observable<T>
Returns
Type Parameters
- T
Parameters
- method: RequestMethod
  
  HTTP method used
- url: StringOrRef
- body: RequestBody
- Optional options: VHttpReqOptions
Returns Observable<T>
request<T>(method: RequestMethod, url: StringOrRef, body: RequestBody, options: { body?: URLSearchParams; headers?: Record<string, StringOrRef>; observe?: "response"; queryParams?: Record<string, StringOrRef>; responseType?: RequestResponseType }): Observable<VHttpEvent<T>>
Type Parameters
- T
Parameters
- method: RequestMethod
- url: StringOrRef
- body: RequestBody
- options: { body?: URLSearchParams; headers?: Record<string, StringOrRef>; observe?: "response"; queryParams?: Record<string, StringOrRef>; responseType?: RequestResponseType }
  - Optional body?: URLSearchParams
  - Optional headers?: Record<string, StringOrRef>
  - Optional observe?: "response"
  - Optional queryParams?: Record<string, StringOrRef>
  - Optional responseType?: RequestResponseType
Returns Observable<VHttpEvent<T>>

Class HttpClient

Hierarchy

Index

Methods

Methods

delete

Type Parameters

T

Parameters

url: StringOrRef

Optional options: VHttpReqOptions

Returns Observable<T>

Type Parameters

T

Parameters

url: StringOrRef

Optional options: { body?: URLSearchParams; headers?: Record<string, StringOrRef>; observe?: "response"; queryParams?: Record<string, StringOrRef>; responseType?: RequestResponseType }

Optional body?: URLSearchParams

Optional headers?: Record<string, StringOrRef>

Optional observe?: "response"

Optional queryParams?: Record<string, StringOrRef>

Optional responseType?: RequestResponseType

Returns Observable<VHttpEvent<T>>

get

Returns

Type Parameters

T

Parameters

url: StringOrRef

options: { body?: URLSearchParams; headers?: Record<string, StringOrRef>; observe?: "response"; queryParams?: Record<string, StringOrRef>; responseType?: RequestResponseType }

Optional body?: URLSearchParams

Optional headers?: Record<string, StringOrRef>

Optional observe?: "response"

Optional queryParams?: Record<string, StringOrRef>

Optional responseType?: RequestResponseType

Returns Observable<VHttpEvent<T>>

Type Parameters

T

Parameters

url: StringOrRef

Optional options: VHttpReqOptions

Returns Observable<T>

head

Returns

Type Parameters

T

Parameters

url: StringOrRef

Optional options: VHttpReqOptions

Returns Observable<T>

Type Parameters

T

Parameters

url: StringOrRef

Optional options: { body?: URLSearchParams; headers?: Record<string, StringOrRef>; observe?: "response"; queryParams?: Record<string, StringOrRef>; responseType?: RequestResponseType }

Optional body?: URLSearchParams

Optional headers?: Record<string, StringOrRef>

Optional observe?: "response"

Optional queryParams?: Record<string, StringOrRef>

Optional responseType?: RequestResponseType

Returns Observable<VHttpEvent<T>>

options

Returns

Type Parameters

T

Parameters

url: StringOrRef

Optional options: VHttpReqOptions

Returns Observable<T>

Type Parameters

T

Parameters

url: StringOrRef

Optional options: { body?: URLSearchParams; headers?: Record<string, StringOrRef>; observe?: "response"; queryParams?: Record<string, StringOrRef>; responseType?: RequestResponseType }

Optional body?: URLSearchParams

Optional headers?: Record<string, StringOrRef>

Optional observe?: "response"

Optional queryParams?: Record<string, StringOrRef>

Optional responseType?: RequestResponseType

Returns Observable<VHttpEvent<T>>

`Optional` options: VHttpReqOptions

`Optional` options: { body?: URLSearchParams; headers?: Record<string, StringOrRef>; observe?: "response"; queryParams?: Record<string, StringOrRef>; responseType?: RequestResponseType }

`Optional` body?: URLSearchParams

`Optional` headers?: Record<string, StringOrRef>

`Optional` observe?: "response"

`Optional` queryParams?: Record<string, StringOrRef>

`Optional` responseType?: RequestResponseType

`Optional` body?: URLSearchParams

`Optional` headers?: Record<string, StringOrRef>

`Optional` observe?: "response"

`Optional` queryParams?: Record<string, StringOrRef>

`Optional` responseType?: RequestResponseType

`Optional` options: VHttpReqOptions

`Optional` options: VHttpReqOptions

`Optional` options: { body?: URLSearchParams; headers?: Record<string, StringOrRef>; observe?: "response"; queryParams?: Record<string, StringOrRef>; responseType?: RequestResponseType }

`Optional` body?: URLSearchParams

`Optional` headers?: Record<string, StringOrRef>

`Optional` observe?: "response"

`Optional` queryParams?: Record<string, StringOrRef>

`Optional` responseType?: RequestResponseType

`Optional` options: VHttpReqOptions

`Optional` options: { body?: URLSearchParams; headers?: Record<string, StringOrRef>; observe?: "response"; queryParams?: Record<string, StringOrRef>; responseType?: RequestResponseType }

`Optional` body?: URLSearchParams

`Optional` headers?: Record<string, StringOrRef>

`Optional` observe?: "response"

`Optional` queryParams?: Record<string, StringOrRef>

`Optional` responseType?: RequestResponseType

`Optional` options: VHttpReqOptions

`Optional` options: { body?: URLSearchParams; headers?: Record<string, StringOrRef>; observe?: "response"; queryParams?: Record<string, StringOrRef>; responseType?: RequestResponseType }

`Optional` body?: URLSearchParams

`Optional` headers?: Record<string, StringOrRef>

`Optional` observe?: "response"

`Optional` queryParams?: Record<string, StringOrRef>

`Optional` responseType?: RequestResponseType

`Optional` options: VHttpReqOptions

`Optional` options: { body?: URLSearchParams; headers?: Record<string, StringOrRef>; observe?: "response"; queryParams?: Record<string, StringOrRef>; responseType?: RequestResponseType }

`Optional` body?: URLSearchParams

`Optional` headers?: Record<string, StringOrRef>

`Optional` observe?: "response"

`Optional` queryParams?: Record<string, StringOrRef>

`Optional` responseType?: RequestResponseType

`Optional` options: VHttpReqOptions

`Optional` options: { body?: URLSearchParams; headers?: Record<string, StringOrRef>; observe?: "response"; queryParams?: Record<string, StringOrRef>; responseType?: RequestResponseType }

`Optional` body?: URLSearchParams

`Optional` headers?: Record<string, StringOrRef>

`Optional` observe?: "response"

`Optional` queryParams?: Record<string, StringOrRef>

`Optional` responseType?: RequestResponseType