# stream-wormhole

> Pipe ReadStream to a wormhole

Latest version **2.0.1** (published 2023-09-17) · MIT license · 0 weekly downloads

## Install

```sh
npm install stream-wormhole
pnpm add stream-wormhole
yarn add stream-wormhole
bun add stream-wormhole
```

## 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 | 2.0.1 |
| Published | 2023-09-17 |
| First published | 2016-07-15 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | bundled |
| Module format | ESM |
| Node | >=16.0.0 |
| Dependencies | 0 |
| Unpacked size | 14.4 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| Provenance | attested (Unknown) |
| GitHub stars | 42 |
| Author | fengmk2 |
| Maintainers | dead_horse, fengmk2 |
| Keywords | stream-wormhole, wormhole, stream |

## Links

- npm: https://www.npmjs.com/package/stream-wormhole
- Repository: https://github.com/node-modules/stream-wormhole
- Issues: https://github.com/node-modules/stream-wormhole/issues
- npm.io page: https://npm.io/package/stream-wormhole

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

- 2.0.1 (latest) — 2023-09-17
- 2.0.0 — 2023-09-16
- 1.1.0 — 2018-08-15
- 1.0.4 — 2018-07-17
- 1.0.3 — 2016-07-25
- 1.0.2 — 2016-07-15
- 1.0.1 — 2016-07-15
- 1.0.0 — 2016-07-15

## README

# stream-wormhole

[![NPM version][npm-image]][npm-url]
[![CI](https://github.com/node-modules/stream-wormhole/actions/workflows/nodejs.yml/badge.svg)](https://github.com/node-modules/stream-wormhole/actions/workflows/nodejs.yml)
[![Test coverage][codecov-image]][codecov-url]
[![npm download][download-image]][download-url]

[npm-image]: https://img.shields.io/npm/v/stream-wormhole.svg?style=flat-square
[npm-url]: https://npmjs.org/package/stream-wormhole
[codecov-image]: https://codecov.io/github/node-modules/stream-wormhole/coverage.svg?branch=master
[codecov-url]: https://codecov.io/github/node-modules/stream-wormhole?branch=master
[download-image]: https://img.shields.io/npm/dm/stream-wormhole.svg?style=flat-square
[download-url]: https://npmjs.org/package/stream-wormhole

Pipe `ReadStream` / `Readable` to a wormhole.

## Usage

```ts
import sendToWormhole from 'stream-wormhole';
import fs from 'node:fs';

const readStream = fs.createReadStream(__filename);

// ignore all error by default
sendToWormhole(readStream)
  .then(() => console.log('done'));

// throw error
sendToWormhole(readStream, true)
  .then(() => console.log('done'))
  .catch(err => console.error(err));
```

## License

[MIT](LICENSE)

<!-- GITCONTRIBUTOR_START -->

## Contributors

|[<img src="https://avatars.githubusercontent.com/u/156269?v=4" width="100px;"/><br/><sub><b>fengmk2</b></sub>](https://github.com/fengmk2)<br/>|[<img src="https://avatars.githubusercontent.com/u/1433247?v=4" width="100px;"/><br/><sub><b>denghongcai</b></sub>](https://github.com/denghongcai)<br/>|[<img src="https://avatars.githubusercontent.com/u/985607?v=4" width="100px;"/><br/><sub><b>dead-horse</b></sub>](https://github.com/dead-horse)<br/>|
| :---: | :---: | :---: |


This project follows the git-contributor [spec](https://github.com/xudafeng/git-contributor), auto updated at `Sat Sep 16 2023 14:11:38 GMT+0800`.

<!-- GITCONTRIBUTOR_END -->

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