| .. | ||
| index.d.ts | ||
| index.js | ||
| license | ||
| package.json | ||
| readme.md | ||
is-stream
Check if something is a Node.js stream
Install
npm install is-stream
Usage
import fs from 'node:fs';
import {isStream} from 'is-stream';
isStream(fs.createReadStream('unicorn.png'));
//=> true
isStream({});
//=> false
API
isStream(stream, options?)
Returns a boolean for whether it's a Stream.
isWritableStream(stream, options?)
Returns a boolean for whether it's a stream.Writable, an http.OutgoingMessage, an http.ServerResponse or an http.ClientRequest.
isReadableStream(stream, options?)
Returns a boolean for whether it's a stream.Readable or an http.IncomingMessage.
isDuplexStream(stream, options?)
Returns a boolean for whether it's a stream.Duplex.
isTransformStream(stream, options?)
Returns a boolean for whether it's a stream.Transform.
Options
checkOpen
Type: boolean
Default: true
When this option is true, the method returns false if the stream has already been closed.
Related
- is-file-stream - Detect if a stream is a file stream