Interface API<OptionExtension>

Type parameters

OptionExtension = {}

Hierarchy

API

Index

Methods

Methods

addrs

addrs(options?: AbortOptions & OptionExtension): Promise<AddrsResult[]>

- Defined in swarm/index.ts:8
List of known addresses of each peer connected

Parameters
- Optional options: AbortOptions & OptionExtension
Returns Promise<AddrsResult[]>

connect

connect(addr: string | Multiaddr, options?: AbortOptions & OptionExtension): Promise<void>

- Defined in swarm/index.ts:13
Open a connection to a given address or peer id

Parameters
- addr: string | Multiaddr
- Optional options: AbortOptions & OptionExtension
Returns Promise<void>

disconnect

disconnect(addr: string | Multiaddr, options?: AbortOptions & OptionExtension): Promise<void>

- Defined in swarm/index.ts:18
Close a connection to a given address or peer id

Parameters
- addr: string | Multiaddr
- Optional options: AbortOptions & OptionExtension
Returns Promise<void>

localAddrs

localAddrs(options?: AbortOptions & OptionExtension): Promise<Multiaddr[]>

- Defined in swarm/index.ts:23
Local addresses this node is listening on

Parameters
- Optional options: AbortOptions & OptionExtension
Returns Promise<Multiaddr[]>

peers

peers(options?: PeersOptions & OptionExtension): Promise<PeersResult[]>

- Defined in swarm/index.ts:28
Return a list of connected peers

Parameters
- Optional options: PeersOptions & OptionExtension
Returns Promise<PeersResult[]>

Generated using TypeDoc