# through2-sink

> A through2 wrapper that just receives chunks and nothing else.

Latest version **1.0.0** (published 2015-04-06) · MIT license · 0 weekly downloads

## Install

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

## Health

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

Positive: no vulnerabilities.

Warnings: low downloads; no types; no esm support.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 1.0.0 |
| Published | 2015-04-06 |
| First published | 2015-04-06 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 2 |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 0 |
| Author | Sven Slootweg |
| Maintainers | joepie91 |
| Keywords | streams, through, through2, passthrough, spy |

## Links

- npm: https://www.npmjs.com/package/through2-sink
- Repository: git@github.com:joepie91/through2-sink
- Homepage: https://github.com/joepie91/through2-sink
- Issues: https://github.com/joepie91/through2-sink/issues
- npm.io page: https://npm.io/package/through2-sink

## Dependencies (2)

- [xtend](https://npm.io/package/xtend.md) ~3.0.0
- [through2](https://npm.io/package/through2.md) ~0.5.1

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

- 1.0.0 (latest) — 2015-04-06

## README

through2-spy
============

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

This is a super thin wrapper around [through2](http://npm.im/through2) for creating simple 'terminus' streams, that do nothing but look at the chunk received.

This module is heavily based on Bryce B. Baril's [through2-spy](https://www.npmjs.com/package/through2-spy), with the `.push` call removed. Why? So that you can have the same functionality at the *end* of a pipeline, without buffering everything up. It was originally written to help implement progress events in [bhttp](https://www.npmjs.com/package/bhttp). If you were to just use `through2-spy` for this, then [this](https://github.com/joyent/node/issues/14477) would happen.

Pass a function to run as each chunk goes through your stream pipeline. Return an Error to abort the pipeline.

```js

var sink = require("through2-sink")

var count = 0
var countChunks = sink(function (chunk) {
  count++
})

// vs. with through2:
var countChunks = through2(function (chunk, encoding, callback) {
  count++
  return callback()
})

// Then use your sink:
source.pipe(countChunks)

// Additionally accepts `wantStrings` argument to conver buffers into strings
var nsaregex = /(open source)|(foss)|(node\.js)|(mods are asleep)|(post sinks)/i
var prizm = sink({wantStrings: true}, function (str) {
  var buggyWiretap = str.match(nsaregex)
  if (buggyWiretap) {
    this.emit("OMGTERRIST", buggyWiretap[0], str)
  }
})

prizm.on("OMGTERRIST", sendDrone(/* ... */))

internet.pipe(prizm) // can't have the terrists getting their packets!

// Return an Error to abort the pipeline
var Meter = sink.ctor({maxBytes: 1024, bytes: 0}, function (chunk) {
  this.options.bytes += chunk.length
  if (this.options.bytes >= this.options.maxBytes) return new Error("Over 1024 byte limit!")
})

var meter = new Meter()

```

API
---

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

Create a `through2-sink` instance that will call `fn(chunk)` and then silently pass through data downstream.

`require("through2-sink").ctor([options], fn)`
---

Create a `through2-sink` Type that can be instantiated via `new Type()` or `Type()` to create reusable sinks.

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

Create a `through2-sink` that defaults to `objectMode = true`.

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

Create a `through2-sink` Type that defaults to `objectMode = true`.

Options
-------

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

LICENSE
=======

MIT

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