Skip to content

sindresorhus/is-stream

Folders and files

NameName
Last commit message
Last commit date

Latest commit

ab06c4a · Oct 28, 2024

History

33 Commits
Oct 28, 2024
Apr 20, 2019
Apr 20, 2019
Apr 20, 2019
Apr 20, 2019
Feb 19, 2024
Feb 19, 2024
Feb 19, 2024
Jul 28, 2020
Feb 19, 2024
Feb 19, 2024
Feb 19, 2024

Repository files navigation

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