# @antelopejs/interface-mongodb 中文文档

规范地址：https://npmcn.com/package/%40antelopejs/interface-mongodb/

版本：0\.0\.6
npm 元数据更新时间：2026-10-17T07:19:53.763Z
中文译文更新时间：2026-11-06T06:32:49.307Z
软件包许可：Apache-2\.0

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

原始 npm 页面：https://www.npmjs.com/package/%40antelopejs/interface-mongodb
原文对照：https://npmcn.com/package/%40antelopejs/interface-mongodb/?lang=original
项目主页：https://interfaces.antelopejs.com/docs/mongodb
源码仓库：https://github.com/AntelopeJS/interface-mongodb

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

- 包体积（解压后）：26.1 kB，8 个文件
- 模块格式：CommonJS
- TypeScript 类型：包内自带
- 运行依赖：1 个
- 首次发布：2026-03-22T15:20:34.525Z
- 最新版本发布：2026-10-17T07:19:53.390Z
- 近 30 天下载量：4488（2026-10-06 至 2026-11-04，npm 官方下载统计）
- 已发布版本数：5（近 12 个月 5 个）

## 中文简介

直接访问共享的MongoDB客户端的羚羊JS接口

## 安装

```sh
npm install @antelopejs/interface-mongodb
```

也可以使用：`pnpm add @antelopejs/interface-mongodb`、`yarn add @antelopejs/interface-mongodb`、`bun add @antelopejs/interface-mongodb`

## README

# @antelopejs/interface-mongodb (英语)

[![npm](https://img.shields.io/npm/v/@antelopejs/interface-mongodb?style=for-the-badge&labelColor=000000&color=000000)](https://www.npmjs.com/package/@antelopejs/interface-mongodb) [![License](https://img.shields.io/npm/l/@antelopejs/interface-mongodb?style=for-the-badge&labelColor=000000&color=000000)](https://npmcn.com/package/%40antelopejs/interface-mongodb/LICENSE) [![Discord](https://img.shields.io/badge/Discord-18181B?logo=discord&style=for-the-badge&color=000000)](https://discord.gg/sjK28QHrA7) [![Docs](https://img.shields.io/badge/Docs-18181B?style=for-the-badge&color=000000)](https://interfaces.antelopejs.com/docs/mongodb)

直接访问藏羚羊JS项目的MongoDB客户端,用于数据库不可知的本地操作 [`@antelopejs/interface-database`](https://github.com/AntelopeJS/interface-database) 不覆盖.

## 它提供的东西

-   `GetClient()` 解决项目共享问题 `MongoClient` 一旦连接开始.
-   客户端是官方的Node.js驱动程序,其完整API:CRUD,汇总,索引和交易.
-   每个模块都会重用执行模块打开并配置的一个连接.

## 执行情况

| 模块 | 页:1 |
| --- | --- |
| [`@antelopejs/mongodb`](https://github.com/AntelopeJS/mongodb) | 还执行 `@antelopejs/interface-database` |

## 安装

向 MongoDB 讲解的模块添加接口 :

```bash
pnpm add @antelopejs/interface-mongodb
```

然后在项目中添加执行内容:

```bash
ajs project modules add @antelopejs/mongodb
```

## 快开始

```ts
import { GetClient } from "@antelopejs/interface-mongodb";

export async function countActiveUsers() {
  const client = await GetClient();
  return await client
    .db("myapp")
    .collection("users")
    .countDocuments({ active: true });
}
```

## 文档

-   [导言和客户参考](https://npmcn.com/package/%40antelopejs/interface-mongodb/docs/1.introduction.md)

## 兼容性

需要藏羚羊JS核心 `1.x` 和下列驱动数据依赖性:

| 软件包 | 范围 |
| --- | --- |
| `mongodb` | `^6.21.0` |

## 捐款

读取 [捐款额](https://npmcn.com/package/%40antelopejs/interface-mongodb/CONTRIBUTING.md) 在你打开拉动请求之前。 当地检查为:

```bash
pnpm install
pnpm lint
pnpm build
```

## 许可证

[阿帕奇 - 2.0](https://npmcn.com/package/%40antelopejs/interface-mongodb/LICENSE)

## 常见问题

### @antelopejs/interface-mongodb 是什么？

直接访问共享的MongoDB客户端的羚羊JS接口

### 如何安装 @antelopejs/interface-mongodb？

在项目目录运行 npm install @antelopejs/interface-mongodb，或使用 pnpm add / yarn add / bun add。

### @antelopejs/interface-mongodb 支持 TypeScript 吗？

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

### @antelopejs/interface-mongodb 支持 ESM 还是 CommonJS？

以 CommonJS 形式发布，可以直接 require\(\)；在 ES Module 项目中也可以用 import 引入（Node\.js 会把 module\.exports 作为默认导出）。

### @antelopejs/interface-mongodb 可以商用吗？

@antelopejs/interface-mongodb 使用 Apache-2\.0 许可。宽松许可：允许商业使用、修改和再分发，并附带明确的专利授权；分发时需保留许可与 NOTICE 文件，修改过的文件要注明改动。以上为概括，不构成法律意见，请以许可原文为准。

### @antelopejs/interface-mongodb 的下载量有多少？

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

### @antelopejs/interface-mongodb 还在维护吗？

最新版本 0\.0\.6 发布于 2026/10/17（20 天前）；至今共发布 5 个版本，其中过去 12 个月发布了 5 个；首次发布于 2026/03/22。发布频率只是参考信号：功能稳定的工具可能很少需要更新，建议结合源码仓库的 issue 和提交记录判断。