@univerjsnetworkReadme

@univerjs/network v0.5.0-beta.1 • Docs

@univerjs/network

Enumerations

EnumerationDescription
HTTPEventType-
HTTPStatusCodeHttp status codes.

Classes

ClassDescription
FetchHTTPImplementationAn HTTP implementation using Fetch API. This implementation can both run in browser and Node.js.
HTTPHeadersIt wraps headers of HTTP requests’ and responses’ headers.
HTTPProgressProgress event for HTTP request. Usually used for reporting download/upload progress or SSE streaming.
HTTPRequest-
HTTPResponseWraps success response info.
HTTPResponseError-
HTTPServiceThis service provides http request methods and allows to register http interceptors.
ResponseHeader-
UniverNetworkPluginThis plugin add network services to the Univer instance.
WebSocketServiceThis service create a WebSocket connection to a remote server.
XHRHTTPImplementationAn HTTP implementation using XHR. HTTP service provided by this service could only be async (we do not support sync XHR now).

Interfaces

InterfaceDescription
IAuthInterceptorParams-
IHTTPImplementationHTTP service could be implemented differently on platforms.
IPostRequestParams-
IRequestParams-
IRetryInterceptorFactoryParams-
ISocketAn interface that represents a socket connection.
ISocketService-

Type Aliases

Type aliasDescription
HTTPEvent-
HTTPHandlerFn-
HTTPInterceptorFnHTTP interceptor function. When the interceptor is called, it would receive a request object and a next function.
HTTPInterceptorFnFactory-
HTTPRequestMethod-
HTTPResponseBody-
HTTPResponseTypeCopyright 2023-present DreamNum Inc.
SocketBodyType-

Functions

FunctionDescription
AuthInterceptorFactory-
IHTTPImplementation-
ISocketServiceThis service is responsible for establishing bidi-directional connection to a remote server.
MergeInterceptorFactory-
RetryInterceptorFactory-
ThresholdInterceptorFactory-
ReplacecurrentmatchcommandFetchhttpimplementation