@fabianbormann/meerkat

中文文档
1.0.18发布于 2025/11/15Apache-2.0TypeScriptESM + CJS近 30 天下载 7273

Browser-to-browser networking built on WebTorrent

原始使用文档
文档目录5 节
  1. 🚀 Getting Started
  2. NPM
  3. Broswer
  4. 🤖 Use Meerkat as a Server
  5. 🥸 Use Meerkat as a Client

Meerkat

Tests Release Bundle conventionalcommits

Meerkat aims to be a typescript and webpack 5 friendly re-implementation of Bugout: A browser-to-browser networking built on WebTorrent

🚀 Getting Started

NPM

npm i @fabianbormann/meerkat

Broswer

<script src="https://fabianbormann.github.io/meerkat/latest/meerkat.min.js"></script>
<script>
  const meerkat = new Meerkat({  ... });
</script>

🤖 Use Meerkat as a Server

import Meerkat from '@fabianbormann/meerkat';

const meerkat = new Meerkat({ seed: localStorage['bugout-demo-server-seed'] });
localStorage['meerkat-server-seed'] = meerkat.seed;

let connected = false;
meerkat.on('connections', (clients) => {
  if (clients === 0 && connected === false) {
    connected = true;
    console.log('[info]: server ready');
  }
  console.log(`[info]: ${clients} clients connected`);
});

meerkat.register('hello', (address, args, callback) => {
  console.log(
    `[info]: rpc call invoked by address ${address} into window.cardano`
  );
  callback('hello world');
});

console.log(`Share this address ${meerkat.address} with your clients`);

🥸 Use Meerkat as a Client

import Meerkat from '@fabianbormann/meerkat';

const meerkat = new Meerkat({ identifier: 'YOUR_SERVER_ADDRESS' });

meerkat.on('server', () => {
  console.log('[info]: connected to server');
  meerkat.rpc('YOUR_SERVER_ADDRESS', 'hello', {}, (response) =>
    console.log(response)
  );
});

版本与发布记录

@fabianbormann/meerkat 共发布 18 个版本,首次发布于 2022/12/06;过去 12 个月发布了 1 个版本。

版本发布日期距今
1.0.18latest2025/11/1511 个月前
1.0.172024/11/272 年前
1.0.162024/03/132 年前
1.0.152023/08/083 年前
1.0.142023/08/073 年前
1.0.132023/08/063 年前

关于 @fabianbormann/meerkat 的常见问题

@fabianbormann/meerkat 是什么?

Browser-to-browser networking built on WebTorrent

如何安装 @fabianbormann/meerkat?

在项目目录运行 npm install @fabianbormann/meerkat,或使用 pnpm add / yarn add / bun add。

@fabianbormann/meerkat 支持 TypeScript 吗?

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

@fabianbormann/meerkat 支持 ESM 还是 CommonJS?

同时提供 ES Module 与 CommonJS 入口,import 和 require() 都可以使用,打包工具会自动选择合适的版本。

@fabianbormann/meerkat 可以商用吗?

@fabianbormann/meerkat 使用 Apache-2.0 许可。宽松许可:允许商业使用、修改和再分发,并附带明确的专利授权;分发时需保留许可与 NOTICE 文件,修改过的文件要注明改动。以上为概括,不构成法律意见,请以许可原文为准。

@fabianbormann/meerkat 的下载量有多少?

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

@fabianbormann/meerkat 还在维护吗?

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