codeql-action/node_modules/is-stream
2024-10-10 19:48:20 +01:00
..
index.d.ts Bump @ava/typescript from 3.0.1 to 4.0.0 (#1576) 2023-03-13 14:10:40 -07:00
index.js Bump @ava/typescript from 3.0.1 to 4.0.0 (#1576) 2023-03-13 14:10:40 -07:00
license Update checked-in dependencies 2021-08-09 19:49:49 +00:00
package.json Follow redirects 2024-10-10 19:48:20 +01:00
readme.md Bump @ava/typescript from 3.0.1 to 4.0.0 (#1576) 2023-03-13 14:10:40 -07:00

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.


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.