# @cuties/stream

> Cutie extension for stream module in Node.

Latest version **1.2.1** (published 2019-05-10) · MIT license · 0 weekly downloads

## Install

```sh
npm install @cuties/stream
pnpm add @cuties/stream
yarn add @cuties/stream
bun add @cuties/stream
```

## 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.2.1 |
| Published | 2019-05-10 |
| First published | 2018-08-28 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 6 |
| Unpacked size | 40.6 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 1 |
| Author | guseyn |
| Maintainers | guseyn |
| Keywords | cutie, stream |

## Links

- npm: https://www.npmjs.com/package/@cuties/stream
- Repository: https://github.com/Guseyn/cutie-stream
- Homepage: https://github.com/Guseyn/cutie-stream#readme
- Issues: https://github.com/Guseyn/cutie-stream/issues
- npm.io page: https://npm.io/package/@cuties/stream

## Dependencies (6)

- [@cuties/is](https://npm.io/package/@cuties/is.md) ^1.1.2
- [@cuties/wall](https://npm.io/package/@cuties/wall.md) ^1.1.2
- [@cuties/cutie](https://npm.io/package/@cuties/cutie.md) ^1.7.5
- [test-executor](https://npm.io/package/test-executor.md) ^1.2.4
- [@cuties/assert](https://npm.io/package/@cuties/assert.md) ^1.2.2
- [@cuties/iterator](https://npm.io/package/@cuties/iterator.md) ^1.1.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

- 1.2.1 (latest) — 2019-05-10
- 1.2.0 — 2019-02-21
- 1.1.4 — 2019-02-17
- 1.1.3 — 2019-02-17
- 1.1.2 — 2019-02-16
- 1.1.1 — 2018-09-22
- 1.1.0 — 2018-08-28

## README

# cutie-stream

[![NPM Version](https://img.shields.io/npm/v/@cuties/stream.svg)](https://npmjs.org/package/@cuties/stream)
[![Build Status](https://travis-ci.org/Guseyn/cutie-stream.svg?branch=master)](https://travis-ci.org/Guseyn/cutie-stream)
[![codecov](https://codecov.io/gh/Guseyn/cutie-stream/branch/master/graph/badge.svg)](https://codecov.io/gh/Guseyn/cutie-stream)

[Cutie](https://github.com/Guseyn/cutie) extension for <b>stream</b> module in Node. It's based on the [Async Tree Pattern](https://github.com/Guseyn/async-tree-patern/blob/master/Async_Tree_Patern.pdf).

## Examples

You can find examples of using this library in the [test directory](https://github.com/Guseyn/cutie-stream/tree/master/test).

## Install

`npm install @cuties/stream`

## Run test

`npm test`

## Run build

`npm run build`

## Usage

```js
const {
  // Needed async objects here from the table below
} = require('@cuties/stream');
```
For more information about parameters in the async objects visit [docs of Node](https://nodejs.org/en/docs/) for <b>stream</b> module.

## readable (here stream is readalbe)

| Async Object  | Async/sync call | Parameters(default value/description) | Representation result |
| ------------- | ----------------| ---------- | --------------------- |
| `DestroyedReadable` | `stream.destroy` | `stream, error` | `stream` |
| `IsPaused` | `stream.isPaused` | `stream` | `boolean` |
| `PausedReadable` | `stream.pause` | `stream` | `stream` |
| `PipedReadable` | `stream.pipe` | `stream, destination, options({end: true})` | `stream` |
| `ReadDataFromReadable` | [read](https://github.com/Guseyn/cutie-stream/blob/master/src/custom-calls/read.js) | `stream, size, limit(if true then it reads only the first chunk(with size as specified second argument), it's false by default)` | `string\|Buffer\|null` |
| `ReadableHighWaterMark` | `stream.readableHighWaterMark` | `stream` | `stream` |
| `ReadableWithCloseEvent` | `stream.on('close', event)` | `stream, event(Event with definedBody())` | `stream` |
| `ReadableWithDataEvent` | `stream.on('data', event)` | `stream, event(Event with definedBody(chunk))` | `stream` |
| `ReadableWithEncoding` | `stream.setEncoding` | `stream, encoding` | `stream` |
| `ReadableWithEndEvent` | `stream.on('end', event)` | `stream, event(Event with definedBody())` | `stream` |
| `ReadableWithErrorEvent` | `stream.on('error', event)` | `stream, event(Event with definedBody(error))` | `stream` |
| `ReadableWithReadableEvent` | `stream.on('readable', event)` | `stream, event(Event with definedBody())` | `stream` |
| `ResumedReadable` | `stream.resume` | `stream` | `stream` |
| `UnpipedReadable` | `stream.unpipe` | `stream, destination` | `stream` |
| `UnshiftedReadable` | `stream.unshift` | `stream, chunk` | `stream` |

## writable (here stream is writable)

| Async Object  | Async/sync call | Parameters(default value/description) | Representation result |
| ------------- | ----------------| ---------- | --------------------- |
| `CorkedWritable` | `stream.cork` | `stream` | `stream` |
| `DestroyedWritable` | `stream.destroy` | `stream, error` | `stream` |
| `EndedWritable` | `stream.end` | `stream, chunk, encoding` | `stream` |
| `UncorkedWritable` | `stream.uncork` | `stream` | `stream` |
| `WritableHighWaterMark` | `stream.writableHighWaterMark` | `stream` | `stream` |
| `WritableWithCloseEvent` | `stream.on('close', event)` | `stream, event(Event with definedBody())` | `stream` |
| `WritableWithDefaultEncoding` | `stream.setDefaultEncoding` | `stream, encoding` | `stream` |
| `WritableWithErrorEvent` | `stream.on('error', event)` | `stream, event(Event with definedBody(error))` | `stream` |
| `WritableWithFinishEvent` | `stream.on('finish', event)` | `stream, event(Event with definedBody())` | `stream` |
| `WritableWithOneTimeDrainEvent` | `stream.once('drain', event)` | `stream, event(Event with definedBody())` | `stream` |
| `WritableWithPipeEvent` | `stream.on('pipe', event)` | `stream, event(Event with definedBody(src))` | `stream` |
| `WritableWithUnpipeEvent` | `stream.on('unpipe', event)` | `stream, event(Event with definedBody(src))` | `stream` |
| `WrittenWritable` | `stream.write` | `stream, chunk, encoding` | `stream` |

## duplex (both readable and writeable)
| Async Object  | Async/sync call | Parameters(default value/description) | Representation result |
| ------------- | ----------------| ---------- | --------------------- |
| `DestroyedStream` | `stream.destroy` | `stream, error` | `stream` |
| `PausedStream` | `stream.pause` | `stream` | `stream` |
| `StreamWithCloseEvent` | `stream.on('close', event)` | `stream, event(Event with definedBody())` | `stream` |
| `StreamWithDataEvent` | `stream.on('data', event)` | `stream, event(Event with definedBody(chunk))` | `stream` |
| `StreamWithEncoding` | `stream.setEncoding` | `stream, encoding` | `stream` |
| `StreamWithEndEvent` | `stream.on('end', event)` | `stream, event(Event with definedBody())` | `stream` |
| `StreamWithErrorEvent` | `stream.on('error', event)` | `stream, event(Event with definedBody(error))` | `stream` |
| `StreamWithReadableEvent` | `stream.on('readable', event)` | `stream, event(Event with definedBody())` | `stream` |
| `ReadDataFromStream` | [read](https://github.com/Guseyn/cutie-stream/blob/master/src/custom-calls/read.js) | `stream, size, limit(if true then it reads only the first chunk(with size as specified second argument), it's false by default)` | `string\|Buffer\|null` |
| `ResumedStream` | `stream.resume` | `stream` | `stream` |
| `StreamReadable` | `stream.unpipe` | `stream, destination` | `stream` |
| `StreamReadable` | `stream.unshift` | `stream, chunk` | `stream` |
| `CorkedStream` | `stream.cork` | `stream` | `stream` |
| `UncorkedStream` | `stream.uncork` | `stream` | `stream` |
| `StreamWithDefaultEncoding` | `stream.setDefaultEncoding` | `stream, encoding` | `stream` |
| `StreamWithFinishEvent` | `stream.on('finish', event)` | `stream, event(Event with definedBody())` | `stream` |
| `StreamWithOneTimeDrainEvent` | `stream.once('drain', event)` | `stream, event(Event with definedBody())` | `stream` |
| `StreamWithPipeEvent` | `stream.on('pipe', event)` | `stream, event(Event with definedBody(src))` | `stream` |
| `StreamWithUnpipeEvent` | `stream.on('unpipe', event)` | `stream, event(Event with definedBody(src))` | `stream` |

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