dns-sd

A DNS Service Discovery implementation in modern TypeScript

This is a rewrite of the bonjour-service library that fixes multiple issues and applies latest TypeScript best practice

Installation

pnpm i @collight/dns-sd

Usage

Comprehensive demos

pnpm i

# demo/main.ts
pnpm demo

# demo/publish.ts
pnpm demo:publish

# demo/browse.ts
pnpm demo:browse

Basic usage

import { dnssd } from '@collight/dns-sd';

const dnssd = new DNSSD();

// advertise an HTTP server on port 3000
dnssd.publish({ name: 'My Web Server', type: 'http', port: 3000 });

// browse for all http services
const browser = dnssd.startBrowser({ filter: { protocol: 'tcp', type: 'http' } }, s => {
  console.log('Found an HTTP server:', s);
});

API Docs

http://collight.gitlab.io/dns-sd

Development

pnpm i

pnpm format && pnpm lint

pnpm build && pnpm test

pnpm doc

License

MIT