npm package discovery and stats viewer.

Discover Tips

  • General search

    [free text search, go nuts!]

  • Package details

    pkg:[package-name]

  • User packages

    @[username]

Sponsor

Optimize Toolset

I’ve always been into building performant and accessible sites, but lately I’ve been taking it extremely seriously. So much so that I’ve been building a tool to help me optimize and monitor the sites that I build to make sure that I’m making an attempt to offer the best experience to those who visit them. If you’re into performant, accessible and SEO friendly sites, you might like it too! You can check it out at Optimize Toolset.

About

Hi, 👋, I’m Ryan Hefner  and I built this site for me, and you! The goal of this site was to provide an easy way for me to check the stats on my npm packages, both for prioritizing issues and updates, and to give me a little kick in the pants to keep up on stuff.

As I was building it, I realized that I was actually using the tool to build the tool, and figured I might as well put this out there and hopefully others will find it to be a fast and useful way to search and browse npm packages as I have.

If you’re interested in other things I’m working on, follow me on Twitter or check out the open source projects I’ve been publishing on GitHub.

I am also working on a Twitter bot for this site to tweet the most popular, newest, random packages from npm. Please follow that account now and it will start sending out packages soon–ish.

Open Software & Tools

This site wouldn’t be possible without the immense generosity and tireless efforts from the people who make contributions to the world and share their work via open source initiatives. Thank you 🙏

© 2022 – Pkg Stats / Ryan Hefner

torrent-discovery

v9.4.13

Published

Discover BitTorrent and WebTorrent peers

Downloads

29,988

Readme

torrent-discovery ci npm downloads javascript style guide

Discover BitTorrent and WebTorrent peers

This module bundles bittorrent-tracker, bittorrent-dht, and bittorrent-lsd clients and exposes a single API for discovering BitTorrent peers.

features

  • simple API
  • find peers from trackers, DHT, and LSD
  • automatically announces, so other peers can discover us
  • can start finding peers with just an info hash, before full metadata is available

This module also works in the browser with browserify. In that context, it discovers WebTorrent (WebRTC) peers.

install

npm install torrent-discovery

api

discovery = new Discovery(opts)

Create a new peer discovery instance. Required options are:

{
  infoHash: '', // as hex string or Buffer
  peerId: '',   // as hex string or Buffer
  port: 0       // torrent client port (only required in node)
}

Optional options are:

{
  announce: [],  // force list of announce urls to use (from magnet uri)
  dht: true,     // use dht? optionally, this can be an `opts` object, or a DHT instance to use (can be reused for multiple torrents)
  dhtPort: 0,    // custom listen port for the DHT instance (not used if DHT instance is given via `opts.dht`)
  userAgent: '', // User-Agent header for http requests
  tracker: true, // use trackers? optionally, this can be an `opts` object
  lsd: true      // use lsd?
}

See the documentation for bittorrent-tracker, bittorrent-dht, and bittorrant-lsd for information on what options are available via the opts object.

This module automatically handles announcing on intervals, for maximum peer discovery.

discovery.updatePort(port)

When the port that the torrent client is listening on changes, call this method to reannounce to the tracker and DHT with the new port.

discovery.complete([opts])

Announce that download has completed (and the client is now a seeder). This is only used by trackers, for statistical purposes. If trackers are not in use, then this method is a no-op.

Optional opts object with the following options:

{number=} opts.uploaded
{number=} opts.downloaded
{number=} opts.numwant
{number=} opts.left (if not set, calculated automatically)

discovery.destroy()

Destroy and cleanup the tracker, DHT, and LSD instances.

events

discovery.on('peer', (peer, source) => {})

Emitted whenever a new peer is discovered. Source is either 'tracker', 'dht', or 'lsd' based on peer source.

In node, peer is a string in the form ip:port, e.g. 12.34.56.78:4000.

In the browser, peer is an instance of simple-peer, a small wrapper around a WebRTC peer connection.

discovery.on('dhtAnnounce', () => {})

Emitted whenever an announce message has been sent to the DHT.

discovery.on('warning', err => {})

Emitted when there is a non-fatal tracker, DHT, or LSD error. For example, an inaccessible tracker server would be considered a warning. Useful for logging.

discovery.on('error', err => {})

Emitted when there is a fatal tracker, DHT, or LSD error. This is unrecoverable and the discovery object will be destroyed if this event is emitted.

license

MIT. Copyright (c) Feross Aboukhadijeh and WebTorrent, LLC.