# @geckos.io/client

> Real-time client/server communication over UDP using WebRTC and Node.js

Latest version **3.1.0** (published 2026-03-27) · BSD-3-Clause license · 0 weekly downloads

## Install

```sh
npm install @geckos.io/client
pnpm add @geckos.io/client
yarn add @geckos.io/client
bun add @geckos.io/client
```

## Health

**Score 55/100 (C)** — status: stable.

Positive: has types; esm support; no vulnerabilities.

Warnings: low downloads.

## Facts

| | |
|---|---|
| Version | 3.1.0 |
| Published | 2026-03-27 |
| First published | 2019-04-24 |
| Weekly downloads | 0 |
| License | BSD-3-Clause |
| TypeScript types | bundled |
| Module format | ESM + CommonJS |
| Node | >=18 |
| Dependencies | 1 |
| Unpacked size | 35.9 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 1488 |
| Author | Yannick Deubel |
| Maintainers | yandeu |
| Keywords | real-time, realtime, framework, webrtc, wrtc, websocket, websockets, node, nodejs, udp, sctp, multiplayer, game, client |

## Links

- npm: https://www.npmjs.com/package/@geckos.io/client
- Repository: https://github.com/geckosio/geckos.io
- Homepage: http://geckos.io
- Issues: https://github.com/geckosio/geckos.io/issues
- Funding: https://github.com/sponsors/yandeu
- npm.io page: https://npm.io/package/@geckos.io/client

## Dependencies (1)

- [@geckos.io/common](https://npm.io/package/@geckos.io/common.md) ^3.1.0

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

- 3.1.0 (latest) — 2026-03-27
- 2.0.0-dev.4 (dev) — 2021-05-20
- 3.0.2 — 2025-04-19
- 3.0.1 — 2024-11-24
- 3.0.0 — 2023-12-10
- 2.3.2 — 2023-09-12
- 2.3.2-dev.0 — 2023-08-28
- 2.3.1 — 2023-04-27
- 2.3.0 — 2023-01-05
- 2.2.4 — 2022-12-21
- 2.2.3 — 2022-08-22
- 2.2.2 — 2022-08-12
- 2.2.1 — 2022-06-12
- 2.2.0 — 2022-04-21
- 2.1.8 — 2022-01-19
- … 44 more at https://npm.io/package/@geckos.io/client/versions

## README

<a href="http://geckos.io">
<img src="https://github.com/geckosio/geckos.io/raw/master/readme/logo-256.png" alt="logo" width="128">
</a>

# @geckos.io/client

[![NPM version](https://img.shields.io/npm/v/@geckos.io/client.svg?style=flat-square)](https://www.npmjs.com/package/@geckos.io/client)
[![Downloads](https://img.shields.io/npm/dm/@geckos.io/client.svg?style=flat-square)](https://www.npmjs.com/package/@geckos.io/client)
![Node version](https://img.shields.io/node/v/@geckos.io/client.svg?style=flat-square)
[![Minified bundle](https://img.shields.io/github/size/geckosio/geckos.io/bundles/latest/geckos.io-client.latest.min.js.svg?label=minified%20bundle&style=flat-square)](https://github.com/geckosio/geckos.io/tree/master/bundles)
![Snyk Vulnerabilities for GitHub Repo (Specific Manifest)](https://img.shields.io/snyk/vulnerabilities/github/geckosio/geckos.io/packages/client/package.json.svg?style=flat-square)
![NPM](https://img.shields.io/npm/l/@geckos.io/client.svg?style=flat-square)
[![Codecov](https://img.shields.io/codecov/c/github/geckosio/geckos.io?logo=codecov&style=flat-square)](https://codecov.io/gh/geckosio/geckos.io)
[![ES Modules Badge](https://img.shields.io/badge/Node.js-ES%20Modules-F7DF1E?style=flat-square)](https://github.com/yandeu/yandeu/blob/main/posts/2020-05-28-esm-for-nodejs.md)

Real-time client/server communication over UDP using **WebRTC** and **Node.js**.

This framework fits perfectly with your next **HTML5 real-time multiplayer games** or chat app.

Read the [documentation](https://github.com/geckosio/geckos.io) for more information.

## Install

```console
npm install @geckos.io/client
```

## Use

```js
import geckos from '@geckos.io/client'

// or add a minified version to your index.html file
// https://github.com/geckosio/geckos.io/tree/master/bundles/versions

const channel = geckos()

channel.onConnect(error => {
  if (error) {
    console.error(error.message)
    return
  }

  channel.on('chat message', data => {
    console.log(`You got the message ${data}`)
  })

  channel.emit('chat message', 'a short message sent to the server')
})
```

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