# @hcengineering/client-resources 中文文档

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

版本：0\.7\.423
npm 元数据更新时间：2026-05-10T01:49:32.437Z
中文译文更新时间：2026-11-17T17:53:05.288Z
软件包许可：EPL-2\.0

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

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

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

- 包体积（解压后）：221 kB，15 个文件
- 模块格式：ESM + CJS
- TypeScript 类型：包内自带
- 运行依赖：6 个
- 首次发布：2025-10-07T05:36:49.135Z
- 最新版本发布：2026-05-10T01:49:32.325Z
- 近 30 天下载量：14821（2026-10-18 至 2026-11-16，npm 官方下载统计）
- 已发布版本数：14（近 12 个月 6 个）

## 中文简介

软件包允许创建客户端与运行中的平台交互.

## 安装

```sh
npm install @hcengineering/client-resources
```

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

## README

# 概览

软件包允许创建客户端与运行中的平台交互.

## 使用量

```ts
  import clientResources from '@hcengineering/client-resources'
  import core, { Client } from '@hcengineering/core'

  // ...

  const token = ... // Token obtained somehow.

  const connection: Client = await (await clientResources()).function.GetClient(token, transactorUrl)

  // Now client is usable

  // Use close, to shutdown connection.
  await connection.close()
```

## 节点联署材料

对于NodeJS环境,需要使用'ws'软件包配置客户端SocketFactory.

```ts
// We need to override default WebSocket factory with 'ws' one.
setMetadata(client.metadata.ClientSocketFactory, (url) => new WebSocket(url))

const connection: Client = await (await clientResources()).function.GetClient(token, transactorUrl)
...
```

## 常见问题

### @hcengineering/client-resources 是什么？

软件包允许创建客户端与运行中的平台交互\.

### 如何安装 @hcengineering/client-resources？

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

### @hcengineering/client-resources 支持 TypeScript 吗？

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

### @hcengineering/client-resources 支持 ESM 还是 CommonJS？

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

### @hcengineering/client-resources 可以商用吗？

@hcengineering/client-resources 使用 EPL-2\.0 许可。声明的许可为 EPL-2\.0，请阅读许可原文确认使用条件。以上为概括，不构成法律意见，请以许可原文为准。

### @hcengineering/client-resources 的下载量有多少？

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

### @hcengineering/client-resources 还在维护吗？

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

