Huge News!Announcing our $40M Series B led by Abstract Ventures.Learn More
Socket
Sign inDemoInstall
Socket

async-iterable-stream

Package Overview
Dependencies
Maintainers
1
Versions
15
Alerts
File Explorer

Advanced tools

Socket logo

Install Socket

Detect and block malicious and high-risk dependencies

Install

async-iterable-stream

A readable async stream which can be iterated over using a for-await-of loop.

  • 4.0.0
  • latest
  • Source
  • npm
  • Socket score

Version published
Weekly downloads
22
increased by37.5%
Maintainers
1
Weekly downloads
 
Created
Source

async-iterable-stream

A readable stream which can be iterated over using a for-await-of loop or using a while loop with await inside.

The AsyncIterableStream constructor is an abstract class which must be subclassed. Its next() and createAsyncIterator() methods must be overriden.

For a concrete subclass of AsyncIterableStream, see WritableAsyncIterableStream: https://github.com/SocketCluster/writable-async-iterable-stream

Installation

npm install async-iterable-stream

Usage

The AsyncIterableStream class exposes the following methods:

  • [Symbol.asyncIterator]: Makes the instance iterable using a for-await-of loop.
  • next: Returns a Promise which will resolve an object in the form {value: data, done: boolean} whenever some data is received or when the stream ends.
  • once: Similar to next() except that the resolved value will be the raw data and it will not resolve when the stream ends. Note that once once() is called, it cannot be cancelled; the affected closure will stay in memory until either once() resolves or until the stream is ended or garbage collected.
// Consume data objects from asyncIterableStream as they are written to the stream.
(async () => {
  for await (let data of asyncIterableStream) {
    console.log(data);
  }
})();

// Consume only the next data object which is written to the stream.
(async () => {
  let data = await asyncIterableStream.once();
  console.log(data);
})();

Keywords

FAQs

Package last updated on 17 Jan 2019

Did you know?

Socket

Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.

Install

Related posts

SocketSocket SOC 2 Logo

Product

  • Package Alerts
  • Integrations
  • Docs
  • Pricing
  • FAQ
  • Roadmap
  • Changelog

Packages

npm

Stay in touch

Get open source security insights delivered straight into your inbox.


  • Terms
  • Privacy
  • Security

Made with ⚡️ by Socket Inc