mirror of
https://github.com/zhigang1992/DefinitelyTyped.git
synced 2026-05-30 18:43:21 +08:00
34d30931f0
* new typings * updated types into a namespace to allow the default function to be fired * typo on findOne * DT tests passed
83 lines
2.7 KiB
TypeScript
83 lines
2.7 KiB
TypeScript
// Type definitions for bonjour 3.5
|
|
// Project: https://github.com/watson/bonjour
|
|
// Definitions by: Quentin Lampin <https://github.com/quentin-ol/>, Nicolas Voigt <https://github.com/octo-sniffle>
|
|
// Definitions: https://github.com/DefinitelyTyped/DefinitelyTyped
|
|
///<reference types="node" />
|
|
|
|
declare function bonjour(opts?: bonjour.BonjourOptions): bonjour.Bonjour;
|
|
export = bonjour;
|
|
declare namespace bonjour {
|
|
/**
|
|
* Start a browser
|
|
*
|
|
* The browser listens for services by querying for PTR records of a given
|
|
* type, protocol and domain, e.g. _http._tcp.local.
|
|
*
|
|
* If no type is given, a wild card search is performed.
|
|
*
|
|
* An internal list of online services is kept which starts out empty. When
|
|
* ever a new service is discovered, it's added to the list and an "up" event
|
|
* is emitted with that service. When it's discovered that the service is no
|
|
* longer available, it is removed from the list and a "down" event is emitted
|
|
* with that service.
|
|
*/
|
|
interface Browser extends NodeJS.EventEmitter {
|
|
services: Service[];
|
|
start(): void;
|
|
update(): void;
|
|
stop(): void;
|
|
on(event: 'up' | 'down', listener: (service: Service) => void): this;
|
|
once(event: 'up' | 'down', listener: (service: Service) => void): this;
|
|
removeListener(event: 'up' | 'down', listener: (service: Service) => void): this;
|
|
removeAllListeners(event: 'up' | 'down'): this;
|
|
}
|
|
interface BrowserOptions {
|
|
type?: string;
|
|
subtypes?: string[];
|
|
protocol?: string;
|
|
txt?: Object;
|
|
}
|
|
|
|
interface ServiceOptions {
|
|
name: string;
|
|
host?: string;
|
|
port: number;
|
|
type: string;
|
|
subtypes?: string[];
|
|
protocol?: 'udp'|'tcp';
|
|
txt?: Object;
|
|
}
|
|
|
|
interface Service extends NodeJS.EventEmitter {
|
|
name: string;
|
|
type: string;
|
|
subtypes: string[];
|
|
protocol: string;
|
|
host: string;
|
|
port: number;
|
|
fqdn: string;
|
|
txt: Object;
|
|
published: boolean;
|
|
|
|
stop(cb: () => any): void;
|
|
start(): void;
|
|
}
|
|
interface BonjourOptions {
|
|
multicast?: boolean;
|
|
interface?: string;
|
|
port?: number;
|
|
ip?: string;
|
|
ttl?: number;
|
|
loopback?: boolean;
|
|
reuseAddr?: boolean;
|
|
}
|
|
interface Bonjour {
|
|
(opts?: BonjourOptions): Bonjour;
|
|
publish(options: ServiceOptions): Service;
|
|
unpublishAll(cb?: () => void): void;
|
|
find(options: BrowserOptions, onUp?: (service: Service) => void): Browser;
|
|
findOne(options: BrowserOptions, cb?: (service: Service) => void): Browser;
|
|
destroy(): void;
|
|
}
|
|
}
|