# botframework-streaming

> Streaming library for the Microsoft Bot Framework

Latest version **4.23.3** (published 2025-08-27) · MIT license · 0 weekly downloads

## Install

```sh
npm install botframework-streaming
pnpm add botframework-streaming
yarn add botframework-streaming
bun add botframework-streaming
```

## Health

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

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

Warnings: low downloads; no esm support; large bundle.

Negative: stale.

## Facts

| | |
|---|---|
| Version | 4.23.3 |
| Published | 2025-08-27 |
| First published | 2019-12-13 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | bundled |
| Module format | CommonJS |
| Dependencies | 3 |
| Unpacked size | 17.2 MB |
| Known vulnerabilities | 0 (+1 in 1 direct dependencies) |
| Install scripts | no |
| GitHub stars | 724 |
| Author | Microsoft Corp. |
| Maintainers | botframework, sgellock, cwhitten |
| Keywords | botbuilder, botframework, bots, chatbots, websockets, streaming |

## Links

- npm: https://www.npmjs.com/package/botframework-streaming
- Repository: https://github.com/microsoft/botbuilder-js
- Homepage: https://github.com/microsoft/botbuilder-js#readme
- Issues: https://github.com/microsoft/botbuilder-js/issues
- npm.io page: https://npm.io/package/botframework-streaming

## Dependencies (3)

- [ws](https://npm.io/package/ws.md) ^7.5.10
- [uuid](https://npm.io/package/uuid.md) ^10.0.0
- [@types/ws](https://npm.io/package/@types/ws.md) ^6.0.3

## Alternatives

- [@opentelemetry/exporter-zipkin](https://npm.io/package/@opentelemetry/exporter-zipkin.md) — 14.8M weekly downloads
- [pusher-js](https://npm.io/package/pusher-js.md) — 2.0M weekly downloads
- [browserify](https://npm.io/package/browserify.md) — 1.7M weekly downloads
- [sqs-consumer](https://npm.io/package/sqs-consumer.md) — 1.7M weekly downloads
- [@sanity/eventsource](https://npm.io/package/@sanity/eventsource.md) — 930.8K weekly downloads

## Recent versions

- 4.23.3 (latest) — 2025-08-27
- 4.23.0-dev.20240405 (next) — 2024-04-05
- 4.12.1 (patch) — 2021-06-16
- 4.23.3-dev — 2025-08-19
- 4.17.0-blobs1 — 2025-06-10
- 4.24.0-dev2 — 2025-04-09
- 4.24.0-dev1 — 2025-04-07
- 4.23.3-dev2 — 2025-02-12
- 4.23.3-dev1 — 2025-02-11
- 4.23.2 — 2025-02-06
- 4.23.2-rc2 — 2025-02-03
- 4.23.2-dev1 — 2024-12-10
- 4.24.0-rc1 — 2024-10-16
- 4.23.1 — 2024-09-23
- 4.23.0 — 2024-08-28
- … 505 more at https://npm.io/package/botframework-streaming/versions

## README

This library contains the core of Bot Framework Streaming Extensions, which extends the 3.0 Bot Framework protocol to communicate over multiplexed, persistent, connections such as named pipes or WebSocket.

- [Installing](#installing)
- [Documentation](https://docs.microsoft.com/en-us/azure/bot-service/bot-service-overview-introduction?view=azure-bot-service-4.0)
- [GitHub Repo](https://github.com/Microsoft/botbuilder-js)
- [Report Issues](https://github.com/Microsoft/botbuilder-js/issues)

## Installing
To add the latest published version of this package to your bot:

```bash
npm install --save botframework-streaming
```

#### Use the Daily Build

To get access to the daily builds of this library, configure npm to use the MyGet feed before installing.

```bash
npm config set registry https://botbuilder.myget.org/F/botbuilder-v4-js-daily/npm/
```

To reset the registry in order to get the latest published version, run:
```bash
npm config set registry https://registry.npmjs.org/

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