Package Exports

@balena/node-web-streams

This package does not declare an exports field, so the exports above have been automatically detected and optimized by JSPM instead. If any package subpath is missing, it is recommended to post an issue to the original package (@balena/node-web-streams) to support the "exports" field. If that is not possible, create a JSPM override to customize the exports field for this package.

Readme

@balena/node-web-streams

WhatWG web streams and conversion utilities for node.js

This is a fork of gwicke's node-web-streams module, which exposes webstream read errors as node error events. This is meant to provide a proper npm release until the respective upstream PR gets merged.

This provides the WhatWG streams API for node. It leverages the WhatWG reference implementation, but also addresses performance issues in that implementation.

Installation

npm install node-web-streams

Usage

// ES5 require syntax
var webStreams = require('node-web-streams');
var ReadableStream = webStreams.ReadableStream;
var toWebReadableStream = webStreams.toWebReadableStream;
var toNodeReadable = webStreams.toNodeReadable;

// ES6 import syntax
import { ReadableStream, toWebReadableStream, toNodeReadable } from "node-web-streams";

// Convert a node Readable to a web ReadableStream & back
const nodeReadable = require('fs').createReadStream('/tmp/test.txt');
const webReadable = toWebReadableStream(nodeReadable);
const roundTrippedNodeReadable = toNodeReadable(webReadable);