# @btravstack/temporal-client 中文文档

规范地址：https://npmcn.com/package/%40btravstack/temporal-client/

版本：0\.58\.0
npm 元数据更新时间：2026-11-07T21:12:30.733Z
中文译文更新时间：2026-11-08T18:06:35.397Z
软件包许可：MIT

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

原始 npm 页面：https://www.npmjs.com/package/%40btravstack/temporal-client
原文对照：https://npmcn.com/package/%40btravstack/temporal-client/?lang=original
源码仓库：https://github.com/btravstack/btravstack

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

- 包体积（解压后）：26 kB，5 个文件
- 模块格式：ES Module
- TypeScript 类型：包内自带
- Node.js 要求：\>=22\.22
- 运行依赖：0 个
- peer 依赖：unthrown ^5\.12\.0，@btravstack/di ^0\.58\.0，@btravstack/config ^0\.58\.0，@temporalio/client ^1\.24\.0，@temporalio/common ^1\.24\.0，@temporal-contract/client ^8\.0\.0-beta\.15，@temporal-contract/contract ^8\.0\.0-beta\.15
- 首次发布：2026-10-08T16:38:23.477Z
- 最新版本发布：2026-11-07T21:12:30.409Z
- 近 30 天下载量：7702（2026-10-09 至 2026-11-07，npm 官方下载统计）
- 已发布版本数：45（近 12 个月 45 个）

## 中文简介

@timporal-contract/客户范围

## 安装

```sh
npm install @btravstack/temporal-client
```

也可以使用：`pnpm add @btravstack/temporal-client`、`yarn add @btravstack/temporal-client`、`bun add @btravstack/temporal-client`

## README

# `@btravstack/temporal-client`

连接本地时间连接和 `@temporal-contract/client` `TypedClient` 用于应用 DI 端口。 添加 `temporalConnection(connectionPort, settingsPort)` 财务报告和审定财务报表 `temporalClient(clientPort, connectionPort, settingsPort)` 到模块的 供养者. 设置供应 `address` 财务报告和审定财务报表 `namespace`。连接关闭 带有模块范围; 无法获取的服务返回模型 `TemporalClientUnreachable` 错误.

通过第四个港口, `temporalClient(clientPort, connectionPort, settingsPort, dataConverterPort)`, (中文(简体) ), 用于编码有效载荷 `DataConverter` 它解决——同一个端口 工人 `dataConverter` 选项名称.

设置也可能带有连接的安全性——TLS,服务器 CA和 名称、 mTLS 证书和密钥, 或 API 密钥—— 和 `temporalSecurity` 绑定 他们来自Temperal自己的变量(`TEMPORAL_TLS`, (中文(简体) ), `TEMPORAL_TLS_SERVER_CA_CERT_PATH`, (中文(简体) ), `TEMPORAL_TLS_SERVER_NAME`, (中文(简体) ), `TEMPORAL_TLS_CLIENT_CERT_PATH`, (中文(简体) ), `TEMPORAL_TLS_CLIENT_KEY_PATH`, (中文(简体) ), `TEMPORAL_API_KEY`, (中文(简体) ), `TEMPORAL_API_KEY_PATH`) (中文(简体) ). 重读已挂载的文件 每个 `TEMPORAL_CREDENTIALS_RELOAD_MS`,所以更新的证书或密钥是 用于不重新启动。 原子预测的秘密世代被统一读取, 当目标改变时, 将重试; 稳定丢失和空文件 继续一起报告。 它无法连接的组合是 `ConfigInvalid`见 [参考文献](https://btravstack.github.io/btravstack/reference/temporal-client#securing-the-connection)。 。 。 .

打电话 `client.for(contract)` 以获取输入的工作流程和调度 API. 这个 [调度部署](https://npmcn.com/package/examples/order-temporal-worker/src/schedules.ts) 在真实模块中显示提供者。 工作流程论据和时间表政策 保留在申请中.

`client.for(contract)` 也经营一个没有工作流程的合同活动 它(临时服务器1.32或以后):

```ts
const result = await client.for(pdfContract).executeActivity("renderInvoice", {
  activityId: `invoice-${invoiceId}`,
  args: { invoiceId },
});
```

`startActivity` 立即返回一个控点,并 `getActivityHandle` 重排为 一个.

申请可通过 `apiKey` 端口 执行 `TemporalApiKeySource.read()`来源拥有象征性的收购, 缓存和过期; 启动人投票 它与证书 重新加载间隔. 源需要 TLS 并排除内置/文件 API 密钥和 mTLS. 见 [参考文献](https://btravstack.github.io/btravstack/reference/temporal-client#renewable-bearer-credentials) 和失败的行为.

## 常见问题

### @btravstack/temporal-client 是什么？

@timporal-contract/客户范围

### 如何安装 @btravstack/temporal-client？

在项目目录运行 npm install @btravstack/temporal-client，或使用 pnpm add / yarn add / bun add。它还需要宿主项目提供 peer 依赖：unthrown（^5\.12\.0）、@btravstack/di（^0\.58\.0）、@btravstack/config（^0\.58\.0）、@temporalio/client（^1\.24\.0）、@temporalio/common（^1\.24\.0）、@temporal-contract/client（^8\.0\.0-beta\.15）、@temporal-contract/contract（^8\.0\.0-beta\.15）。npm 7 及以上与 pnpm 8 及以上默认会自动安装必需的 peer 依赖，Yarn 需要手动安装。

### @btravstack/temporal-client 支持 TypeScript 吗？

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

### @btravstack/temporal-client 支持 ESM 还是 CommonJS？

以 ES Module 形式发布，推荐使用 import 引入。在 CommonJS 项目中，Node\.js 20\.19\+ / 22\.12\+ 可以直接 require\(\) 不含顶层 await 的 ES Module，更早的版本需要改用动态 import\(\)。

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

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

### @btravstack/temporal-client 可以商用吗？

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

### @btravstack/temporal-client 的下载量有多少？

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

### @btravstack/temporal-client 还在维护吗？

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