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

@sec-ant/readable-stream

v0.6.0

Published

A tiny, zero-dependency yet spec-compliant asynchronous iterator polyfill/ponyfill for ReadableStreams.

Downloads

7,114,295

Readme

@sec-ant/readable-stream

npm version npm downloads bundlephobia minzipped npm license

A tiny, zero-dependency yet spec-compliant asynchronous iterator polyfill/ponyfill for ReadableStreams.

Features

Asynchronously iterate a ReadableStream

With this package, you can consume a ReadableStream as an AsyncIterable.

  • spec: https://streams.spec.whatwg.org/#rs-asynciterator
  • tests: https://github.com/Sec-ant/readable-stream/blob/main/tests/asyncIterator.spec.ts (copied from wpt)

Convert an AsyncIterable or an Iterable into a ReadableStream

With this package, you can construct a ReadableStream from an AsyncIterable or an Iterable.

  • spec: https://streams.spec.whatwg.org/#rs-from
  • tests: https://github.com/Sec-ant/readable-stream/blob/main/tests/fromAnyIterable.spec.ts (copied from wpt)

This package passes all the aforementioned tests.

Install

npm i @sec-ant/readable-stream

Usage

Ponyfill

This package can be imported as a ponyfill to avoid side effects:

asyncIterator

Path:

@sec-ant/readable-stream/ponyfill/asyncIterator

Example:

import {
  asyncIterator,
  type ReadableStreamIteratorOptions,
} from "@sec-ant/readable-stream/ponyfill/asyncIterator";

const readableStream = (await fetch("https://www.example.org/")).body;

let total = 0;
for await (const chunk of asyncIterator(readableStream)) {
  total += chunk.length;
}

console.log(total);

Check https://streams.spec.whatwg.org/#rs-class-definition and https://streams.spec.whatwg.org/#rs-asynciterator for further explanation on ReadableStreamIteratorOptions.

fromAnyIterable

Path:

@sec-ant/readable-stream/ponyfill/fromAnyIterable

Example:

import { fromAnyIterable } from "@sec-ant/readable-stream/ponyfill/fromAnyIterable";

const readableStream = fromAnyIterable(["a", "b"]);

All-in-One

Path:

@sec-ant/readable-stream/ponyfill

Example:

import {
  fromAnyIterable,
  asyncIterator,
  type ReadableStreamIteratorOptions,
} from "@sec-ant/readable-stream/ponyfill";

Polyfill

This package can be imported as a drop-in polyfill with side effects.

ReadableStream.prototype[Symbol.asyncIterator] and ReadableStream.prototype.values

Path:

@sec-ant/readable-stream/polyfill/asyncIterator

Example:

import "@sec-ant/readable-stream/polyfill/asyncIterator";

const readableStream = (await fetch("https://www.example.org/")).body;

let total = 0;
for await (const chunk of readableStream) {
  total += chunk.length;
}

console.log(total);

ReadableStream.from

Path:

@sec-ant/readable-stream/polyfill/fromAnyIterable

Example:

import "@sec-ant/readable-stream/polyfill/fromAnyIterable";

const readableStream = ReadableStream.from(["a", "b"]);

Note that ReadableStream.from is not typed because declared vars cannot be overridden.

All-in-One

Path:

@sec-ant/readable-stream/polyfill

Example:

import "@sec-ant/readable-stream/polyfill";

Ponyfill + Polyfill

asyncIterator

Path:

@sec-ant/readable-stream/asyncIterator

Example:

import {
  asyncIterator,
  type ReadableStreamIteratorOptions,
} from "@sec-ant/readable-stream/asyncIterator";
// also with side effects

fromAnyIterable

Path:

@sec-ant/readable-stream/fromAnyIterable

Example:

import { fromAnyIterable } from "@sec-ant/readable-stream/fromAnyIterable";
// also with side effects

All-in-One

Path:

@sec-ant/readable-stream

Example:

import {
  fromAnyIterable,
  asyncIterator,
  type ReadableStreamIteratorOptions,
} from "@sec-ant/readable-stream";
// also with side effects

Types

You can also use this package to augment the ReadableStream type for async iteration if the runtime already supports it but the type system does not.

Path:

@sec-ant/readable-stream/async-iterator

Example:

/// <reference types="@sec-ant/readable-stream/async-iterator" />

License

MIT