Skip to content

A high performance Stream alternative for Node.js and browser

License

Notifications You must be signed in to change notification settings

foxifyjs/stream

Repository files navigation

Stream

@foxify/stream is a high performance Stream alternative for Node.js and browser that has been optimized to be faster than the native version, (why not?!).

NPM Version TypeScript Version npm bundle size (minified) npm bundle size (minified + gzip) Tested With Jest Pull Requests License Build Status Coverage Status Package Quality Dependencies Status NPM Total Downloads NPM Monthly Downloads Open Issues Closed Issues known vulnerabilities Github Stars Github Forks

This module is API compatible with the Stream that ships by default with Node.js but there are some slight differences:

  • Uses @foxify/events as the EventEmitter.
  • The emitClose option is not available.

Table of Contents

Installation

npm i @foxify/stream

Usage

const { Readable, Writable, Duplex } = require("@foxify/stream");

For the API documentation, please follow the official Node.js documentation.

Benchmarks

npm run benchmarks

Versioning

We use SemVer for versioning. For the versions available, see the tags on this repository.

Authors

See also the list of contributors who participated in this project.

License

This project is licensed under the MIT License - see the LICENSE file for details