FNetwork

This Facade provides a set of methods to make HTTP requests. You should not create an instance of this class directly, instead, use getNetwork of FUniver instead.

APIs

delete

Send DELETE request to the server.

Signature

delete<T>(url: string, params?: IRequestParams): Promise<HTTPResponse<T>>

Parameters

• url (string) — - The requested URL
• params (IRequestParams) — - Query parameters

Returns

• (Promise<HTTPResponse<T>>) — Network response

get

Send a GET request to the server.

Signature

get<T>(url: string, params?: IRequestParams): Promise<HTTPResponse<T>>

Parameters

• url (string) — - The requested URL.
• params (IRequestParams) — - Query parameters.

Returns

• (Promise<HTTPResponse<T>>) — Network response.

getSSE

Request for a stream of server-sent events. Instead of a single response, the server sends a stream of responses, Univer wraps the stream in an Observable which you can call subscribe on.

Signature

getSSE<T>(method: HTTPRequestMethod, url: string, params?: IPostRequestParams): Observable<HTTPEvent<T>>

Parameters

• method (HTTPRequestMethod) — - HTTP request method
• url (string) — - The requested URL
• params (IPostRequestParams) — - params Query parameters

Returns

• (Observable<HTTPEvent<T>>) — An observable that emits the network response.

patch

Send PATCH request to the server.

Signature

patch<T>(url: string, params?: IPostRequestParams): Promise<HTTPResponse<T>>

Parameters

• url (string) — - The requested URL
• params (IPostRequestParams) — - Query parameters

Returns

• (Promise<HTTPResponse<T>>) — Network response

post

Send a POST request to the server.

Signature

post<T>(url: string, params?: IPostRequestParams): Promise<HTTPResponse<T>>

Parameters

• url (string) — - The requested URL.
• params (IPostRequestParams) — - Query parameters.

Returns

• (Promise<HTTPResponse<T>>) — Network response.

put

Send a PUT request to the server.

Signature

put<T>(url: string, params?: IPostRequestParams): Promise<HTTPResponse<T>>

Parameters

• url (string) — - The requested URL
• params (IPostRequestParams) — - Query parameters

Returns

• (Promise<HTTPResponse<T>>) — Network response