Socket

Defined in: server.ts:444

Server-side socket for pushing data to a client. Server functions with Socket<T> parameters receive client callbacks on the client side.

Example

// Server
export function streamNumbers(socket: Socket<number>) {
  setInterval(() => {
    if (!socket.send(Math.random())) clearInterval(interval);
  }, 1000);
}

// Client
api.streamNumbers(num => console.log(num));

Type Parameters

T

T

Data type sent through the socket

Properties

virtualSocketId

virtualSocketId: number

Defined in: server.ts:446

Methods

send()

send(data): any

Defined in: server.ts:453

Sends data to the client.

Parameters

data

T

Data to send (automatically serialized)

Returns

any

true if sent, false if socket is closed

---

toString()

toString(): string

Defined in: server.ts:466

Returns

string