ksm2/isomorphic-streams

Isomorphic WHATWG Streams API package for browser and Node.js

isomorphic-streams

Isomorphic WHATWG Streams API package for browser and Node.js

This package has

• zero dependencies
• provides TypeScript typings
• supports ReadableStream, WritableStream and TransformStream

Table of Contents

• Install
• Usage
• Contributing
• License

Install

Use either

yarn add isomorphic-streams

or

npm install isomorphic-streams

Usage

In the browser: Instead of using the global ReadbaleStream or window.ReadableStream, import from this package instead.

In Node.js: Instead of importing node:stream/web or requiring stream/web, import from this package instead.

The following code will work in both Node.js and the browser:

import { ReadableStream } from "isomorphic-streams";

const SECOND = 1000;

const stream = new ReadableStream({
  start(controller) {
    setInterval(() => {
      controller.enqueue(Date.now());
    }, SECOND);
  },
});

for await (const value of stream) {
  console.log(value);
}

More examples

Contributing

This project is open to feedback and contributions, please open an issue.

isomorphic-streams follows the Contributor Covenant Code of Conduct.

License

MIT © 2021 Konstantin Möllers, see LICENSE.

isomorphic-streams's Issues

Missing type declaration for static method `from`

Hello,

Nice work, it's great to be able to use streaming in a library that might be used in either the back or front end.

One minor thing, the type declaration for the class ReadableStream is missing the static method from. It should look something like:

export class ReadableStream<T> {
  // ...
  static from(iterable: Iterable<T> | AsyncIterable<T>): ReadableStream<T>
  // ...
}

Cheers.

use polyfill fallback for older env?

What do you think?
use web-streams-polyfill when it isn't avalible?