Skip to content

Commit

Permalink
use stream.Readable instead of experimental web ReadableStream in jsdoc
Browse files Browse the repository at this point in the history
  • Loading branch information
ngraef authored and kylefarris committed Feb 17, 2022
1 parent d26e529 commit 1114515
Showing 1 changed file with 2 additions and 6 deletions.
8 changes: 2 additions & 6 deletions index.js
Original file line number Diff line number Diff line change
Expand Up @@ -12,15 +12,11 @@ const fs = require('fs');
const nodePath = require('path'); // renamed to prevent conflicts in `scanDir`
const { promisify } = require('util');
const { execFile } = require('child_process');
const { PassThrough, Transform, ReadableStream } = require('stream');
const { PassThrough, Transform, Readable } = require('stream');
const { Socket } = require('dgram');
const NodeClamError = require('./lib/NodeClamError');
const NodeClamTransform = require('./lib/NodeClamTransform.js');

/**
* @typedef {ReadableStream} ReadableStream
*/

// Enable these once the FS.promises API is no longer experimental
// const fsPromises = require('fs').promises;
// const fsAccess = fsPromises.access;
Expand Down Expand Up @@ -2106,7 +2102,7 @@ class NodeClam {
* use of a TCP or UNIX Domain socket. In other words, this will not work if you only
* have access to a local ClamAV binary.
*
* @param {ReadableStream} stream - A readable stream to scan
* @param {Readable} stream - A readable stream to scan
* @param {Function} [cb] - What to do when the socket response with results
* @returns {Promise<object>} Object like: `{ file: String, isInfected: Boolean, viruses: Array }`
* @example
Expand Down

0 comments on commit 1114515

Please sign in to comment.