Class PeerJSTransport

Hierarchy

PeerJSTransport

Implements

Transport

Index

Constructors

Properties

_localPeerId connections listeners peer pendingConnections

Accessors

connectedPeers localPeerId

Methods

broadcast close connect emit off on send setupConnection

Constructors

constructor

new PeerJSTransport(peer): PeerJSTransport
Parameters
- peer: PeerLike
Returns PeerJSTransport
- Defined in transport/PeerJSTransport.ts:66
new PeerJSTransport(options?): PeerJSTransport
Parameters
- Optional options: PeerJSTransportOptions
Returns PeerJSTransport
- Defined in transport/PeerJSTransport.ts:67

Properties

`Private` _localPeerId

_localPeerId: string

`Private` `Readonly` connections

connections: Map<string, DataConnectionLike> = ...

`Private` `Readonly` listeners

listeners: ListenerMap = ...

`Private` `Readonly` peer

`Private` `Readonly` pendingConnections

pendingConnections: Map<string, DataConnectionLike> = ...

Accessors

connectedPeers

get connectedPeers(): readonly string[]
IDs of all currently connected remote peers

Returns readonly string[]
Implementation of Transport.connectedPeers
- Defined in transport/PeerJSTransport.ts:100

localPeerId

get localPeerId(): string
The local peer ID, available after 'open' fires

Returns string
Implementation of Transport.localPeerId
- Defined in transport/PeerJSTransport.ts:96

Methods

broadcast

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

close

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

Returns void
Implementation of Transport.close
- Defined in transport/PeerJSTransport.ts:145

connect

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

`Private` emit

emit<E>(event, ...args): void
Type Parameters
- E extends keyof TransportEvents
Parameters
- event: E
- Rest ...args: Parameters<TransportEvents[E]>
Returns void
- Defined in transport/PeerJSTransport.ts:194

off

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

on

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

send

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

`Private` setupConnection

setupConnection(conn): void
Parameters
- conn: DataConnectionLike
Returns void
- Defined in transport/PeerJSTransport.ts:154

Generated using TypeDoc