@univerjs/network v0.1.17 • Docs
Interface: ISocket
An interface that represents a socket connection.
Properties
| Property | Type | Defined in |
|---|---|---|
URL | string | packages/network/src/services/web-socket/web-socket.service.ts:37 (opens in a new tab) |
close$ | Observable<CloseEvent> | packages/network/src/services/web-socket/web-socket.service.ts:46 (opens in a new tab) |
error$ | Observable<Event> | packages/network/src/services/web-socket/web-socket.service.ts:47 (opens in a new tab) |
message$ | Observable<MessageEvent<any>> | packages/network/src/services/web-socket/web-socket.service.ts:48 (opens in a new tab) |
open$ | Observable<Event> | packages/network/src/services/web-socket/web-socket.service.ts:49 (opens in a new tab) |
Methods
close()
close(code?, reason?): voidParameters
| Parameter | Type |
|---|---|
code? | number |
reason? | string |
Returns
void
Defined in
packages/network/src/services/web-socket/web-socket.service.ts:39 (opens in a new tab)
send()
send(data): voidSend a message to the remote server.
Parameters
| Parameter | Type |
|---|---|
data | SocketBodyType |
Returns
void
Defined in
packages/network/src/services/web-socket/web-socket.service.ts:44 (opens in a new tab)