/spread-the-word

:loudspeaker: A Bonjour / Zeroconf implementation in JavaScript

Primary LanguageTypeScriptMIT LicenseMIT

spread-the-word

A Bonjour / Zeroconf implementation in JavaScript.

Github Version NPM Version NPM Downloads License

Spread services across your local network and discover other services

Installation

$ npm i spread-the-word

or

$ yarn add spread-the-word

Usage

import stw from "spread-the-word";

stw
  .on("up", (remoteService, res, referrer) => {
    console.log(`${remoteService.name} is up! (from ${referrer.address})`);
  })
  .on("down", (remoteService, res, referrer) => {
    console.log(`${remoteService.name} is down! (from ${referrer.address})`);
  });

stw.listen({ type: "jsremote" });

stw.spread({
  type: "jsremote",
  name: "awesome remote receiver",
  port: 4444,
  txt: {
    message: "Custom Data"
  }
});

Features

  • easy service detection & advertisement on your local network
  • TXT record support
  • subtypes support
  • auto probing on spread
  • no extra native dependencies
  • typescript types included

Documentation

You can find the latest version of documentation hosted here.

Debug

$ DEBUG=SpreadTheWord:* yarn start

License

MIT