Skip to content

mbostock/array-source

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

10 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

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.

About

Read arrays as standard WhatWG streams.

Resources

License

Stars

Watchers

Forks

Packages

No packages published