# @coworkee/client 中文文档

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

版本：0\.0\.1054
npm 元数据更新时间：2026-10-31T20:44:32.390Z
中文译文更新时间：2026-10-31T21:08:05.720Z
软件包许可：MIT

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

原始 npm 页面：https://www.npmjs.com/package/%40coworkee/client
原文对照：https://npmcn.com/package/%40coworkee/client/?lang=original
项目主页：https://fgilde.github.io/CoworkeeLib/web/airworks/
源码仓库：https://github.com/fgilde/CoworkeeLib

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

- 包体积（解压后）：1.1 MB，23 个文件
- 模块格式：ES Module
- TypeScript 类型：包内自带
- 运行依赖：2 个
- 首次发布：2026-10-14T21:12:03.814Z
- 最新版本发布：2026-10-31T20:44:32.057Z
- 已发布版本数：33（近 12 个月 33 个）

## 中文简介

coworkkee应用API的类型化客户端：OpenAPI类型，BFF会话，主题，文本和OData助手

## 安装

```sh
npm install @coworkee/client
```

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

## README

# @coworkee /客户端

类型化TypeScript客户端，用于构建应用的API [Coworkee](https://fgilde.github.io/CoworkeeLib/)：从库端点的OpenAPI描述生成的类型， `createCoworkeeClient()` (openapi-fetch), `apiRequest`， `ApiError` 有了问题细节，实时中心(`createRealtime()`， SignalR)，直播答案(`postNdjson`)，以及BFF会话、主题、文本和OData的助手。

```bash
npm install @coworkee/client
```

```ts
import { createCoworkeeClient, createRealtime, unwrap } from '@coworkee/client';

const api = createCoworkeeClient();               // in a page served by the app's BFF: session cookie + CSRF header
const me = unwrap(await api.GET('/api/v1/identity/me'));
const stop = createRealtime().subscribe(`user:${userId}`, ({ type, payload }) => console.log(type, payload));
```

-   每个coworkkee版本都会在其发布版本(`a.b.c.d` 变成了 `a.b.(c*1000+d)`（NPM不知道第四部分）。
-   `npm run openapi -- <url of /openapi/v1.json> [more documents]` 刷新 `openapi.json`， `npm run generate` 的类型。
-   文档: [sdk](https://fgilde.github.io/CoworkeeLib/web/sdk/)

许可协议:麻省理工学院

## 常见问题

### @coworkee/client 是什么？

coworkkee应用API的类型化客户端：OpenAPI类型，BFF会话，主题，文本和OData助手

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

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

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

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

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

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

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

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

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

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