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 🙏

© 2024 – Pkg Stats / Ryan Hefner

@web4/network

v1.0.1

Published

The networking guts of BitSwarm

Downloads

13

Readme

@web4/network

The low level networking guts of the BitSwarm stack.

npm install @web4/network

Usage

const network = require('@web4/network')()

const nw = network()

nw.bind(function () {
  // topic should be a 32 byte buffer
  nw.lookupOne(topic, function (err, peer) {
    if (err) throw err
    nw.connect(peer, function (err, socket) {
      if (err) throw err
      socket.write('Hello World!')
    })
  })
})

API

net = network([options])

Create a new network instance.

Options include:

{
  bind () {
    // called when the network is bound
  },
  close () {
    // called when the network is fully closed
  },
  socket (socket) {
    // called when an incoming socket is received
  },
  // Optionally overwrite the default set of bootstrap servers
  bootstrap: [addresses],
  // Set to false if this is a long running instance on a server
  // When running in ephemeral mode you don't join the DHT but just 
  // query it instead. If unset, or set to a non-boolean (default undefined)
  // then the node will start in short-lived (ephemeral) mode and switch 
  // to long-lived (non-ephemeral) mode after a certain period of uptime
  ephemeral: undefined
}

nw.bind([preferredPort], [callback])

Bind to a preferred port. Must be called before connecting.

Safe to call multiple times. If already bound or binding it will call the callback when fully bound.

nw.close([callback])

Fully close the network.

Safe to call multiple times.

nw.connect(peer, callback)

Connect to a peer. Will do UDP holepunching.

Callback is called with (err, socket, isTCP). If the underlying socket is a TCP socket isTCP will be true, if it is a UTP socket it will be false.

announcer = nw.announce(topic)

Start announcing the network on the BitSwarm discovery network.

lookup = nw.lookup(topic)

Start doing a lookup on the BitSwarm discovery network.

nw.lookupOne(topic, callback)

Lookup a single peer on the BitSwarm discovery network.

License

MIT