mdns-browse/index.d.ts

A module to browse for dnssd services.

export interface BrowseCriteria {
  type: string;
  protocol: string;
  subtype?: string;
  interfaceIndex?: number;
  ipProtocol?: "ipv4" | "ipv6";
}

export type TxtRecord = {
  key: string;
  value?: string;
};

export type BrowseResult = {
  type: string;
  protocol: string;
  name: string;
  domain: string;
  hostname: string;
  address: string;
  port: number;
  interfaceIndex: number;
  txtRecords: TxtRecord[];
};

export function find(
  options: BrowseCriteria,
  predicate?: (result: BrowseResult) => boolean,
  signal?: AbortSignal
): Promise<BrowseResult>;

export function startBrowse(
  options: BrowseCriteria,
  callback: (results: BrowseResult[]) => void
): () => void;