Read arrays as standard WhatWG streams.
Switch branches/tags
Nothing to show
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
.gitignore
.npmignore
LICENSE
README.md
cancel.js
index.js
package.json
read.js
rollup.config.js

README.md

array-source

A readable stream reader for reading from an in-memory array.

API Reference

# array(array) <>
# array(length)
# array(object)
# array(buffer)

Returns a sliceable source for the specified Uint8Array. If the specified array is not a Uint8Array, it is passed to the Uint8Array constructor to create a new array; see the TypedArray constructor for details.

# source.read() <>

Returns a Promise for the next chunk of data from the underlying stream. The yielded result is an object with the following properties:

  • value - a Uint8Array, or undefined if the stream ended
  • done - a boolean which is true if the stream ended

# source.cancel() <>

Returns a Promise which is resolved when the underlying stream has been destroyed.