Name Last Update
..
index.d.ts Loading commit data...
index.js Loading commit data...
license Loading commit data...
package.json Loading commit data...
readme.md Loading commit data...

readme.md

is-stream

Check if something is a Node.js stream

Install

$ npm install is-stream

Usage

const fs = require('fs');
const isStream = require('is-stream');

isStream(fs.createReadStream('unicorn.png'));
//=> true

isStream({});
//=> false

API

isStream(stream)

Returns a boolean for whether it's a <code>Stream</code>.

isStream.writable(stream)

Returns a boolean for whether it's a <code>stream.Writable</code>.

isStream.readable(stream)

Returns a boolean for whether it's a <code>stream.Readable</code>.

isStream.duplex(stream)

Returns a boolean for whether it's a <code>stream.Duplex</code>.

isStream.transform(stream)

Returns a boolean for whether it's a <code>stream.Transform</code>.


Get professional support for this package with a Tidelift subscription Tidelift helps make open source sustainable for maintainers while giving companiesassurances about security, maintenance, and licensing for their dependencies.