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

@dirkluijk/promise-stream

v1.0.2

Published

A stream-like Promise for JavaScript

Downloads

15

Readme

PromiseStream 🌊

A stream-like promise that emits multiple values over time

NPM version NPM downloads Build status

Overview

What? 🤔

A simple building block that behaves like a regular Promise<T>, but can emit multiple values over time.

  • Compatible with async/await (awaits completion)
  • Provides built-in async iterator
  • Contains configurable buffer size

Limitations & when to use? 🤷‍♂️

Like regular promises, a PromiseStream<T> is not cancellable, is hot, shared, and will replay the last value. Furthermore, no built-in operator support (like map or flatMap) is currently provided.

The limitations are intended. For extensive reactive apps I would recommend to use RxJS instead.

Roadmap ideas 💡

  • Provide built-in RxJS compatibility utils
  • Support different backpressure mechanisms

How to use 🌩

Install

npm install @dirkluijk/promise-stream

Creating a PromiseStream<T>

This works the same as a regular Promise, but you have three callbacks: next, complete and error.

import { PromiseStream } from '@dirkluijk/promise-stream';

const myStream = new PromiseStream<string>((next, complete, error) => {
    next('foo');
    next('bar');
    next('baz');
    complete();
})
  • next always expects a value
  • complete never expects a value
  • error accepts an optional error value
  • once completed or failed, no values are accepted anymore

Consuming a PromiseStream<T>

You can use callbacks:

myStream
    .iterate(value => {
        // executed when value is emitted
    })
    .then(() => {
        // executed when completed
    })
    .catch((error) => {
        // executed when failed
    })

Since a PromiseStream invokes the .then() callback upon completion, it is compatible with async/await:

try {
    await myStream.iterate(value => {
        // executed when value is emitted
    });
} catch (error) {
    // executed when failed
}

// executed when completed

Additionally, you can also use the async iterator:

try {
    for await (const value of myStream.asyncIterator()) {
        // executed when value is emitted
    };
} catch (error) {
    // executed when failed
}

// executed when completed