# @fabianbormann/meerkat 中文文档

规范地址：https://npmcn.com/package/%40fabianbormann/meerkat/

版本：1\.0\.18
npm 元数据更新时间：2025-11-15T07:35:16.777Z
中文译文更新时间：2026-11-14T07:46:35.126Z
软件包许可：Apache-2\.0

本文由上游 README 翻译，可能存在偏差，请结合原文核对 API、命令与配置。版权与许可归原作者所有。

原始 npm 页面：https://www.npmjs.com/package/%40fabianbormann/meerkat
原文对照：https://npmcn.com/package/%40fabianbormann/meerkat/?lang=original
项目主页：https://github.com/fabianbormann/meerkat#readme
源码仓库：https://github.com/fabianbormann/meerkat

## 关键信息（来自 npm 元数据）

- 包体积（解压后）：4.2 MB，10 个文件
- 模块格式：ESM + CJS
- TypeScript 类型：包内自带
- 运行依赖：8 个
- 首次发布：2022-12-06T07:43:09.813Z
- 最新版本发布：2025-11-15T07:35:16.538Z
- 近 30 天下载量：7273（2026-10-14 至 2026-11-12，npm 官方下载统计）
- 已发布版本数：18（近 12 个月 1 个）

## 中文简介

在 WebTorrent 上建立的浏览器到浏览器网络

## 安装

```sh
npm install @fabianbormann/meerkat
```

也可以使用：`pnpm add @fabianbormann/meerkat`、`yarn add @fabianbormann/meerkat`、`bun add @fabianbormann/meerkat`

## README

# 米尔卡特

![Tests](https://img.shields.io/github/actions/workflow/status/fabianbormann/meerkat/test.yml?label=Release&style=for-the-badge) ![Release](https://img.shields.io/github/actions/workflow/status/fabianbormann/meerkat/release.yml?label=Release&style=for-the-badge) ![Bundle](https://img.shields.io/github/actions/workflow/status/fabianbormann/meerkat/bundle.yml?label=Release&style=for-the-badge) [![conventionalcommits](https://img.shields.io/badge/Conventional%20Commits-1.0.0-%23FE5196?logo=conventionalcommits&style=for-the-badge)](https://conventionalcommits.org/)

Meerkat 旨在成为 Bugout 的打字和网络包 5 友好的再执行: 在 WebTorrent 上构建的浏览器到浏览器网络

## 开始

### 国家预防机制

```zsh
npm i @fabianbormann/meerkat
```

### 面包店

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

## QQ 使用 Meerkat 作为服务器

```js
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`);
```

## QQ 将 Meerkat 作为客户端

```js
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 是什么？

在 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 和提交记录判断。