clamscan - npm Package Compare versions

Comparing version 2.0.2 to 2.0.3

API.md

@@ -17,9 +17,2 @@ ## Classes
 
-## Typedefs
-
-<dl>
-<dt><a href="#ReadableStream">ReadableStream</a> : <code><a href="#ReadableStream">ReadableStream</a></code></dt>
-<dd></dd>
-</dl>
-
 <a name="NodeClam"></a>
@@ -83,3 +76,3 @@
 | [options.clamdscan.active] | <code>boolean</code> | <code>true</code> | If true, this module will consider using the `clamdscan` binary |
-| [options.clamdscan.bypassRest] | <code>boolean</code> | <code>false</code> | If true, check to see if socket is avaliable |
+| [options.clamdscan.bypassTest] | <code>boolean</code> | <code>false</code> | If true, check to see if socket is avaliable |
 | [options.preference] | <code>object</code> | <code>&#x27;clamdscan&#x27;</code> | If preferred binary is found and active, it will be used by default |
@@ -115,3 +108,3 @@ | [cb] | <code>function</code> |  | Callback method. Prototype: `(err, <instance of NodeClam>)` |
         active: true,
-        bypassRest: false,
+        bypassTest: false,
     },
@@ -374,3 +367,3 @@ preference: 'clamdscan'
 | --- | --- | --- |
-| stream | [<code>ReadableStream</code>](#ReadableStream) | A readable stream to scan |
+| stream | <code>Readable</code> | A readable stream to scan |
 | [cb] | <code>function</code> | What to do when the socket response with results |
@@ -474,5 +467,1 @@
 
-<a name="ReadableStream"></a>
-
-## ReadableStream : [<code>ReadableStream</code>](#ReadableStream)
-**Kind**: global typedef  

examples/passthrough.js

@@ -39,7 +39,7 @@ // eslint-disable-next-line import/no-extraneous-dependencies
     const clamscan = await new NodeClam().init({
-        debug_mode: true,
+        debugMode: true,
         clamdscan: {
             host: 'localhost',
             port: 3310,
-            bypass_test: true,
+            bypassTest: true,
             // socket: '/var/run/clamd.scan/clamd.sock',
@@ -46,0 +46,0 @@ },

examples/stream.js

@@ -17,5 +17,5 @@ const { PassThrough } = require('stream');
     const clamscan = await new NodeClam().init({
-        debug_mode: false,
+        debugMode: false,
         clamdscan: {
-            bypass_test: true,
+            bypassTest: true,
             host: 'localhost',
@@ -22,0 +22,0 @@ port: 3310,

examples/version.js

@@ -5,3 +5,3 @@ // Initialize the clamscan module
 const ClamScan = new NodeClam().init({
-    debug_mode: false,
+    debugMode: false,
     // prettier-ignore
@@ -11,3 +11,3 @@ clamdscan: {
         path: '/usr/bin/clamdscan',                // <-- Secondary fallback to command line -|
-        config_file: '/etc/clamd.d/daemon.conf',   // <---------------------------------------|
+        configFile: '/etc/clamd.d/daemon.conf',   // <---------------------------------------|
         // Connect via Host/Port
@@ -28,4 +28,4 @@ host: 'localhost',                         // <-- Primary fallback - |
 ClamScan.then(async (av) => {
-    const result = await av.get_version();
+    const result = await av.getVersion();
     console.log('Version: ', result);
 });

package.json

 {
   "name": "clamscan",
-  "version": "2.0.2",
+  "version": "2.0.3",
   "author": "Kyle Farris <[e-mail]> (https://infotechinc.com)",
@@ -5,0 +5,0 @@ "description": "Use Node JS to scan files on your server with ClamAV's clamscan/clamdscan binary or via TCP to a remote server or local UNIX Domain socket. This is especially useful for scanning uploaded files provided by un-trusted sources.",

No alert changes

Improved metrics

Total package byte prevSize

268982

increased by0.76%

Number of package files

31

increased by3.33%

No dependency changes