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

@geut/deluge

v4.1.0

Published

Send broadcast messages on top of p2p networks

Downloads

26

Readme

deluge

Send broadcast messages on top of p2p networks

Build Status JavaScript Style Guide standard-readme compliant

Made by GEUT

Install

$ npm install @geut/deluge

Usage

const { Deluge } = require('@geut/deluge')
const deluge = new Deluge()

// add your peers into deluge
deluge.addPeer(peer.id, {
  send (packet) {
    // send data
    peer.write(packet.buffer)
  },
  subscribe (next) {
    // subscribe for incoming data
    peer.on('data', next)

    // returns unsubscribe function
    return () => {
      peer.off('data', next)
    }
  }
})
deluge.addPeer(...)

// listen for incoming packets
deluge.on('packet', (packet) => {
  console.log(packet.data.toString()) // ping
})

// send a broadcast ping message in the channel = 0
deluge.send(0, Buffer.from('ping'))

API

deluge = new Deluge(opts?)

  • opts?: Object = {}
    • onPeer?: OnPeerCallback Callback to pre-process a new peer.
    • onPacket?: OnPacketCallback Async callback to filter incoming packets.
    • onSend?: OnSendCallback Async callback to filter peers before to send a packet.

deluge.ready() => Promise<any>

Wait for the deluge to be opened.

deluge.open(id?) => Promise<any>

Open deluge with a Buffer ID.

  • id?: Buffer = crypto.randomBytes(32)

deluge.onPeer(callback) => void

  • callback: OnPeerCallback

deluge.onPacket(callback) => void

  • callback: OnPacketCallback

deluge.onSend(callback) => void

  • callback: OnSendCallback

deluge.getPeer(key) => Peer | undefined

Get a peer by key.

  • key: Buffer | string

deluge.addPeer(key, handler) => Promise<Peer>

Add a new peer into the deluge network.

  • key: Buffer | string
  • handler: Peer.Handler

deluge.deletePeer(key) => Promise<any>

  • key: Buffer | string

deluge.send(channel, data) => Promise<Packet | undefined>

Broadcast a flooding message into the deluge network.

  • channel: number
  • data: Buffer

deluge.createDuplexStream(opts?) => Duplex

Create a new Duplex Streamx.

  • opts?: any = {}

deluge.id: Buffer | null

deluge.peers: Peer[] (R)

Handler: {}

  • send: (packet: any) > undefined
  • subscribe: (data: Buffer) > UnsubscribeFunction

packet = new Packet(opts)

  • opts: Object
    • origin: Buffer
    • data: Uint8Array
    • channel?: number = 0
    • seqno?: TimestampSeq
    • from?: Uint8Array
    • distance?: number = 0
    • buffer?: Buffer

timestampSeq = new TimestampSeq(timestamp, offset)

  • timestamp: any
  • offset: any

timestampSeq.compare(value) => number

Compare two TimestampSeq (self and value).

Returns: - 0 if they are equals. - 1 if self is major than value - -1 if self is minor than value

  • value: TimestampSeq

Issues

:bug: If you found an issue we encourage you to report it on github. Please specify your OS and the actions to reproduce it.

Contributing

:busts_in_silhouette: Ideas and contributions to the project are welcome. You must follow this guideline.

License

MIT © A GEUT project