# list-stream
> Collect chunks / objects from a readable stream, write obejcts / chunks to a writable stream
Latest version **2.1.0** (published 2021-12-02) · MIT license · 0 weekly downloads
## Install
```sh
npm install list-stream
pnpm add list-stream
yarn add list-stream
bun add list-stream
```
## Health
**Score 23/100 (F)** — status: abandoned.
Positive: has types package; no vulnerabilities; high quality score.
Warnings: low downloads; no esm support.
Negative: abandoned; low maintenance score.
## Facts
| | |
|---|---|
| Version | 2.1.0 |
| Published | 2021-12-02 |
| First published | 2014-01-25 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | separate (@types/list-stream) |
| Module format | CommonJS |
| Dependencies | 1 |
| Unpacked size | 11.7 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 26 |
| Maintainers | rvagg |
| Keywords | buffer, stream |
## Links
- npm: https://www.npmjs.com/package/list-stream
- Repository: https://github.com/rvagg/list-stream
- Issues: https://github.com/rvagg/list-stream/issues
- npm.io page: https://npm.io/package/list-stream
## Dependencies (1)
- [readable-stream](https://npm.io/package/readable-stream.md) ~3.4.0
## Alternatives
- [flatbuffers](https://npm.io/package/flatbuffers.md) — 6.0M weekly downloads
- [jwt-simple](https://npm.io/package/jwt-simple.md) — 259.5K weekly downloads
- [@exodus/patch-broken-hermes-typed-arrays](https://npm.io/package/@exodus/patch-broken-hermes-typed-arrays.md) — 28.5K weekly downloads
- [@native-to-anchor/buffer-layout](https://npm.io/package/@native-to-anchor/buffer-layout.md) — 12.2K weekly downloads
- [binary-parser-encoder](https://npm.io/package/binary-parser-encoder.md) — 5.3K weekly downloads
## Recent versions
- 2.1.0 (latest) — 2021-12-02
- 2.0.0 — 2019-10-14
- 1.0.1 — 2016-01-14
- 1.0.0 — 2014-08-21
- 0.0.1 — 2014-01-25
- 0.0.0 — 2014-01-25
## README
# ListStream
[](http://travis-ci.org/rvagg/list-stream)
**Collect chunks / objects from a readable stream, write obejcts / chunks to a writable stream**
[](https://nodei.co/npm/list-stream/)
Built on a [DuplexStream](http://nodejs.org/docs/latest/api/stream.html#stream_class_stream_duplex), **ListStream** can collect the chunks as they come in so you can use them later as an array, or pipe them on to another stream.
Using the same callback style as **[bl](https://github.com/rvagg/bl)** and a similar style to **[concat-stream](https://github.com/maxogden/concat-stream)**, you can use **ListStream** as a terminal stream collecting the chunks or objects for use once the stream has ended. This is particularly helpful for object streams where each chunk is a discrete object.
```js
var ListStream = require('list-stream')
, db = require('level')('/path/to/db', { valueEncoding: 'json' }) // stream from LevelDB!
db.createValueStream().pipe(ListStream.obj(function (err, data) {
if (err)
throw err
console.log('Values in the database:')
// `data` is an array of objects from the database, serialised from JSON strings
data.forEach(function (value, i) {
console.log(i, JSON.stringify(value))
})
}))
```
Or emulate `fs.readFile()`:
```js
var ListStream = require('list-stream')
, fs = require('fs')
fs.createReadStream('/path/to/file.dat').pipe(ListStream(function (err, data) {
if (err)
throw err
console.log('Contents of /path/to/file.dat:')
// `data` is an array of Buffer objects
console.log(Buffer.concat(data).toString('utf8'))
}))
```
*See [bl](https://github.com/rvagg/bl) for nicer Buffer stream handling*
Or use as a store to stream from later
```js
var list = require('list-stream').obj()
, db = require('level')('/path/to/db')
list.write({ key: 'name', value: 'Yuri Irsenovich Kim' })
list.write({ key: 'dob', value: '16 February 1941' })
list.write({ key: 'spouse', value: 'Kim Young-sook' })
list.write({ key: 'occupation', value: 'Clown' })
list.pipe(db.createWriteStream()) // write all of the stored entries to a database
```
## API
* [new ]ListStream([ options, ][ callback ])
* ListStream.obj([ options, ][ callback ])
* listStream.length
* listStream.append(obj)
* listStream.get(index)
* listStream.end()
* listStream.duplicate()
--------------------------------------------------------
### [new ]ListStream([ options, ][ callback ])
Create a new **ListStream** with the given `options` which will be passed up to the parent `DuplexStream`.
The optional `callback` will be called when the stream reaches an *end* event. You will receive both an `error` argument and a `data` argument where the `error` will come off `'error'` events emitted by any piped stream and the `data` will be an **`Array`** of chunks or objects fed in to the stream.
--------------------------------------------------------
### ListStream.obj([ options, ][ callback ])
Same as the standard constructor but shorthand for `new ListStream({ objectMode:true }, callback)`.
Use this for when you're not dealing with `Buffer`s or `String`s in your streams.
--------------------------------------------------------
### listStream.length
The number of chunks currently being held. (Not available in pre-ES5 environments as it uses a *getter*)
--------------------------------------------------------
### listStream.append(obj)
Append a chunk / object to the list.
--------------------------------------------------------
### listStream.get(index)
Get the chunk / object from the list at index `index`.
--------------------------------------------------------
### listStream.end()
End the stream. A standard *WritableStream* method, can be used when piping to another stream:
```js
listStream.pipe(fs.createWriteStream(os.tmpDir() + '/randombytes.dat'))
for (var i = 0; i < 100)
listStream.append(crypto.randomBytes(32))
listStream.end()
```
--------------------------------------------------------
### listStream.duplicate()
Create a full duplicate of this `ListStream`. Each item in the list will be `.append()`ed to the new copy. The copy will be returned.
## License
**ListStream** is Copyright (c) 2014 Rod Vagg [@rvagg](https://twitter.com/rvagg) and licenced under the MIT licence. All rights not explicitly granted in the MIT license are reserved. See the included LICENSE.md file for more details.
---
_Source: https://npm.io/package/list-stream · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._