Socket
Socket
Sign inDemoInstall

is-stream

Package Overview
Dependencies
0
Maintainers
1
Versions
8
Alerts
File Explorer

Advanced tools

Install Socket

Detect and block malicious and high-risk dependencies

Install

    is-stream

Check if something is a Node.js stream


Version published
Weekly downloads
77M
decreased by-0.13%
Maintainers
1
Install size
7.44 kB
Created
Weekly downloads
 

Package description

What is is-stream?

The is-stream npm package is a simple utility used to check if an object is a Node.js stream. It can differentiate between readable, writable, duplex (both readable and writable), and transform (a type of duplex stream) streams. This package is useful when you need to validate that a given object conforms to the stream interface expected by Node.js APIs.

What are is-stream's main functionalities?

Check if an object is a stream

This feature allows you to check if a given object is a Node.js stream.

const isStream = require('is-stream');

isStream(process.stdin); // true
isStream({}); // false

Check if a stream is readable

This feature allows you to check if a stream is a readable stream.

const isStream = require('is-stream');

isStream.readable(process.stdin); // true
isStream.readable(process.stdout); // false

Check if a stream is writable

This feature allows you to check if a stream is a writable stream.

const isStream = require('is-stream');

isStream.writable(process.stdout); // true
isStream.writable(process.stdin); // false

Check if a stream is a duplex stream

This feature allows you to check if a stream is a duplex stream, which is both readable and writable.

const isStream = require('is-stream');
const { Duplex } = require('stream');

const duplexStream = new Duplex();
isStream.duplex(duplexStream); // true
isStream.duplex(process.stdin); // false

Check if a stream is a transform stream

This feature allows you to check if a stream is a transform stream, which is a type of duplex stream with additional functionality.

const isStream = require('is-stream');
const { Transform } = require('stream');

const transformStream = new Transform();
isStream.transform(transformStream); // true
isStream.transform(process.stdin); // false

Other packages similar to is-stream

Readme

Source

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.

  • is-file-stream - Detect if a stream is a file stream

Keywords

FAQs

Last updated on 19 Feb 2024

Did you know?

Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.

Install

Related posts

SocketSocket SOC 2 Logo

Product

  • Package Alerts
  • Integrations
  • Docs
  • Pricing
  • FAQ
  • Roadmap

Stay in touch

Get open source security insights delivered straight into your inbox.


  • Terms
  • Privacy
  • Security

Made with ⚡️ by Socket Inc