Code Monkey home page Code Monkey logo

node-mdns-js's Introduction

mDNS-js

Pure JavaScript/NodeJS mDNS discovery implementation. It's definitely not a full implementation at the current state and it will NOT work in the browser.

The starting inspiration came from https://github.com/GoogleChrome/chrome-app-samples/tree/master/mdns-browser but adapted for node. It's not much left of that now though.

Install by

npm install mdns-js

Build Status

Future

It would be great to have a full implementation of mDSN + DNS-SD in pure JS but progress will be slow unless someone is willing to pitch in with pull requests, specifications for wanted functions etc. Also, as you should avoid to have multiple mDNS stacks on a system this might clash with stuff like avahi and bonjour.

example

var mdns = require('mdns-js');

var browser = mdns.createBrowser();

browser.on('ready', function () {
    browser.discover(); 
});

browser.on('update', function (data) {
    console.log('data:', data);
});

Debugging

This library is using the debug module from TJ Holowaychuk and can be used like this.

DEBUG=mdns:* node examples/simple.js

This will spit out LOTS of information that might be useful. If you have some issues with something where you might want to communicate the contents of a packet (ie create an issue on github) you could limit the debug information to just that.

DEBUG=mdns:browser:packet node examples/simple.js

Contributing

Pull-request will be gladly accepted.

If possible any api should be as close match to the api of node-mdns but be pragmatic. Look at issue #5.

Please run any existing tests with

npm test

and preferably add more tests.

Before creating a pull-request please run

npm run lint 

This will run jshint as well as jscs that will do some basic syntax and code style checks. Fix any issues befor committing and creating a pull-request.

Look at the .jshintrc and .jscs.json for the details.

License

Apache 2.0. See LICENSE file.

References

Contributors

  • James Sigurðarson, @jamiees2
  • Stefan Sauer, @ensonic

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.