Class HSBonjourSearch

constructor

• new HSBonjourSearch(): HSBonjourSearch

  Returns HSBonjourSearch

Readonlyidentifier

includesPeerToPeer

findBrowsableDomains

• findBrowsableDomains(
      callback: (event: string, domain: string, moreComing: boolean) => void,
  ): HSBonjourSearch

  Searches for domains visible to this machine (browsable domains). If a browsable-domain search is already active it is stopped before starting the new one. Service and registration-domain searches are unaffected. The callback receives (event, domain, moreComing).

  Parameters

  • callback: (event: string, domain: string, moreComing: boolean) => void

    Called for each result with event name, domain string, and whether more results are expected

  Returns HSBonjourSearch

  self, for chaining

findRegistrationDomains

• findRegistrationDomains(
      callback: (event: string, domain: string, moreComing: boolean) => void,
  ): HSBonjourSearch

  Searches for domains on which this machine can register services. If a registration-domain search is already active it is stopped before starting the new one. Service and browsable-domain searches are unaffected. The callback receives (event, domain, moreComing).

  Parameters

  • callback: (event: string, domain: string, moreComing: boolean) => void

    Called for each result with event name, domain string, and whether more results are expected

  Returns HSBonjourSearch

  self, for chaining

findServices

• findServices(
      type: string,
      domain: string,
      callback: (
          event: string,
          service: HSBonjourService,
          moreComing: boolean,
      ) => void,
  ): HSBonjourSearch

  Searches for services of the given type in the given domain. If a service search is already active it is stopped before starting the new one. Domain searches are unaffected. The callback receives (event, service, moreComing) — see the type documentation for the complete event table.

  Parameters

  • type: string

    service type string, e.g. "_http._tcp." or "_ssh._tcp."

  • domain: string

    mDNS domain; "local." for the local link, "" for all domains

  • callback: (event: string, service: HSBonjourService, moreComing: boolean) => void

    Called for each result with event name, service object, and whether more results are expected

  Returns HSBonjourSearch

  self, for chaining

stop

• stop(): HSBonjourSearch

  Stops all active searches. Safe to call when no search is active.

  Returns HSBonjourSearch

  self, for chaining