Class MDNSServer

An mDNS server that responds to DNS queries on the local network.

Maintains a registry of published records and automatically responds to queries using the multicast-dns protocol.

Emits:

responded when a response is sent to a query

Example

const server = new MDNSServer({}, console.error)
server.register([{ name: '_http._tcp.local', type: 'PTR', data: 'MyService._http._tcp.local' }])

See

https://datatracker.ietf.org/doc/html/rfc6762

Hierarchy

EventEmitter<EventMap>
- MDNSServer

Index

Constructors

Methods

register unregister

Constructors

constructor

new MDNSServer(options: Options): MDNSServer
Parameters
- options: Options
  Configuration passed to the underlying multicast-dns instance.
Returns MDNSServer
Overrides EventEmitter<EventMap>.constructor
- Defined in utils/MDNSServer.ts:43

Methods

register

register(records: MDNSRecord[]): void
Registers a list of DNS records to be used in future responses.

Duplicate records (based on type, name, and deep equality of data) are ignored.
Parameters
- records: MDNSRecord[]
  An array of mDNS records to register.
Returns void
- Defined in utils/MDNSServer.ts:58

unregister

unregister(records: MDNSRecord[]): void
Unregisters a set of previously registered DNS records.

Matching is done by record.name only (not deeply).
Parameters
- records: MDNSRecord[]
  Records to remove from the server registry.
Returns void
- Defined in utils/MDNSServer.ts:80