npmpackage.info

Gathering detailed insights and metrics for async-iterator-to-stream

Other packages similar to async-iterator-to-stream

stream-to-it

1.0.1

Convert Node.js streams to streaming iterables

event-iterator

2.0.0

Convert event emitters and event targets to ES async iterators

it-pipe

3.0.1

Utility to "pipe" async iterables together

stream-to-async-iterator

1.0.0

ES async interator wrapper for node streams

Gathering detailed insights and metrics for async-iterator-to-stream

async-iterator-to-stream - 1.2.0 | npmpackage.info

async-iterator-to-stream

Convert an async iterator/iterable to a readable stream

1.2.0

ISC

JavaScript

10.67 kB

720,537 1.7

Installations

npm install async-iterator-to-stream

Developer Guide

BETA

Typescript

No

Module System

CommonJS

Min. Node Version

>=6

Node Version

12.16.1

NPM Version

6.14.4 Score

70.6

Supply Chain

99.2

Quality

78.6

Maintenance

100

Vulnerability

100

License

Pull Requests

Open

12

Total

13

Closed

1

Issues

Open

1

Total

2

Closed

1

Releases

Unable to fetch releases

Languages

JavaScript

JavaScript (100%)

Developer

JsCommunity

Download Statistics

Total Downloads

720,537

Last Day

Last Week

796

Last Month

3,670

Last Year

54,955

GitHub Statistics

ISC License

7 Stars

30 Commits

2 Watchers

13 Branches

1 Contributors

Updated on Apr 13, 2023

Bundle Size

36.88 kB

Minified

10.67 kB

Minified + Gzipped

Bundlephobia

Maintainers

View All 1 Contributors

Package Meta Information

Latest Version

1.2.0

Package Id

async-iterator-to-stream@1.2.0

Size

5.70 kB

NPM Version

6.14.4

Node Version

12.16.1

Published on

Apr 10, 2020

Total Downloads

Cumulative downloads

Total Downloads

720,537

Last Day

-30.1%

Compared to previous day

Last Week

-13.4%

796

Compared to previous week

Last Month

-13.8%

3,670

Compared to previous month

Last Year

-64.2%

54,955

Compared to previous year

Weekly Downloads

Monthly Downloads

Yearly Downloads

Dependencies

readable-stream

Dev Dependencies

@babel/cli @babel/core @babel/preset-env babel-eslint babel-jest cross-env eslint eslint-config-prettier eslint-config-standard eslint-plugin-import eslint-plugin-node eslint-plugin-promise eslint-plugin-standard husky jest lint-staged prettier rimraf

async-iterator-to-stream

Convert an async iterator/iterable to a readable stream

Even though this library is dedicated to async iterators, it is fully compatible with synchronous ones.

Furthermore, generators can be used to create readable stream factories!

Install

Installation of the npm package:

> npm install --save async-iterator-to-stream

Usage

1const asyncIteratorToStream = require("async-iterator-to-stream");
2
3// sync/async iterators
4asyncIteratorToStream(new Set(["foo", "bar"]).values()).pipe(output);
5
6// sync/async iterables
7asyncIteratorToStream.obj([1, 2, 3]).pipe(output);
8
9// if you pass a sync/async generator, it will return a factory instead of a
10// stream
11const createRangeStream = asyncIteratorToStream.obj(function*(n) {
12  for (let i = 0; i < n; ++i) {
13    yield i;
14  }
15});
16createRangeStream(10).pipe(output);

Example

Let's implement a simpler fs.createReadStream to illustrate the usage of this library.

1const asyncIteratorToStream = require("async-iterator-to-stream");
2
3// promisified fs
4const fs = require("mz/fs");
5
6const createReadStream = asyncIteratorToStream(async function*(file) {
7  const fd = await fs.open(file, "r");
8  try {
9    let size = yield;
10    while (true) {
11      const buf = Buffer.alloc(size);
12      const [n] = await fs.read(fd, buf, 0, size, null);
13      if (n < size) {
14        yield buf.slice(0, n);
15        return;
16      }
17      size = yield buf;
18    }
19  } finally {
20    await fs.close(fd);
21  }
22});
23
24createReadStream("foo.txt").pipe(process.stdout);

If your environment does not support async generators, you may use a sync generator instead and yield promises to wait for them.

Development

# Install dependencies
> npm

# Run the tests
> npm test

# Continuously compile
> npm run dev

# Continuously run the tests
> npm run dev-test

# Build for production
> npm run build

Contributions

Contributions are very welcomed, either on the documentation or on the code.

You may:

report any issue you've encountered;
fork and create a pull request.

License

No vulnerabilities found.

10

Binary-Artifacts

Determines if the project has generated executable (binary) artifacts in the source repository.

10

License

Determines if the project has defined a license.

0

Code-Review

Determines if the project requires human code review before pull requests (aka merge requests) are merged.

0

SAST

Determines if the project uses static code analysis.

0

Maintained

Determines if the project is "actively maintained".

0

CII-Best-Practices

Determines if the project has an OpenSSF (formerly CII) Best Practices Badge.

0

Security-Policy

Determines if the project has published a security policy.

0

Fuzzing

Determines if the project uses fuzzing.

0

Branch-Protection

Determines if the default and release branches are protected with GitHub's branch protection settings.

0

Vulnerabilities

Determines if the project has open, known unfixed vulnerabilities.

Score

1.7

/10

Last Scanned on 2025-05-05

The Open Source Security Foundation is a cross-industry collaboration to improve the security of open source software (OSS). The Scorecard provides security health metrics for open source projects.

Learn More