@botpress/client

中文文档
2.12.0发布于 2026/11/07MITTypeScriptESM + CJS构建来源已验证近 30 天下载 5.2万

瓶装客户端

中文使用文档

瓶装客户端

TypeScript的官方Botpress HTTP客户端. 查询 气压 API。 。 。 .

安装

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

使用量

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 共发布 204 个版本,首次发布于 2023/03/31;过去 12 个月发布了 39 个版本。最新版本附带 npm provenance 构建来源证明,可追溯到公开的 CI 构建记录。

版本发布日期距今
2.12.0latest2026/11/071 天前
2.11.02026/11/035 天前
2.10.02026/10/308 天前
2.9.02026/10/2216 天前
2.8.02026/10/081 个月前
2.7.02026/10/031 个月前

关于 @botpress/client 的常见问题

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