# @botpress/client 中文文档

规范地址：https://npmcn.com/package/%40botpress/client/

版本：2\.12\.0
npm 元数据更新时间：2026-11-06T16:03:42.274Z
中文译文更新时间：2026-11-08T12:23:35.763Z
软件包许可：MIT

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

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

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

- 包体积（解压后）：9.5 MB，9 个文件
- 模块格式：ESM + CJS
- TypeScript 类型：包内自带
- Node.js 要求：\>=18\.0\.0
- 运行依赖：2 个
- 首次发布：2023-03-30T22:01:55.165Z
- 最新版本发布：2026-11-06T16:03:41.818Z
- 近 30 天下载量：52457（2026-10-09 至 2026-11-07，npm 官方下载统计）
- 已发布版本数：204（近 12 个月 39 个）

## 中文简介

瓶装客户端

## 安装

```sh
npm install @botpress/client
```

也可以使用：`pnpm add @botpress/client`、`yarn add @botpress/client`、`bun add @botpress/client`

## README

# 瓶装客户端

TypeScript的官方Botpress HTTP客户端. 查询 [气压 API](https://botpress.com/docs/api/)。 。 。 .

## 安装

```bash
npm install --save @botpress/client # for npm
yarn add @botpress/client # for yarn
pnpm add @botpress/client # for pnpm
```

## 使用量

```ts
import { Client, ClientInputs, ClientOutputs } from '@botpress/client'

// 0. Type definitions for each operation's IO
type GetBotInput = ClientInputs['getBot']
type GetBotOutput = ClientOutputs['getBot']

const main = async () => {
  const token = 'your-token'
  const workspaceId = 'your-workspace-id'
  const botId = 'your-bot-id'
  const client = new Client({ token, workspaceId, botId })

  // 1. plain operations
  const { bot } = await client.getBot({ id: botId })
  console.log('### bot', bot)

  // 2. list utils with `.collect()` function
  const [latestConversation] = await client.list
    .conversations({ sortField: 'createdAt', sortDirection: 'desc', integrationName: 'telegram' })
    .collect({ limit: 1 })
  console.log('### latestConversation', latestConversation)

  // 3. list utils with async generator and `for await` syntax
  for await (const message of client.list.messages({ conversationId: latestConversation.id })) {
    console.log(`### [${message.userId}]`, message.payload)
  }
}

void main()
```

## 常见问题

### @botpress/client 是什么？

瓶装客户端

### 如何安装 @botpress/client？

在项目目录运行 npm install @botpress/client，或使用 pnpm add / yarn add / bun add。

### @botpress/client 支持 TypeScript 吗？

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

### @botpress/client 支持 ESM 还是 CommonJS？

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

### @botpress/client 需要什么版本的 Node\.js？

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

### @botpress/client 可以商用吗？

@botpress/client 使用 MIT 许可。宽松许可：允许商业使用、修改和再分发，通常只需在分发时保留原版权与许可声明。以上为概括，不构成法律意见，请以许可原文为准。

### @botpress/client 的下载量有多少？

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

### @botpress/client 还在维护吗？

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