node-readable-to-web-readable-stream

node-readable-to-web-readable-stream is a utility that converts a Node.js Readable stream into a WHATWG-compatible ReadableStream. This is particularly useful for integrating Node.js streams with web-native streaming APIs.

Installation

Install the package using npm:

1npm install node-readable-to-web-readable-stream

Or with yarn:

1yarn add node-readable-to-web-readable-stream

Usage

Here's how you can use this utility to convert a Node.js Readable stream into a web ReadableStream:

1import {makeByteReadableStreamFromNodeReadable} from 'node-readable-to-web-readable-stream';
2import {createReadStream} from 'fs';
3
4// Create a Node.js Readable stream
5const nodeReadable = fs.createReadStream('example.txt');
6
7// Convert to a web ReadableStream
8const webReadable = makeByteReadableStreamFromNodeReadable(nodeReadable);
9
10// Now you can use webReadable as a WHATWG ReadableStream

Compatibility

This is an ECMAScript Module (ESM).

API

toWebReadableStream(nodeReadable)

• Parameters:

  • nodeReadable (Node.js Readable): The Node.js Readable stream to convert.

• Returns:

  • A WHATWG-compatible ReadableStream.

License

This project is licensed under the MIT License. See the LICENSE file for details.