# it-concat

> Concat all buffers/strings yielded from an async iterable into a single BufferList/string

Latest version **3.0.3** (published 2024-04-17) · Apache-2.0 OR MIT license · 0 weekly downloads

## Install

```sh
npm install it-concat
pnpm add it-concat
yarn add it-concat
bun add it-concat
```

## Health

**Score 35/100 (D)** — status: abandoned.

Positive: has types; esm support; no vulnerabilities; has provenance; high quality score.

Warnings: low downloads.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 3.0.3 |
| Published | 2024-04-17 |
| First published | 2019-11-29 |
| Weekly downloads | 0 |
| License | Apache-2.0 OR MIT |
| TypeScript types | bundled |
| Module format | ESM |
| Node | >=16.0.0 |
| Dependencies | 2 |
| Unpacked size | 38.9 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| Provenance | attested (GitHub Actions) |
| GitHub stars | 1 |
| Author | Alan Shaw |
| Maintainers | achingbrain, alanshaw |
| Keywords | async, buffer, bufferlist, concat, glue, iterable, iterator, join, string |

## Links

- npm: https://www.npmjs.com/package/it-concat
- Repository: https://github.com/alanshaw/it-concat
- Homepage: https://github.com/alanshaw/it-concat#readme
- Issues: https://github.com/alanshaw/it-concat/issues
- npm.io page: https://npm.io/package/it-concat

## Dependencies (2)

- [uint8arrays](https://npm.io/package/uint8arrays.md) ^5.0.3
- [uint8arraylist](https://npm.io/package/uint8arraylist.md) ^2.3.3

## 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

- 3.0.3 (latest) — 2024-04-17
- 3.0.2 — 2024-04-17
- 3.0.1 — 2022-10-18
- 3.0.0 — 2022-10-18
- 2.0.0 — 2021-04-16
- 1.0.3 — 2021-03-22
- 1.0.2 — 2020-10-12
- 1.0.1 — 2020-09-03
- 1.0.0 — 2019-11-29

## README

# it-concat

[![codecov](https://img.shields.io/codecov/c/github/alanshaw/it-concat.svg?style=flat-square)](https://codecov.io/gh/alanshaw/it-concat)
[![CI](https://img.shields.io/github/actions/workflow/status/alanshaw/it-concat/js-test-and-release.yml?branch=master\&style=flat-square)](https://github.com/alanshaw/it-concat/actions/workflows/js-test-and-release.yml?query=branch%3Amaster)

> Concat all buffers/strings yielded from an async iterable into a single BufferList/string

# Install

```console
$ npm i it-concat
```

## Browser `<script>` tag

Loading this module through a script tag will make it's exports available as `ItConcat` in the global namespace.

```html
<script src="https://unpkg.com/it-concat/dist/index.min.js"></script>
```

## Usage

Concat Uint8Arrays to a single [`Uint8ArrayList`](https://www.npmjs.com/package/uint8arraylist):

```js
import concat from 'it-concat'
import { toString } from 'uint8arrays'
import fs from 'fs'

fs.writeFileSync('./test.txt', 'Hello World!')

// Node.js Readable Streams are async iterables!
const chunks = await concat(fs.createReadStream('./test.txt'))

// chunks is a Uint8ArrayList
console.log(chunks)
/*
Uint8ArrayList {
  _bufs: [ <Uint8Array 48 65 6c 6c 6f 20 57 6f 72 6c 64 21> ],
  length: 12
}
*/
console.log(toString(chunks.subarray)))
// Hello World!
```

Concat Uint8Arrays to a single *string*:

```js
import concat from 'it-concat'
import fs from 'fs'

fs.writeFileSync('./test.txt', 'Hello World!')

// Node.js Readable Streams are async iterables!
// Note that we pass `{ type: 'string' }` to tell concat that we want a string
// back and not a Uint8Array. This is necessary because the source data is Uint8Array(s).
const chunks = await concat(fs.createReadStream('./test.txt'), { type: 'string' })

console.log(chunks)
// Hello World!
```

Concat strings to a single string:

```js
import concat from 'it-concat'
import fs from 'fs'

fs.writeFileSync('./test.txt', 'Hello World!')

// Node.js Readable Streams are async iterables!
// Note that we don't need to pass `{ type: 'string' }` to tell concat that we
// want a string back because the source data is Uint8Array(s).
const chunks = await concat(fs.createReadStream('./test.txt', { encoding: 'utf8' }))

console.log(chunks)
// Hello World!
```

## API

```js
import concat from 'it-concat'
```

### `concat(source, options?): Promise`

Concat all Uint8Arrays or strings yielded from the async iterable `source` into a single [`Uint8ArrayList`](https://www.npmjs.com/package/bl) or `string`.

- `source` (`AsyncIterable<Uint8Array | Uint8ArrayList | string>`) - the source iterable to concat from
- `options` (`Object`) - optional options
- `options.type` (`string`) - return type of the function, pass `'string'` to recieve a string or `'Uint8Array'` for a `Uint8ArrayList`.

Returns a `Promise` that resolves to a `Uint8ArrayList` or `string`.

If `options.type` is *not* passed the type of the objects yielded from the `source` is detected and a `Uint8ArrayList` or `string` is returned appropriately. If the `source` does not yield anything an empty `Uint8ArrayList` is returned. If the source is expected to return strings (but may not yield anything), pass `options.type: 'string'` to ensure an empty string is returned instead of an empty `Uint8ArrayList`.

## Related

- [`stream-to-it`](https://www.npmjs.com/package/stream-to-it) Convert Node.js streams to streaming iterables
- [`it-pipe`](https://www.npmjs.com/package/it-pipe) Utility to "pipe" async iterables together

[List of awesome modules for working with async iterables](https://github.com/alanshaw/it-awesome).

# License

Licensed under either of

- Apache 2.0, ([LICENSE-APACHE](LICENSE-APACHE) / <http://www.apache.org/licenses/LICENSE-2.0>)
- MIT ([LICENSE-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.

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