Socket
Socket
Sign inDemoInstall

stream-browserify

Package Overview
Dependencies
5
Maintainers
40
Versions
14
Alerts
File Explorer

Advanced tools

Install Socket

Detect and block malicious and high-risk dependencies

Install

    stream-browserify

the stream module from node core for browsers


Version published
Maintainers
40
Install size
191 kB
Created

Package description

What is stream-browserify?

The stream-browserify npm package is a browser-compatible version of Node.js's core stream module. It allows developers to use stream-based operations in browser environments, similar to how they would in Node.js. This includes the ability to create readable, writable, duplex, and transform streams, which can be used for handling data in a more efficient and modular way.

What are stream-browserify's main functionalities?

Creating a Readable Stream

This code sample demonstrates how to create a readable stream that emits data from an array. Each chunk of data is pushed to the stream and logged to the console when the 'data' event is emitted.

const Stream = require('stream-browserify');
let data = ['stream', 'browserify'];
let readable = Stream.Readable({
  read(size) {
    if (data.length === 0) this.push(null);
    else this.push(data.shift());
  }
});
readable.on('data', (chunk) => {
  console.log(chunk.toString());
});

Creating a Writable Stream

This code sample shows how to create a writable stream that logs any data written to it to the console.

const Stream = require('stream-browserify');
let writable = new Stream.Writable({
  write(chunk, encoding, callback) {
    console.log(chunk.toString());
    callback();
  }
});
writable.write('Hello, world!');

Piping Streams

This example demonstrates how to pipe data from a readable stream directly into a writable stream. The data from the readable stream is logged to the console as it's written to the writable stream.

const Stream = require('stream-browserify');
let readable = Stream.Readable.from(['stream', 'browserify']);
let writable = new Stream.Writable({
  write(chunk, encoding, callback) {
    console.log(chunk.toString());
    callback();
  }
});
readable.pipe(writable);

Transform Stream

This code sample illustrates how to create a transform stream that converts any input data to uppercase. The transform stream is piped from stdin and then piped to stdout, effectively creating a stream that uppercases input from the command line.

const Stream = require('stream-browserify');
let transform = new Stream.Transform({
  transform(chunk, encoding, callback) {
    this.push(chunk.toString().toUpperCase());
    callback();
  }
});
process.stdin.pipe(transform).pipe(process.stdout);

Other packages similar to stream-browserify

Changelog

Source

3.0.0

  • Upgrade to readable-stream 3. For breaking changes, see the readable-stream notes.

Readme

Source

stream-browserify

the stream module from node core, for browsers!

This module uses readable-stream, with additions for compatibility with npm packages that use old Node.js stream APIs.

build status

Install

You usually do not have to install stream-browserify yourself! If your code runs in Node.js, stream is built in, or readable-stream can be used. If your code runs in the browser, bundlers like browserify also include the stream-browserify module.

But if none of those apply, with npm do:

npm install stream-browserify

API

Consult the node core documentation on streams.

Browser Support

Cross-browser testing generously provided by Sauce Labs.

Sauce Test Status

License

MIT

Keywords

FAQs

Last updated on 16 Apr 2020

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