Class DNSSD

High-level API for Multicast DNS Service Discovery and Advertisement.

The DNSSD class provides convenient methods for:

Publishing services to the local network
Browsing and discovering services
Unpublishing and cleaning up all registered services
Managing underlying mDNS server lifecycle

It wraps a lower-level MDNSServer and coordinates interactions with the service Registry and service Browser.

Example

const dnssd = new DNSSD()

// Advertise a new service
dnssd.publish({ name: 'My Printer', type: 'printer', port: 9100 })

// Discover services
dnssd.startBrowser({ type: 'printer' }, service => {
  console.log('Found service:', service)
})

Index

Methods

destroy findOne makeBrowser makeService publish startBrowser unpublishAll

Methods

destroy

destroy(): Promise<void>
Destroys the DNSSD instance, stopping all services and shutting down the server.

No further operations should be performed after destruction.

Returns Promise<void>
- Defined in DNSSD.ts:133

findOne

findOne(
options?: BrowserOptions,
timeoutMs?: number,
): Promise<null | DiscoveredService>
Discovers a single service matching the provided criteria, with a timeout.

Stops discovery after the first match or when the timeout is reached.
Parameters
- Optionaloptions: BrowserOptions
  Optional browser options to filter services.
- timeoutMs: number = 10000
  Maximum time in milliseconds to wait for a match.
Returns Promise<null | DiscoveredService>
A promise that resolves with the discovered service or null if none found.
- Defined in DNSSD.ts:106

makeBrowser

makeBrowser(options?: BrowserOptions): Browser
Creates a new mDNS browser for discovering services on the network.
Parameters
- Optionaloptions: BrowserOptions
  Optional configuration for the browser.
Returns Browser
A new Browser instance.
- Defined in DNSSD.ts:77

makeService

makeService(options: ServiceOptions): Service
Creates a new service instance without publishing it to the network.
Parameters
- options: ServiceOptions
  Configuration options for the service.
Returns Service
A new Service instance linked to this registry.
- Defined in DNSSD.ts:47

publish

publish(options: ServiceOptions): Promise<Service>
Publishes a service to the network using the given options.
Parameters
- options: ServiceOptions
  Configuration options for the service.
Returns Promise<Service>
A promise that resolves with the published service.
- Defined in DNSSD.ts:57

startBrowser

startBrowser(
options?: BrowserOptions,
onServiceUp?: (service: DiscoveredService) => void,
): Browser
Creates and starts a browser for discovering services, with an optional handler for discovered services.
Parameters
- Optionaloptions: BrowserOptions
  Optional configuration for the browser.
- OptionalonServiceUp: (service: DiscoveredService) => void
  Optional callback invoked when a service is discovered.
Returns Browser
A started Browser instance.
- Defined in DNSSD.ts:88

unpublishAll

unpublishAll(): Promise<void>
Unpublishes all services that were previously published.

Sends goodbye messages and clears internal state.

Returns Promise<void>
- Defined in DNSSD.ts:66

Class DNSSD

Example

Index

Methods

Methods

destroy

Returns Promise<void>

findOne

Parameters

Returns Promise<null | DiscoveredService>

makeBrowser

Parameters

Returns Browser

makeService

Parameters

Returns Service

publish

Parameters

Returns Promise<Service>

startBrowser

Parameters

Returns Browser

unpublishAll

Returns Promise<void>

Settings

On This Page