is-stream

Check if something is a Node.js stream

Usage no npm install needed!

<script type="module">
  import isStream from 'https://cdn.skypack.dev/is-stream';
</script>

README

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)

Returns a boolean for whether it's a Stream.

isWritableStream(stream)

Returns a boolean for whether it's a stream.Writable.

isReadableStream(stream)

Returns a boolean for whether it's a stream.Readable.

isDuplexStream(stream)

Returns a boolean for whether it's a stream.Duplex.

isTransformStream(stream)

Returns a boolean for whether it's a stream.Transform.

Related

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