Interface NetworkAdapterInterface interface NetworkAdapterInterface { peerId ?: PeerId ; peerMetadata ?: PeerMetadata ; addListener < T extends keyof NetworkAdapterEvents > ( event : T , fn : ( ... args : ArgumentMap < NetworkAdapterEvents > [ Extract < T , keyof NetworkAdapterEvents , > ] , ) => void , context ?: any , ) : this ; connect ( peerId : PeerId , peerMetadata ?: PeerMetadata ) : void ; disconnect () : void ; emit < T extends keyof NetworkAdapterEvents > ( event : T , ... args : ArgumentMap < NetworkAdapterEvents > [ Extract < T , keyof NetworkAdapterEvents , > ] , ) : boolean ; eventNames () : (
keyof NetworkAdapterEvents )
[] ; isReady () : boolean ; listenerCount ( event : keyof NetworkAdapterEvents ) : number ; listeners < T extends keyof NetworkAdapterEvents > ( event : T , ) : (
( ... args : ArgumentMap < NetworkAdapterEvents > [ Extract < T , keyof NetworkAdapterEvents , > ] , ) => void )
[] ; off < T extends keyof NetworkAdapterEvents > ( event : T , fn ?: ( ... args : ArgumentMap < NetworkAdapterEvents > [ Extract < T , keyof NetworkAdapterEvents , > ] , ) => void , context ?: any , once ?: boolean , ) : this ; on < T extends keyof NetworkAdapterEvents > ( event : T , fn : ( ... args : ArgumentMap < NetworkAdapterEvents > [ Extract < T , keyof NetworkAdapterEvents , > ] , ) => void , context ?: any , ) : this ; once < T extends keyof NetworkAdapterEvents > ( event : T , fn : ( ... args : ArgumentMap < NetworkAdapterEvents > [ Extract < T , keyof NetworkAdapterEvents , > ] , ) => void , context ?: any , ) : this ; removeAllListeners ( event ?: keyof NetworkAdapterEvents
) : this ; removeListener < T extends keyof NetworkAdapterEvents > ( event : T , fn ?: ( ... args : ArgumentMap < NetworkAdapterEvents > [ Extract < T , keyof NetworkAdapterEvents , > ] , ) => void , context ?: any , once ?: boolean , ) : this ; send ( message : Message ) : void ; whenReady () : Promise < void > ; } Properties Methods remove removeAllListeners ( event ?: keyof NetworkAdapterEvents
) : this Parameters Optionalevent : keyof NetworkAdapterEventsReturns this when whenReady () : Promise < void >
An interface representing some way to connect to other peers
Remarks
The Repo uses one or more
NetworkAdapters to connect to other peers. Because the network may take some time to be ready the Repo will wait until the adapter emits areadyevent before it starts trying to use itThe NetworkAdapter is an abstract class that can be used as a base to build a custom network adapter. It is most useful as a simple way to add the necessary event emitter functionality