# array-source

> Read arrays as standard WhatWG streams.

Latest version **0.0.4** (published 2017-09-02) · BSD-3-Clause license · 0 weekly downloads

## Install

```sh
npm install array-source
pnpm add array-source
yarn add array-source
bun add array-source
```

## Health

**Score 20/100 (F)** — status: abandoned.

Positive: esm support; no vulnerabilities.

Warnings: low downloads; no types; pre 1.0.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 0.0.4 |
| Published | 2017-09-02 |
| First published | 2016-09-06 |
| Weekly downloads | 0 |
| License | BSD-3-Clause |
| TypeScript types | none |
| Module format | ESM + CommonJS |
| Dependencies | 0 |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 6 |
| Author | Mike Bostock |
| Maintainers | mbostock |
| Keywords | binary, stream, reader |

## Links

- npm: https://www.npmjs.com/package/array-source
- Repository: https://github.com/mbostock/array-source
- Issues: https://github.com/mbostock/array-source/issues
- npm.io page: https://npm.io/package/array-source

## Alternatives

- [byte-size](https://npm.io/package/byte-size.md) — 2.1M weekly downloads
- [speed-limiter](https://npm.io/package/speed-limiter.md) — 16.0K weekly downloads
- [@powersync/node](https://npm.io/package/@powersync/node.md) — 10.9K weekly downloads
- [@ledgerhq/coin-cardano](https://npm.io/package/@ledgerhq/coin-cardano.md) — 1.0K weekly downloads
- [@jayesol/jayeson.lib.streamfinder](https://npm.io/package/@jayesol/jayeson.lib.streamfinder.md) — 1.0K weekly downloads

## Recent versions

- 0.0.4 (latest) — 2017-09-02
- 0.0.3 — 2016-09-06
- 0.0.2 — 2016-09-06
- 0.0.1 — 2016-09-06

## README

# array-source

A [readable stream reader](https://streams.spec.whatwg.org/#readable-stream-reader) for reading from an in-memory array.

## API Reference

<a name="array" href="#array">#</a> <b>array</b>(<i>array</i>) [<>](https://github.com/mbostock/array-source/blob/master/index.js#L4 "Source")
<br><a href="#array">#</a> <b>array</b>(<i>length</i>)
<br><a href="#array">#</a> <b>array</b>(<i>object</i>)
<br><a href="#array">#</a> <b>array</b>(<i>buffer</i>)

Returns a sliceable *source* for the specified [Uint8Array](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/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](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/TypedArray#Syntax) for details.

<a name="source_read" href="#source_read">#</a> <i>source</i>.<b>read</b>() [<>](https://github.com/mbostock/array-source/blob/master/read.js "Source")

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](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Uint8Array), or undefined if the stream ended
* `done` - a boolean which is true if the stream ended

<a name="source_cancel" href="#source_cancel">#</a> <i>source</i>.<b>cancel</b>() [<>](https://github.com/mbostock/array-source/blob/master/cancel.js "Source")

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

---
_Source: https://npm.io/package/array-source · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._