# @serialport/stream

> The serialport stream interface. This package requires bindings to work.

Latest version **13.0.0** (published 2024-12-24) · MIT license · 0 weekly downloads

## Install

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

## Health

**Score 40/100 (D)** — status: stable.

Positive: has types; no vulnerabilities.

Warnings: low downloads; no esm support.

Negative: stale.

## Facts

| | |
|---|---|
| Version | 13.0.0 |
| Published | 2024-12-24 |
| First published | 2018-08-29 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | bundled |
| Module format | CommonJS |
| Node | >=20.0.0 |
| Dependencies | 2 |
| Unpacked size | 28.8 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 5992 |
| Maintainers | reconbot, hipsterbrown, serialport-release-bot |

## Links

- npm: https://www.npmjs.com/package/@serialport/stream
- Repository: https://github.com/serialport/node-serialport
- Homepage: https://github.com/serialport/node-serialport#readme
- Issues: https://github.com/serialport/node-serialport/issues
- Funding: https://opencollective.com/serialport/donate
- npm.io page: https://npm.io/package/@serialport/stream

## Dependencies (2)

- [debug](https://npm.io/package/debug.md) 4.4.0
- [@serialport/bindings-interface](https://npm.io/package/@serialport/bindings-interface.md) 1.2.2

## Recent versions

- 13.0.0 (latest) — 2024-12-24
- 10.2.2 (beta) — 2022-02-05
- 12.0.0 — 2023-08-29
- 11.0.1 — 2023-07-27
- 11.0.0 — 2023-04-29
- 10.5.0 — 2022-11-17
- 10.3.0 — 2022-02-14
- 10.2.1 — 2022-02-03
- 10.2.0 — 2022-02-03
- 10.1.0 — 2022-01-23
- 10.0.2 — 2022-01-08
- 10.0.1 — 2021-12-25
- 10.0.0 — 2021-12-11
- 9.2.4 — 2021-09-28
- 9.2.3 — 2021-09-24
- … 15 more at https://npm.io/package/@serialport/stream/versions

## README

# @serialport/stream

The serialport stream interface. This package requires bindings to work.

You'd use this if you want to keep your package size down by requiring only the parts of serialport that you want to use. It is used internally in the `serialport` package.

This is how you use it.

```ts
const { SerialPortStream } = require('@serialport/stream')
const { autoDetect } = require('@serialport/bindings-cpp')
const binding = autoDetect()
const port = new SerialPortStream({ binding, path: '/dev/ttyay', baudRate: 9600 })
```

Learn more at our [stream documentation](https://serialport.io/docs/api-stream) page.

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