3.0.0 • Published 2 years ago

@commonify/is-stream v3.0.0

Weekly downloads
-
License
MIT
Repository
github
Last release
2 years ago

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