local-network-scan
Version:
A lightweight library to quickly scan local network
38 lines • 1.19 kB
TypeScript
/**
* Simple logger object, to use it as the library logger
*/
export interface Logger {
info: (log: string) => void;
error: (log: string) => void;
}
/**
* A device in the network
*/
export interface NetworkDevice {
/** Device's IP */
ip: string;
/** Device's MAC address */
mac?: string;
/** Device's vendor name */
vendor?: string;
}
/**
* Scan local network options
*/
export interface ScanOptions {
/** The local network to scan, should look like xxx.xxx.xxx (default it's machine first IP network) */
localNetwork?: string;
/** Detect devices vendor from https://macvendors.com/ API (default false) */
queryVendor?: boolean;
/** Ping timeout - default 1000 * 2.5 (2.5s) */
pingTimeoutMS?: number;
/** Query vendors timeout - default 1000 * 60 (60s) */
queryVendorsTimeoutMS?: number;
/** ping batch size - default 50 */
beachesSize?: number;
/** clean in-mem cache of vendor by mac address */
clearVendorsCache?: boolean;
/** Allow pass any logger to use it instead of default 'console' output */
logger?: Logger;
}
//# sourceMappingURL=models.d.ts.map