@univerjsnetworkclassesWebsocketservice

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


Class: WebSocketService

This service create a WebSocket connection to a remote server.

Extends

Implements

Constructors

new WebSocketService()

new WebSocketService(): WebSocketService

Returns

WebSocketService

Inherited from

Disposable.constructor

Properties

PropertyModifierTypeDefault valueInherited fromDefined in
_disposedprotectedbooleanfalseDisposable._disposedsubmodules/univer/packages/core/src/shared/lifecycle.ts:93

Methods

createSocket()

createSocket(URL): Nullable<ISocket>

Parameters

ParameterType
URLstring

Returns

Nullable<ISocket>

Implementation of

ISocketService.createSocket

Defined in

submodules/univer/packages/network/src/services/web-socket/web-socket.service.ts:55


dispose()

dispose(): void

Returns

void

Inherited from

Disposable.dispose

Defined in

submodules/univer/packages/core/src/shared/lifecycle.ts:106


disposeWithMe()

disposeWithMe(disposable): IDisposable

Parameters

ParameterType
disposableDisposableLike

Returns

IDisposable

Inherited from

Disposable.disposeWithMe

Defined in

submodules/univer/packages/core/src/shared/lifecycle.ts:96


ensureNotDisposed()

protected ensureNotDisposed(): void

Returns

void

Inherited from

Disposable.ensureNotDisposed

Defined in

submodules/univer/packages/core/src/shared/lifecycle.ts:100