npm package discovery and stats viewer.

Discover Tips

  • General search

    [free text search, go nuts!]

  • Package details

    pkg:[package-name]

  • User packages

    @[username]

Sponsor

Optimize Toolset

I’ve always been into building performant and accessible sites, but lately I’ve been taking it extremely seriously. So much so that I’ve been building a tool to help me optimize and monitor the sites that I build to make sure that I’m making an attempt to offer the best experience to those who visit them. If you’re into performant, accessible and SEO friendly sites, you might like it too! You can check it out at Optimize Toolset.

About

Hi, 👋, I’m Ryan Hefner  and I built this site for me, and you! The goal of this site was to provide an easy way for me to check the stats on my npm packages, both for prioritizing issues and updates, and to give me a little kick in the pants to keep up on stuff.

As I was building it, I realized that I was actually using the tool to build the tool, and figured I might as well put this out there and hopefully others will find it to be a fast and useful way to search and browse npm packages as I have.

If you’re interested in other things I’m working on, follow me on Twitter or check out the open source projects I’ve been publishing on GitHub.

I am also working on a Twitter bot for this site to tweet the most popular, newest, random packages from npm. Please follow that account now and it will start sending out packages soon–ish.

Open Software & Tools

This site wouldn’t be possible without the immense generosity and tireless efforts from the people who make contributions to the world and share their work via open source initiatives. Thank you 🙏

© 2024 – Pkg Stats / Ryan Hefner

@balena/stream-adapters

v1.0.0-dummy-branch-6bb8338bf74e9654f38eff8283913a7e97c89bf4

Published

WhatWG web streams and Node stream conversion utilities for node.js

Downloads

20

Readme

@balena/stream-adapters

WhatWG web streams and conversion utilities for node.js, browser-ready.

With the release of the web streams api for node, people are bound to be interoperating between the two, which as the motivation for this utility library.

This package is meant to be operable from a node instance or a browser.

If you are going to be working on the browser or an older instance of node without the WebStream API, you will need the polyfills:

  • stream-browserify
  • web-streams-polyfill

This code is mostly taken the node internals, and just made to work on both browser and server.

Note: This is an experimental api built on top of another experimental api. Use with caution.

Installation

npm install @balena/stream-adapters

with peer dependencies:

npm install @balena/stream-adapters stream-browserify web-streams-polyfill

Usage

The toNode method converts any underlying stream to a Node stream.

If it's a ReadableStream, it will be converted to a stream.Readable. If it's a WritableStream, it will be converted to a stream.Writable.

class MySource {
  constructor(value = new Uint8Array(10)) {
    this.value = value;
  }

  start(c) {
    this.started = true;
    this.controller = c;
  }

  pull(controller) {
    controller.enqueue(this.value);
    controller.close();
  }

  cancel(reason) {
    this.canceled = true;
    this.cancelReason = reason;
  }
}

const rs = new ReadableStream(MySource);

toNode(rs) // creates a node read stream

It can also take a ReadableStream and a WritableStream and create a stream.Duplex.

const rs = new ReadableStream(MySource);
const ws = new WritableStream(MySource);

toNode({readable: rs, writable: ws}, {highWaterMark: 16}) // creates a stream.Duplex

Likewise, streams can be converted to web streams with the toWeb methods.

const sr = Readable.from("hello world")
toWeb(sr) // creates ReadableStream
const sw = getStreamWritableSomehow()
toWeb(sw) // creates WritableStream

And you can create a ReadableStream and WritableStream from a stream.Duplex, like so:

const duplex = new PassThrough();
toWeb(duplex) // returns { readable, writable }, a ReadableStream and WritableStream

There is also a pipeline that will convert all streams to node as it pipes them.

const rs = new ReadableStream(MySource);
const duplex = new PassThrough();
const ws = getWritableStreamSomehow();
pipeline(rs, duplex, ws, err => { // this will convert all streams to node streams
  if (err) {
    console.error(err)
  }
})

This api will likely change though, so I wouldn't recommend you use it. I just have to implement it, but the pipeline will convert the source to the output of the last stream in the pipeline.

There are a few other utility functions exported for your convenience if you want to be more explicit:

newStreamDuplexFromReadableWritablePair
newReadableStreamFromStreamReadable
newWritableStreamFromStreamWritable
newStreamWritableFromWritableStream
newReadableStreamFromStreamReadable

I'll leave it as an exercise to the reader to figure out what they do ;)

Credits

The code in here was mostly written by @jasnell, I just adapted it to support multiple environments from the node internals.