@geckos.io/client

中文文档
3.1.0发布于 2026/03/27BSD-3-ClauseTypeScriptES Module近 30 天下载 1万

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

原始使用文档
logo

@geckos.io/client

NPM version Downloads Node version Minified bundle Snyk Vulnerabilities for GitHub Repo (Specific Manifest) NPM Codecov ES Modules Badge

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 for more information.

Install

npm install @geckos.io/client

Use

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')
})

版本与发布记录

@geckos.io/client 共发布 59 个版本,首次发布于 2019/04/24;过去 12 个月发布了 1 个版本。

版本发布日期距今
3.1.0latest2026/03/277 个月前
3.0.22025/04/191.6 年前
3.0.12024/11/252 年前
3.0.02023/12/102 年前
2.3.22023/09/123 年前
2.3.2-dev.02023/08/293 年前

其他发布通道:dev → 2.0.0-dev.4。

关于 @geckos.io/client 的常见问题

@geckos.io/client 是什么?

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

如何安装 @geckos.io/client?

在项目目录运行 npm install @geckos.io/client,或使用 pnpm add / yarn add / bun add。

@geckos.io/client 支持 TypeScript 吗?

支持。包内自带 TypeScript 类型声明(package.json 声明了 types 入口),安装后即可获得类型提示,无需再安装 @types 包。

@geckos.io/client 支持 ESM 还是 CommonJS?

以 ES Module 形式发布,推荐使用 import 引入。在 CommonJS 项目中,Node.js 20.19+ / 22.12+ 可以直接 require() 不含顶层 await 的 ES Module,更早的版本需要改用动态 import()。

@geckos.io/client 需要什么版本的 Node.js?

package.json 的 engines 字段要求 Node.js >=18。版本不符时 npm 默认只给出警告,开启 engine-strict 后会拒绝安装。

@geckos.io/client 可以商用吗?

@geckos.io/client 使用 BSD-3-Clause 许可。宽松许可:允许商业使用、修改和再分发,通常只需在分发时保留原版权与许可声明。另外不得用原作者名义为衍生产品背书。以上为概括,不构成法律意见,请以许可原文为准。

@geckos.io/client 的下载量有多少?

根据 npm 官方下载统计,@geckos.io/client 在 2026/10/16 – 2026/11/14 这 30 天内被下载 10,371 次,日均约 346 次。下载量会把 CI 构建、镜像同步和作为其他包依赖的安装一并计入,适合横向比较热度,不能直接等同于使用人数。

@geckos.io/client 还在维护吗?

最新版本 3.1.0 发布于 2026/03/27(7 个月前);至今共发布 59 个版本,其中过去 12 个月发布了 1 个;首次发布于 2019/04/24。发布频率只是参考信号:功能稳定的工具可能很少需要更新,建议结合源码仓库的 issue 和提交记录判断。