Package Exports
- spread-the-word
This package does not declare an exports field, so the exports above have been automatically detected and optimized by JSPM instead. If any package subpath is missing, it is recommended to post an issue to the original package (spread-the-word) to support the "exports" field. If that is not possible, create a JSPM override to customize the exports field for this package.
Readme
spread-the-word
A Bonjour / Zeroconf implementation in TypeScript.
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
- used encoder / decoder
- 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