it-queueless-pushable

A pushable queue that waits until a value is consumed before accepting another

About

A pushable async generator that waits until the current value is consumed before allowing a new value to be pushed.

Useful for when you don't want to keep memory usage under control and/or allow a downstream consumer to dictate how fast data flows through a pipe, but you want to be able to apply a transform to that data.

Example

import { queuelessPushable } from 'it-queueless-pushable'

const pushable = queuelessPushable<string>()

// run asynchronously
Promise.resolve().then(async () => {
  // push a value - the returned promise will not resolve until the value is
  // read from the pushable
  await pushable.push('hello')
})

// read a value
const result = await pushable.next()
console.info(result) // { done: false, value: 'hello' }

Install

$ npm i it-queueless-pushable

Browser `<script>` tag

Loading this module through a script tag will make its exports available as ItQueuelessPushable in the global namespace.

<script src="https://unpkg.com/it-queueless-pushable/dist/index.min.js"></script>

API Docs

https://achingbrain.github.io/it/modules/it-queueless-pushable.html

License

Licensed under either of

Apache 2.0, (LICENSE-APACHE / http://www.apache.org/licenses/LICENSE-2.0)
MIT (LICENSE-MIT / http://opensource.org/licenses/MIT)

Contribution

Unless you explicitly state otherwise, any contribution intentionally submitted for inclusion in the work by you, as defined in the Apache-2.0 license, shall be dual licensed as above, without any additional terms or conditions.

Current Tags

2.0.5 ... latest (19 hours ago)