# mdns-js-mw

> JavaScript/NodeJS mDNS discovery implementation, with IPv6 modify.

Latest version **0.5.1-mw.0.1.2** (published 2019-05-14) · SEE LICENSE IN LICENSE license · 0 weekly downloads

## Install

```sh
npm install mdns-js-mw
pnpm add mdns-js-mw
yarn add mdns-js-mw
bun add mdns-js-mw
```

## Health

**Score 15/100 (F)** — status: abandoned.

Positive: no vulnerabilities.

Warnings: low downloads; no types; no esm support; pre 1.0.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 0.5.1-mw.0.1.2 |
| Published | 2019-05-14 |
| First published | 2019-05-03 |
| Weekly downloads | 0 |
| License | SEE LICENSE IN LICENSE |
| TypeScript types | none |
| Module format | CommonJS |
| Node | >= 4.1.0 |
| Dependencies | 3 |
| Unpacked size | 94.8 KB |
| Known vulnerabilities | 0 (+1 in 1 direct dependencies) |
| Install scripts | no |
| Author | Peter Magnusson |
| Maintainers | ngand1 |
| Keywords | mdns, dns-sd, zeroconf |

## Links

- npm: https://www.npmjs.com/package/mdns-js-mw
- npm.io page: https://npm.io/package/mdns-js-mw

## Dependencies (3)

- [debug](https://npm.io/package/debug.md) ^2.1.1
- [dns-js](https://npm.io/package/dns-js.md) ~0.2.1
- [semver](https://npm.io/package/semver.md) ~5.1.0

## Alternatives

- [@mdxeditor/editor](https://npm.io/package/@mdxeditor/editor.md) — 962.4K weekly downloads
- [mmdb-lib](https://npm.io/package/mmdb-lib.md) — 680.9K weekly downloads
- [playcanvas](https://npm.io/package/playcanvas.md) — 36.2K weekly downloads
- [@glw907/cairn-cms](https://npm.io/package/@glw907/cairn-cms.md) — 967 weekly downloads
- [markdown-to-confluence](https://npm.io/package/markdown-to-confluence.md) — 103 weekly downloads

## Recent versions

- 0.5.1-mw.0.1.2 (latest) — 2019-05-14
- 0.5.1-mw.0.1.1 — 2019-05-03

## README

mdns-js-mw
==========

mdns-js を、MilkyWay向けにCustomizeしたもの。

mdns-jw-mw Functions
--------------------

* Denebを検出できるmDNSの機能を実現する。
  * 最低限、指定したServiceのInstance Name, port番号と、そのService
    InstanceのあるHostの IPv4, IPv6 アドレス, 検出できたLocal Host上の
    Network InterfaceのIPアドレスを取得する機能を実現する。
  * 指定したServiceを新たに検出した場合に、呼び出し元に通知する機能を
    実現する。
  * 指定したServiceが存在しなくなったことが検出できた場合(例:
    "goodbye", RFC6762 10.1を検出できた場合等)呼び出し元に通知する機能
    を実現する。
* mDNSのQueryを投げることができる。(Should)

mDNS Stack Reference
--------------------

* RFC 6762 - Multicast DNS : https://tools.ietf.org/html/rfc6762
* RFC 6763 - DNS-Based Service Discovery : https://tools.ietf.org/html/rfc6763

mDNS Stack Assumption
--------------------
このモジュールは、Windows向けに利用する事を想定している。
上記の役割に関して、既存のnode-mdns-jsのInterfaceをそのまま利用する事を想定している。
カスタマイズポイントとしては、役割を実現する上で不足のある機能(例:
IPv6 in node-mdns-js)の追加と、上記の役割が商品に組込できるレベルで実
現できている事の確認。


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

// create browser with query
var browser = mdns.createBrowser(mdns.tcp("digitalpaper"));

// post initialize event
browser.on('ready', function onReady() {
	console.log('browser is ready');
});

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

// stop discovery
browser.stop();

// start discovery (ready after)
browser.discover();

// start alternative
browser.start();
```

API
==========

`on(eventName, callback)`
--------------------
イベントリスナー

* `eventName`
- `ready`: finished initialize
- `update`: found node

`discover()`
--------------------
mDNS 探索開始。ready イベントのあとで実行すること。

`start()`
--------------------
mdns モジュールとの互換のために用意、内部で discover() を呼び出している。
ready 前に呼び出されたら、ready 後に discover するよう遅延させる。

`stop()`
--------------------
探索の停止。


----------------------------------------
以下、ベースとしているモジュールのオリジナルの記述。

mDNS-js
==========

[![Build Status](https://travis-ci.org/mdns-js/node-mdns-js.svg?branch=master)](https://travis-ci.org/mdns-js/node-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.

__NEW LOCATION__

This project was moved into it's own organisation. Please update any git remotes you might have pointing here.

    git remote set-url origin https://github.com/mdns-js/node-mdns-js.git

Install by

    npm install mdns-js

If you are running node version < 4.1 you will have to use a version of this library that is below
version 0.5.0

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
-------

```javascript
var mdns = require('mdns-js');
//if you have another mdns daemon running, like avahi or bonjour, uncomment following line
//mdns.excludeInterface('0.0.0.0');

var browser = mdns.createBrowser();

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

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

Reporting issues
----------------
Please report any issues at https://github.com/mdns-js/node-mdns-js/issues

But please check if there is a similar issue already reported and
__make a note of which OS__ and OS version you are running.
There is some issues that turn up only on Windows 8.1 but not in 
Windows 7 for example. And there are differences between Mac and 
Windows so... __please__...

Another important thing to know if there is another mdns service
running on the same machine. This would be for example Bonjour and Avahi.


Debugging
---------
This library is using the [debug](https://github.com/visionmedia/debug) 
module from TJ Holowaychuk and can be used like this.

```bash
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.

```bash
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 .eslintrc file for the details.


License
=======
Apache 2.0. See LICENSE file.



References
==========

* https://github.com/GoogleChrome/chrome-app-samples/tree/master/samples/mdns-browser
* http://en.wikipedia.org/wiki/Multicast_DNS
* http://en.wikipedia.org/wiki/Zero_configuration_networking#Service_discovery
* RFC 6762 - mDNS - http://tools.ietf.org/html/rfc6762
* RFC 6763 - DNS Based Service Discovery (DNS-SD) - http://tools.ietf.org/html/rfc6763
* http://www.tcpipguide.com/free/t_DNSMessageHeaderandQuestionSectionFormat.htm


Contributors
============

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

---
_Source: https://npm.io/package/mdns-js-mw · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._