# snappystream

> Framed Snappy streams

Latest version **2.1.1** (published 2023-08-07) · MIT license · 0 weekly downloads

## Install

```sh
npm install snappystream
pnpm add snappystream
yarn add snappystream
bun add snappystream
```

## Health

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

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

Warnings: low downloads.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 2.1.1 |
| Published | 2023-08-07 |
| First published | 2014-05-29 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | bundled |
| Module format | ESM + CommonJS |
| Node | >=14 |
| Dependencies | 2 |
| Unpacked size | 38 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 4 |
| Author | Dudley Carr |
| Maintainers | dudley |
| Keywords | Snappy, Snappy framing format, Snappy stream |

## Links

- npm: https://www.npmjs.com/package/snappystream
- Repository: https://github.com/dudleycarr/snappystream
- Issues: https://github.com/dudleycarr/snappystream/issues
- npm.io page: https://npm.io/package/snappystream

## Dependencies (2)

- [snappy](https://npm.io/package/snappy.md) ^7.2.2
- [@node-rs/crc32](https://npm.io/package/@node-rs/crc32.md) ^1.7.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

- 2.1.1 (latest) — 2023-08-07
- 2.1.0 — 2023-08-07
- 2.0.0 — 2021-07-27
- 1.5.0 — 2021-03-17
- 1.4.0 — 2019-08-28
- 1.3.2 — 2019-08-28
- 1.3.1 — 2018-09-08
- 1.3.0 — 2018-09-07
- 1.2.0 — 2018-07-20
- 1.0.1 — 2018-05-09
- 1.1.0 — 2017-09-05
- 1.0.0 — 2017-09-03
- 0.4.0 — 2017-09-02
- 0.3.4 — 2017-01-02
- 0.3.3 — 2015-11-09
- … 4 more at https://npm.io/package/snappystream/versions

## README

# snappystream

A Node.js library for supporting the
[Snappy](https://code.google.com/p/snappy/) framing format via streams. See
the [Snappy Framing Format
Description](https://github.com/google/snappy/blob/master/framing_format.txt) for
details.

Usage:
SnappyStream and UnsnappyStream are
[Transform streams](http://nodejs.org/api/stream.html#stream_class_stream_transform).

```javascript
const {SnappyStream} = require('snappystream')
const fs = require('fs')

const inStream = fs.createReadStream('snappy.txt')
const snappyStream = new SnappyStream()
const outStream = fs.createWriteStream('snappy_frame.txt')

inStream.pipe(snappyStream).pipe(outStream)
```

UnsnappyStream constructor takes an optional argument `verifyChecksums`
which is false by default.

```javascript
const {UnsnappyStream} = require('snappysteam')
const fs = require('fs')

const inStream = fs.createReadStream('snappy_frame.txt')
const unsnappyStream = new UnsnappyStream(true)

unsnappyStream.on('end', function () {
  console.log(unsnappyStream.read())
})

inStream.pipe(unsnappyStream)
```

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