minca
ApiCoreType aliases

Type Alias: PeerTransportEvents

type PeerTransportEvents = object;

Defined in: packages/core/src/network/transport.ts:13

What the mesh and network managers need from any way of moving bytes between peers.

Two kinds exist. A signalled transport (WebRTC) cannot open a connection on its own: an offer and an answer have to be carried to the other side by something else — a relay, or a peer already connected to both. An unsignalled one (a WebSocket to an always-on node, an in-memory fake in tests) just dials. The first kind is the mesh's (mesh.ts); the second, a network manager's (network-manager.ts).

Properties

connected

connected: (peerId) => void;

Defined in: packages/core/src/network/transport.ts:15

Parameters

ParameterType
peerIdstring

Returns

void


data

data: (peerId, data) => void;

Defined in: packages/core/src/network/transport.ts:14

Parameters

ParameterType
peerIdstring
dataUint8Array

Returns

void


disconnected

disconnected: (peerId) => void;

Defined in: packages/core/src/network/transport.ts:16

Parameters

ParameterType
peerIdstring

Returns

void


error

error: (peerId, error) => void;

Defined in: packages/core/src/network/transport.ts:17

Parameters

ParameterType
peerIdstring
errorError

Returns

void

On this page