Nupital Pomp Mesmerises

    spread-the-word
    TypeScript icon, indicating that this package has built-in type declarations

    0.9.3 • Public • Published

    spread-the-word

    A Bonjour / Zeroconf implementation in TypeScript.

    Github Version NPM Version NPM Downloads License CircleCI

    Spread services across your local network and discover other services

    Installation

    $ npm i spread-the-word

    Usage

    import stw from "spread-the-word";
    
    stw.on("up", (remoteService, response, referrer) => {
      console.log(`${remoteService.name} (type: ${remoteService.type}, port: ${remoteService.port}) is up (from ${referrer.address})`);
      if (remoteService.txt) {
        console.log("TXT found:", remoteService.txt);
      }
    }).on("down", (remoteService, response, referrer) => {
      console.log(`${remoteService.name} (type: ${remoteService.type}, port: ${remoteService.port}) 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:* npm start

    License

    MIT

    Install

    npm i spread-the-word

    DownloadsWeekly Downloads

    190

    Version

    0.9.3

    License

    MIT

    Unpacked Size

    1.13 MB

    Total Files

    130

    Last publish

    Collaborators

    • ardean