Security News
ESLint is Now Language-Agnostic: Linting JSON, Markdown, and Beyond
ESLint has added JSON and Markdown linting support with new officially-supported plugins, expanding its versatility beyond JavaScript.
PeerInfo.create([id, ] callback)
new PeerInfo(id)
.connect(ma)
.disconnect()
.isConnected()
.multiaddrs
.multiaddrs.add(addr)
.multiaddrs.addSafe(addr)
.multiaddrs.forEach(fn)
.multaiddrs.size
]((#multiaddrsize).multiaddrs.has()
]((#multiaddrhas).multiaddrs.delete(addr)
.multiaddrs.toArray()
.multiaddrs.replace(existing, fresh)
.multiaddrs.distinct()
> npm i peer-info
const PeerInfo = require('peer-info')
<script>
TagLoading this module through a script tag will make the PeerInfo
obj available in the global namespace.
<script src="https://unpkg.com/peer-info/dist/index.min.js"></script>
<!-- OR -->
<script src="https://unpkg.com/peer-info/dist/index.js"></script>
const PeerInfo = require('peer-info')
const peer = new PeerInfo()
// TCP port 5001
peer.multiaddrs.add('/ip4/1.2.3.4/tcp/5001')
// UDP port 8001
peer.multiaddrs.add('/ip4/1.2.3.4/udp/8001')
// mic/speaker soundwaves using frequencies 697 and 1209
peer.multiaddrs.add('/sonic/bfsk/697/1209')
const PeerInfo = require('peer-info')
PeerInfo.create([id, ] callback)
id: PeerID
, optionalcallback: Function
with signature function (err, peerInfo) {}
Creates a new PeerInfo instance and if no id
is passed it
generates a new underlying PeerID
for it.
new PeerInfo(id)
id: PeerID
Creates a new PeerInfo instance from an existing PeerID.
multiaddrs
A list of multiaddresses instances that peer
can be reached at.
.multiaddrs.add(addr)
addr: Multiaddr
Adds a new multiaddress that peer
can be reached at. addr
is an instance of
a multiaddr.
.multiaddrs.addSafe(addr)
addr: Multiaddr
The addSafe
call, in comparison to add
, will only add the multiaddr to
multiaddrs
if the same multiaddr tries to be added twice.
This is a simple mechanism to prevent multiaddrs
from becoming bloated with
unusable addresses, which happens when we exchange observed multiaddrs with
peers which will not provide a useful multiaddr to be shared to the rest of the
network (e.g. a multiaddr referring to a peer inside a LAN being shared to the
outside world).
.multiaddrs.delete(addr)
addr: Multiaddr
Removes a multiaddress instance addr
from peer
.
.multiaddrs.replace(existing, fresh)
existing: Multiaddr
fresh: Multiaddr
Removes the array of multiaddresses existing
from peer
, and adds the array
of multiaddresses fresh
.
PRs accepted.
Small note: If editing the Readme, please conform to the standard-readme specification.
0.9.4 (2017-07-21)
<a name="0.9.3"></a>
FAQs
IPFS Peer abstraction JavaScript implementation
The npm package peer-info receives a total of 6,370 weekly downloads. As such, peer-info popularity was classified as popular.
We found that peer-info demonstrated a not healthy version release cadence and project activity because the last version was released a year ago. It has 2 open source maintainers collaborating on the project.
Did you know?
Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.
Security News
ESLint has added JSON and Markdown linting support with new officially-supported plugins, expanding its versatility beyond JavaScript.
Security News
Members Hub is conducting large-scale campaigns to artificially boost Discord server metrics, undermining community trust and platform integrity.
Security News
NIST has failed to meet its self-imposed deadline of clearing the NVD's backlog by the end of the fiscal year. Meanwhile, CVE's awaiting analysis have increased by 33% since June.