browser-readablestream-to-it
TypeScript icon, indicating that this package has built-in type declarations

2.0.5 • Public • Published

codecov CI

Turns a browser readble stream into an async iterator

About

Allows treating a browser readable stream as an async iterator.

Example

import toIt from 'browser-readablestream-to-it'
import all from 'it-all'

const content = [0, 1, 2, 3, 4]

const stream = new ReadableStream({
  start(controller) {
    for (let i = 0; i < content.length; i++) {
      controller.enqueue(content[i])
    }

    controller.close()
  }
})

const arr = await all(toIt(stream))

console.info(arr) // 0, 1, 2, 3, 4

preventCancel

By default a readable stream will have .cancel called on it once it has ended or reading has stopped prematurely.

To prevent this behaviour, pass preventCancel: true as an option:

const arr = await all(toIt(stream, { preventCancel: true }))

console.info(arr) // 0, 1, 2, 3, 4

Install

$ npm i browser-readablestream-to-it

Browser <script> tag

Loading this module through a script tag will make it's exports available as BrowserReadablestreamToIt in the global namespace.

<script src="https://unpkg.com/browser-readablestream-to-it/dist/index.min.js"></script>

License

Licensed under either of

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.

Readme

Keywords

none

Package Sidebar

Install

npm i browser-readablestream-to-it

Weekly Downloads

66,352

Version

2.0.5

License

Apache-2.0 OR MIT

Unpacked Size

12.8 kB

Total Files

9

Last publish

Collaborators

  • achingbrain