# through2-map

> A through2 to create an Array.prototype.map analog for streams.

Latest version **4.0.0** (published 2024-04-20) · MIT license · 0 weekly downloads

## Install

```sh
npm install through2-map
pnpm add through2-map
yarn add through2-map
bun add through2-map
```

## Health

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

Positive: has types package; no vulnerabilities; high quality score.

Warnings: low downloads; no esm support.

Negative: abandoned.

## Facts

| | |
|---|---|
| Version | 4.0.0 |
| Published | 2024-04-20 |
| First published | 2013-08-06 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | separate (@types/through2-map) |
| Module format | CommonJS |
| Node | >= 6 |
| Dependencies | 1 |
| Unpacked size | 10.3 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 70 |
| Author | Bryce B. Baril |
| Maintainers | bryce |
| Keywords | streams, through, through2, map |

## Links

- npm: https://www.npmjs.com/package/through2-map
- Repository: https://github.com/brycebaril/through2-map
- Homepage: https://github.com/brycebaril/through2-map#readme
- Issues: https://github.com/brycebaril/through2-map/issues
- npm.io page: https://npm.io/package/through2-map

## Dependencies (1)

- [through2](https://npm.io/package/through2.md) ^4.0.2

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

- 4.0.0 (latest) — 2024-04-20
- 3.1.0 — 2024-04-12
- 3.0.0 — 2016-11-05
- 2.0.0 — 2015-06-17
- 1.4.0 — 2014-06-10
- 1.3.0 — 2014-06-04
- 1.2.1 — 2013-12-13
- 1.2.0 — 2013-09-20
- 1.1.0 — 2013-08-07
- 1.0.2 — 2013-08-06
- 1.0.1 — 2013-08-06
- 1.0.0 — 2013-08-06

## README

through2-map
============

[![NPM](https://nodei.co/npm/through2-map.png)](https://nodei.co/npm/through2-map/)

This is a super thin wrapper around [through2](http://npm.im/through2) that works like `Array.prototype.map` but for streams.

For when through2 is just too verbose :wink:

Note you will **NOT** be able to skip chunks. This is intended for modification only. If you want filter the stream content, use either `through2` or `through2-filter`. This transform also does not have a `flush` function.

**IMPORTANT:** If you return `null` from your function, the stream will end there.

```js

var map = require("through2-map")

var truncate = map(function (chunk) {
  return chunk.slice(0, 10)
})

// vs. with through2:
var truncate = through2(function (chunk, encoding, callback) {
  this.push(chunk.slice(0, 10))
  return callback()
})

// Then use your map:
source.pipe(truncate).pipe(sink)

// Additionally accepts `wantStrings` argument to convert buffers into strings
var stripTags = map({wantStrings: true}, function (str) {
  // OMG don't actually use this
  return str.replace(/<.*?>/g, "")
})

// Works like `Array.prototype.map` meaning you can specify a function that
// takes up to two* arguments: fn(chunk, index)
var spaceout = map({wantStrings: true}, function (chunk, index) {
  return (index % 2 == 0) ? chunk + "\n\n" : chunk
})

// vs. with through2:
var spaceout = through2(function (chunk, encoding, callback) {
  if (this.index == undefined) this.index = 0
  var buf = (this.index++ % 2 == 0) ? Buffer.concat(chunk, new Buffer("\n\n")) : chunk
  this.push(buf)
  return callback()
})

```

*Differences from `Array.prototype.map`:
  * Cannot insert `null` elements into the stream without aborting.
  * No third `array` callback argument. That would require realizing the entire stream, which is generally counter-productive to stream operations.
  * `Array.prototype.map` doesn't modify the source Array, which is somewhat nonsensical when applied to streams.

API
---

```
require("through2-map")([options,] fn)
```

Create a `stream.Transform` instance that will call `fn(chunk, index)` on each stream segment.

- - -

```
var Tx = require("through2-map").ctor([options,] fn)
```

Create a reusable `stream.Transform` TYPE that can be called via `new Tx` or `Tx()` to create an instance.

- - -

```
require("through2-map").obj([options,] fn)
```

Create a `through2-map` instance that defaults to `objectMode: true`.

- - -

```
require("through2-map").objCtor([options,] fn)
```

Just like ctor, but with `objectMode: true` defaulting to true.

Options
-------

  * wantStrings: Automatically call chunk.toString() for the super lazy.
  * all other through2 options

LICENSE
=======

MIT

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