Homec4science
Diffusion Open Access Compliance Check Tool (OACCT) (master) Browse

rOACCT/node_modules/is-stream
dd570dbc4621master

Compare
History

is-stream

index.d.ts
index.js
license
package.json
readme.md

readme.md

is-stream

Check if something is a Node.js stream

Install

$ npm install is-stream

Usage

js
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 [Stream](https://nodejs.org/api/stream.html#stream_stream).

isStream.writable(stream)

Returns a boolean for whether it's a [stream.Writable](https://nodejs.org/api/stream.html#stream_class_stream_writable).

isStream.readable(stream)

Returns a boolean for whether it's a [stream.Readable](https://nodejs.org/api/stream.html#stream_class_stream_readable).

isStream.duplex(stream)

Returns a boolean for whether it's a [stream.Duplex](https://nodejs.org/api/stream.html#stream_class_stream_duplex).

isStream.transform(stream)

Returns a boolean for whether it's a [stream.Transform](https://nodejs.org/api/stream.html#stream_class_stream_transform).

Related

<div align="center"> <b>

		<a href="https://tidelift.com/subscription/pkg/npm-is-stream?utm_source=npm-is-stream&utm_medium=referral&utm_campaign=readme">Get professional support for this package with a Tidelift subscription</a>

</b> <br> <sub>

		Tidelift helps make open source sustainable for maintainers while giving companies<br>assurances about security, maintenance, and licensing for their dependencies.

</sub> </div>

c4science · Help