@types/bonjour

What is @types/bonjour?

@types/bonjour provides TypeScript definitions for the bonjour package, which is used for zero-configuration networking using multicast DNS (mDNS) service discovery. It allows you to publish and discover services on a local network without any configuration.

What are @types/bonjour's main functionalities?

Publishing a Service

This feature allows you to publish a service on the local network. In this example, a web server service is published on port 3000.

const bonjour = require('bonjour')();
const service = bonjour.publish({ name: 'My Web Server', type: 'http', port: 3000 });
service.start();

Browsing for Services

This feature allows you to browse for services of a specific type on the local network. In this example, it searches for HTTP servers and logs the details of any found services.

const bonjour = require('bonjour')();
bonjour.find({ type: 'http' }, function (service) {
  console.log('Found an HTTP server:', service);
});

Stopping a Service

This feature allows you to stop a published service. In this example, the previously published web server service is stopped.

const bonjour = require('bonjour')();
const service = bonjour.publish({ name: 'My Web Server', type: 'http', port: 3000 });
service.start();
// Later, stop the service
service.stop();

Unpublishing All Services

This feature allows you to unpublish all services that have been published by the bonjour instance. In this example, two services are published and then all services are unpublished.

const bonjour = require('bonjour')();
// Publish some services
const service1 = bonjour.publish({ name: 'Service1', type: 'http', port: 3000 });
const service2 = bonjour.publish({ name: 'Service2', type: 'http', port: 3001 });
service1.start();
service2.start();
// Unpublish all services
bonjour.unpublishAll();

Other packages similar to @types/bonjour

mdns

The mdns package provides multicast DNS service discovery, similar to bonjour. It allows you to advertise and browse services on the local network. Compared to bonjour, mdns offers more low-level control over the mDNS protocol but may require more configuration.

multicast-dns

The multicast-dns package is a low-level implementation of multicast DNS in JavaScript. It provides the basic building blocks for mDNS service discovery but does not include the higher-level abstractions found in bonjour. It is suitable for developers who need fine-grained control over mDNS operations.

dnssd

The dnssd package is another option for DNS-SD (DNS Service Discovery) and mDNS. It provides a high-level API similar to bonjour but with additional features and optimizations. It is a good alternative for developers looking for a more feature-rich solution.

README

Installation

npm install --save @types/bonjour

Summary

This package contains type definitions for bonjour (https://github.com/watson/bonjour).

Details

Files were exported from https://github.com/DefinitelyTyped/DefinitelyTyped/tree/master/types/bonjour.

Additional Details

• Last updated: Mon, 06 Nov 2023 22:41:05 GMT
• Dependencies: @types/node

Credits

These definitions were written by Quentin Lampin.