Skip to content

Commit 1114515

Browse files
ngraefkylefarris
authored andcommitted
use stream.Readable instead of experimental web ReadableStream in jsdoc
1 parent d26e529 commit 1114515

1 file changed

Lines changed: 2 additions & 6 deletions

File tree

index.js

Lines changed: 2 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -12,15 +12,11 @@ const fs = require('fs');
1212
const nodePath = require('path'); // renamed to prevent conflicts in `scanDir`
1313
const { promisify } = require('util');
1414
const { execFile } = require('child_process');
15-
const { PassThrough, Transform, ReadableStream } = require('stream');
15+
const { PassThrough, Transform, Readable } = require('stream');
1616
const { Socket } = require('dgram');
1717
const NodeClamError = require('./lib/NodeClamError');
1818
const NodeClamTransform = require('./lib/NodeClamTransform.js');
1919

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

0 commit comments

Comments
 (0)