Registry / serialization / stream-browserify

stream-browserify

library3.0.0jsnpmunverified

stream-browserify is a module that provides the Node.js `stream` API for browser environments. It serves as a polyfill, allowing npm packages designed for Node.js streams to function correctly within a browser context when bundled. The current stable version is 3.0.0, released after a period of using `readable-stream` v2, and now fully leverages `readable-stream` v3. This package is primarily intended for use with bundlers like Browserify, which automatically substitute the native Node.js `stream` module with `stream-browserify` during the bundling process. Its key differentiator is providing a consistent, spec-compliant stream implementation that bridges the gap between Node.js module expectations and browser limitations, ensuring broad compatibility for legacy and modern stream APIs in the browser.

serialization http-networking web-framework

npm install stream-browserify

github ↗package ↗

INSTALL

IMPORT

SIG · STREAM-BROWSERIFY

stream-browserify

serializationjavascriptv3.0.0

Install

—

Import

—

Disk

—

Pass rate

0/ 6

Env Coverage0 / 6

glibc

18–22

musl

18–22

Install & Compatibility

Where this runs

tested against v? · npm install

Install × environment matrix

Each cell = how many times install + import succeeded across repeated harness runs. Partial = flaky.
glibc = Debian/Ubuntu slim · musl = Alpine Linux

musl

node 18–226 runs

build_error

glibc

node 18–226 runs

build_error

Code

Verified usage

Verified import paths — ran on the pinned version, not inferred.

Readable

✓ import { Readable } from 'stream-browserify';

✗ const Readable = require('stream-browserify').Readable;

While named imports are supported for direct usage, bundlers like Browserify typically remap `require('stream')` to this module.

Writable

✓ import { Writable } from 'stream-browserify';

✗ import Writable from 'stream-browserify/writable';

All stream classes are exported as named exports from the main entry point.

Transform

✓ import { Transform } from 'stream-browserify';

✗ const stream = require('stream-browserify'); const Transform = stream.Transform;

CommonJS `require('stream-browserify').Transform` is also a valid pattern, especially when using Browserify which shims `require('stream')`.

Demonstrates creating and piping a basic readable stream to a writable stream using `stream-browserify`.

import { Readable, Writable } from 'stream-browserify'; class MyReadable extends Readable { constructor(options) { super(options); this.index = 0; } _read(size) { if (this.index < 5) { this.push(`Chunk ${this.index++}\n`); } else { this.push(null); // No more data } } } class MyWritable extends Writable { _write(chunk, encoding, callback) { console.log(`Received: ${chunk.toString()}`); callback(); } } const readableStream = new MyReadable(); const writableStream = new MyWritable(); readableStream.pipe(writableStream); // Expected output: // Received: Chunk 0 // Received: Chunk 1 // Received: Chunk 2 // Received: Chunk 3 // Received: Chunk 4

Debug

Known issues

breakingVersion 3.0.0 upgrades to `readable-stream` v3. This introduces several breaking changes inherited from `readable-stream` itself, aligning with Node.js 10+ stream APIs. Developers should consult the `readable-stream` v3 release notes for detailed information.

fix

Review the `readable-stream` v3 documentation for breaking changes (e.g., changes to `_read` behavior, error handling, `pipeline`, and `finished` utilities). Adapt stream implementations and consumption patterns accordingly.

affects: >=3.0.0

gotchaDirect installation of `stream-browserify` is often unnecessary. Bundlers like Browserify automatically include and alias this module when `require('stream')` is encountered in browser environments.

fix

If using Browserify, avoid explicit `npm install stream-browserify` unless a specific version conflict or direct module access is required. Rely on the bundler's resolution.

affects: *

gotchaMixing different versions of `readable-stream` (or `stream-browserify` which depends on it) within a single application can lead to unpredictable behavior and compatibility issues, especially when libraries expect specific stream API behaviors.

fix

Use `npm ls readable-stream` or `yarn why readable-stream` to inspect your dependency tree. Resolve any duplicate or conflicting `readable-stream` versions to ensure a consistent stream implementation across your project. Consider `resolutions` or `overrides` if necessary.

affects: *

Errors

Common errors & fixes

TypeError: stream.Readable is not a constructor

This typically occurs in a browser environment where the native Node.js 'stream' module is not available or has not been correctly polyfilled by a bundler, or if an old CJS `require` is used in an incompatible ESM context.

fix

Ensure your project is bundled with a tool like Browserify that provides `stream-browserify` as a shim for `require('stream')`. If directly importing, use `import { Readable } from 'stream-browserify';`. Verify bundler configuration.

Cannot find module 'stream'

This error means that `require('stream')` or `import 'stream'` could not be resolved, most commonly in a browser environment without an appropriate polyfill or bundler configuration.

fix

If using Browserify, ensure `stream-browserify` is correctly integrated by the bundler. If not using a bundler or needing a global stream polyfill, you might need to manually configure aliasing or ensure `stream-browserify` is included in your build process.

Upgrade

Version history

3.0.0latest on npm

Audit

Dependencies

readable-streamrequiredProvides the underlying stream implementation, upgraded to v3 in stream-browserify v3.0.0.

Agent activity

19 hits · last 30 days

node

OpenAI (training)

Resources

githubhttps://github.com/browserify/stream-browserify ↗

packagehttps://www.npmjs.com/package/stream-browserify ↗