browser-readablestream-to-it

browser-readablestream-to-it

Turns a browser readble stream into an async iterator

Table of contents

• Install
  • Browser <script> tag
• Usage
  • preventCancel
• License
• Contribution

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>

Usage

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

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.