# @libp2p/websockets

> JavaScript implementation of the WebSockets module that libp2p uses and that implements the interface-transport spec

Latest version **10.1.21** (published 2026-08-31) · Apache-2.0 OR MIT license · 0 weekly downloads

## Install

```sh
npm install @libp2p/websockets
pnpm add @libp2p/websockets
yarn add @libp2p/websockets
bun add @libp2p/websockets
```

## Health

**Score 75/100 (B)** — status: active.

Positive: has types; esm support; no vulnerabilities; has provenance; recently updated; high maintenance score; high quality score.

Warnings: low downloads.

## Facts

| | |
|---|---|
| Version | 10.1.21 |
| Published | 2026-08-31 |
| First published | 2022-02-15 |
| Weekly downloads | 0 |
| License | Apache-2.0 OR MIT |
| TypeScript types | bundled |
| Module format | ESM |
| Dependencies | 11 |
| Unpacked size | 507.4 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| Provenance | attested (GitHub Actions) |
| GitHub stars | 2579 |
| Maintainers | daviddias, alanshaw, achingbrain, vascosantos, npm-service-account-libp2p, jacobheun |
| Keywords | IPFS |

## Links

- npm: https://www.npmjs.com/package/@libp2p/websockets
- Repository: https://github.com/libp2p/js-libp2p
- Homepage: https://github.com/libp2p/js-libp2p/tree/main/packages/transport-websockets#readme
- Issues: https://github.com/libp2p/js-libp2p/issues
- npm.io page: https://npm.io/package/@libp2p/websockets

## Dependencies (11)

- [ws](https://npm.io/package/ws.md) ^8.18.3
- [p-event](https://npm.io/package/p-event.md) ^7.0.0
- [main-event](https://npm.io/package/main-event.md) ^1.0.1
- [uint8arrays](https://npm.io/package/uint8arrays.md) ^6.1.1
- [@libp2p/utils](https://npm.io/package/@libp2p/utils.md) ^7.4.1
- [uint8arraylist](https://npm.io/package/uint8arraylist.md) ^3.0.2
- [progress-events](https://npm.io/package/progress-events.md) ^1.0.1
- [@libp2p/interface](https://npm.io/package/@libp2p/interface.md) ^3.3.0
- [@multiformats/multiaddr](https://npm.io/package/@multiformats/multiaddr.md) ^13.0.3
- [@multiformats/multiaddr-to-uri](https://npm.io/package/@multiformats/multiaddr-to-uri.md) ^12.0.0
- [@multiformats/multiaddr-matcher](https://npm.io/package/@multiformats/multiaddr-matcher.md) ^3.0.2

## Recent versions

- 10.1.21 (latest) — 2026-08-31
- 10.1.21-5cb617ae2 (next) — 2026-09-02
- 10.1.21-185d901cd — 2026-09-02
- 10.1.20-cef4d32cf — 2026-08-31
- 10.1.20-ac7305ccf — 2026-08-31
- 10.1.20-87dca02b0 — 2026-08-27
- 10.1.20-4a6c5d11a — 2026-08-27
- 10.1.20 — 2026-08-23
- 10.1.19-947d304ed — 2026-08-22
- 10.1.19-0967e75f5 — 2026-08-22
- 10.1.19-4dae661b4 — 2026-08-22
- 10.1.19-8786aa8d0 — 2026-08-20
- 10.1.19-55d7a539a — 2026-08-20
- 10.1.19-d5534174d — 2026-08-13
- 10.1.19-47cf9cdc1 — 2026-08-10
- … 927 more at https://npm.io/package/@libp2p/websockets/versions

## README

# @libp2p/websockets

[![libp2p.io](https://img.shields.io/badge/project-libp2p-yellow.svg?style=flat-square)](http://libp2p.io/)
[![Discuss](https://img.shields.io/discourse/https/discuss.libp2p.io/posts.svg?style=flat-square)](https://discuss.libp2p.io)
[![codecov](https://img.shields.io/codecov/c/github/libp2p/js-libp2p.svg?style=flat-square)](https://codecov.io/gh/libp2p/js-libp2p)
[![CI](https://img.shields.io/github/actions/workflow/status/libp2p/js-libp2p/main.yml?branch=main\&style=flat-square)](https://github.com/libp2p/js-libp2p/actions/workflows/main.yml?query=branch%3Amain)

> JavaScript implementation of the WebSockets module that libp2p uses and that implements the interface-transport spec

# About

<!--

!IMPORTANT!

Everything in this README between "# About" and "# Install" is automatically
generated and will be overwritten the next time the doc generator is run.

To make changes to this section, please update the @packageDocumentation section
of src/index.js or src/index.ts

To experiment with formatting, please run "npm run docs" from the root of this
repo and examine the changes made.

-->

A [libp2p transport](https://libp2p.io/docs/transports-overview/) based on [WebSockets](https://developer.mozilla.org/en-US/docs/Web/API/WebSockets_API).

## Example

```TypeScript
import { createLibp2p } from 'libp2p'
import { webSockets } from '@libp2p/websockets'
import { multiaddr } from '@multiformats/multiaddr'

const node = await createLibp2p({
  transports: [
    webSockets()
  ]
//... other config
})
await node.start()

const ma = multiaddr('/dns4/example.com/tcp/9090/tls/ws')
await node.dial(ma)
```

# Install

```console
$ npm i @libp2p/websockets
```

## Browser `<script>` tag

Loading this module through a script tag will make its exports available as `Libp2pWebsockets` in the global namespace.

```html
<script src="https://unpkg.com/@libp2p/websockets/dist/index.min.js"></script>
```

# API Docs

- <https://libp2p.github.io/js-libp2p/modules/_libp2p_websockets.html>

# License

Licensed under either of

- Apache 2.0, ([LICENSE-APACHE](https://github.com/libp2p/js-libp2p/blob/main/packages/transport-websockets/LICENSE-APACHE) / <http://www.apache.org/licenses/LICENSE-2.0>)
- MIT ([LICENSE-MIT](https://github.com/libp2p/js-libp2p/blob/main/packages/transport-websockets/LICENSE-MIT) / <http://opensource.org/licenses/MIT>)

# Contribution

Unless you explicitly state otherwise, any contribution intentionally submitted for inclusion in the work by you, as defined in the Apache-2.0 license, shall be dual licensed as above, without any additional terms or conditions.

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