@univerjs/network v0.4.2 • Docs
@univerjs/network
Enumerations
| Enumeration | Description |
|---|---|
| HTTPEventType | - |
| HTTPStatusCode | Http status codes. |
Classes
| Class | Description |
|---|---|
| FetchHTTPImplementation | An HTTP implementation using Fetch API. This implementation can both run in browser and Node.js. |
| HTTPHeaders | It wraps headers of HTTP requests' and responses' headers. |
| HTTPProgress | Progress event for HTTP request. Usually used for reporting download/upload progress or SSE streaming. |
| HTTPRequest | - |
| HTTPResponse | Wraps success response info. |
| HTTPResponseError | - |
| HTTPService | This service provides http request methods and allows to register http interceptors. |
| ResponseHeader | - |
| UniverNetworkPlugin | This plugin add network services to the Univer instance. |
| WebSocketService | This service create a WebSocket connection to a remote server. |
| XHRHTTPImplementation | An HTTP implementation using XHR. HTTP service provided by this service could only be async (we do not support sync XHR now). |
Interfaces
| Interface | Description |
|---|---|
| IAuthInterceptorParams | - |
| IHTTPImplementation | HTTP service could be implemented differently on platforms. |
| IPostRequestParams | - |
| IRequestParams | - |
| IRetryInterceptorFactoryParams | - |
| ISocket | An interface that represents a socket connection. |
| ISocketService | - |
Type Aliases
| Type alias | Description |
|---|---|
| HTTPEvent | - |
| HTTPHandlerFn | - |
| HTTPInterceptorFn | HTTP interceptor function. When the interceptor is called, it would receive a request object and a next function. |
| HTTPInterceptorFnFactory | - |
| HTTPRequestMethod | - |
| HTTPResponseBody | - |
| HTTPResponseType | Copyright 2023-present DreamNum Inc. |
| SocketBodyType | - |
Functions
| Function | Description |
|---|---|
| AuthInterceptorFactory | - |
| IHTTPImplementation | - |
| ISocketService | - |
| MergeInterceptorFactory | - |
| RetryInterceptorFactory | - |
| ThresholdInterceptorFactory | - |