JSPM

  • ESM via JSPM
  • ES Module Entrypoint
  • Export Map
  • Keywords
  • License
  • Repository URL
  • TypeScript Types
  • README
  • Created
  • Published
  • Downloads 4
  • Score
    100M100P100Q46110F
  • License MIT

Simple peer-to-peer with IPFS

Package Exports

  • webpeerjs

Readme

WebpeerJS

Simple peer-to-peer communication between applications in browser.

Build completely P2P web applications, no trackers or relay servers required. WebpeerJS enables browser to browser connectivity without a central server. Connecting people safely, privately, openly and reliably. Let's create a next generation internet that is fair, free and open.

Basic Connection Demo

Features

  • ✅ Decentralized P2P
  • ✅ Unlimited Peers
  • ✅ Works in Browsers
  • ✅ Broadcast Message

Install

NPM :

npm i webpeerjs

Browser <script> tag :

Uses built-in JS files from latest release or CDN will make it's exports available as webpeerjs in the global namespace.

<script src="https://cdn.jsdelivr.net/npm/webpeerjs@0.1/dist/umd/webpeerjs.min.js"></script>

Usage

import { webpeerjs } from 'webpeerjs'

void async function main() {

    const node = await webpeerjs.createWebpeer()
    
    console.log(`My node id : ${node.id}`)
    
    const [broadcast,listen,members] = node.joinRoom('globalroom')
    
    listen((message,id) => {
        console.log(`Message from ${id} : ${message}`)
    })
    
    members((data) => {
        console.log(`Members : ${data}`)
        broadcast('hello')
    })
    
}()

API

  • createWebpeer() - Create a new node.
  • id - The unique ID of the node as an identity in the global network.
  • status - Get the node status, returns connected or unconnected.
  • peers - Get all connected peers.
  • joinRoom(namespace) - Join to the room, returns an array of three functions (Broadcaster, onListenBroadcast, onMembersUpdate).

API Docs

https://nuzulul.github.io/webpeerjs

License

MIT

Maintainers

Nuzulul Zulkarnain