port-scanner: updated docs

mi-sec · May 22, 2020 · b3e96e1 · b3e96e1
1 parent 6bbf353
commit b3e96e1
Show file tree

Hide file tree

Showing 3 changed files with 12 additions and 5 deletions.
diff --git a/packages/port-scanner/NOTES.md b/packages/port-scanner/NOTES.md
diff --git a/packages/port-scanner/README.md b/packages/port-scanner/README.md
@@ -14,14 +14,22 @@ port scanner utility
 
 ### Usage
 
+*`connectionOpts` is a direct pass in to
+[`net.createConnection(<opts>)`](https://nodejs.org/api/net.html#net_socket_connect_options_connectlistener)
+
 ```
 import PortScanner from '@mi-sec/port-scanner';
 
 const scan = new PortScanner( {
 	host: '192.168.1.0/24',
 	ports: [ 22 ],
-	timeout: 100,
-	attemptToIdentify: true
+	timeout: 1000,           // optional
+    debug: false,            // optional
+    onlyReportOpen: true,    // optional
+    bannerGrab: true,        // optional
+    identifyService: true,   // optional
+	attemptToIdentify: true, // optional
+    connectionOpts: {}       // optional*
 } );
 
 const data   = [];

diff --git a/packages/port-scanner/lib/port-scanner.js b/packages/port-scanner/lib/port-scanner.js
@@ -258,7 +258,7 @@ class PortScanner extends EventEmitter
 			Array.isArray( this.opts.ports ) ? this.opts.ports : [ this.opts.ports ] :
 			[ ...commonPorts.keys() ];
 
-		this.opts.timeout = this.opts.timeout || 500;
+		this.opts.timeout = this.opts.timeout || 1000;
 
 		this.opts.debug           = this.opts.hasOwnProperty( 'debug' ) ? this.opts.debug : false;
 		this.opts.onlyReportOpen  = this.opts.hasOwnProperty( 'onlyReportOpen' ) ? this.opts.onlyReportOpen : true;
@@ -273,7 +273,7 @@ class PortScanner extends EventEmitter
 		!this.opts.debug || console.log( `  debug: ${ this.opts.debug }` );
 		!this.opts.debug || console.log( `  onlyReportOpen: ${ this.opts.onlyReportOpen }` );
 		!this.opts.debug || console.log( `  bannerGrab: ${ this.opts.bannerGrab }` );
-		!this.opts.debug || console.log( `  attemptToIdentify: ${ this.opts.attemptToIdentify }` );
+		!this.opts.debug || console.log( `  identifyService: ${ this.opts.identifyService }` );
 
 		this.result = new LightMap();