Interface Transport

Hierarchy

Transport

Implemented by

PeerJSTransport

Index

Properties

connectedPeers localPeerId

Methods

broadcast close connect off on send

Properties

`Readonly` connectedPeers

connectedPeers: readonly string[]

IDs of all currently connected remote peers

`Readonly` localPeerId

localPeerId: string

The local peer ID, available after 'open' fires

Methods

broadcast

broadcast(data): Promise<void>
Broadcast a message to all connected peers
Parameters
- data: unknown
Returns Promise<void>
- Defined in transport/Transport.ts:38

close

close(): void
Shut down the transport and close all connections

Returns void
- Defined in transport/Transport.ts:53

connect

connect(remotePeerId): void
Connect to a remote peer by ID
Parameters
- remotePeerId: string
Returns void
- Defined in transport/Transport.ts:32

off

off<E>(event, listener): void
Remove an event listener
Type Parameters
- E extends keyof TransportEvents
Parameters
- event: E
- listener: TransportEvents[E]
Returns void
- Defined in transport/Transport.ts:47

on

on<E>(event, listener): void
Register an event listener
Type Parameters
- E extends keyof TransportEvents
Parameters
- event: E
- listener: TransportEvents[E]
Returns void
- Defined in transport/Transport.ts:41

send

send(remotePeerId, data): Promise<void>
Send a message to a specific remote peer
Parameters
- remotePeerId: string
- data: unknown
Returns Promise<void>
- Defined in transport/Transport.ts:35

Generated using TypeDoc