# @coding-flow/flow-core 中文文档

规范地址：https://npmcn.com/package/%40coding-flow/flow-core/

版本：0\.2\.17
npm 元数据更新时间：2026-11-07T09:53:59.934Z
中文译文更新时间：2026-11-10T08:49:33.604Z
软件包许可：Apache-2\.0

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

原始 npm 页面：https://www.npmjs.com/package/%40coding-flow/flow-core
原文对照：https://npmcn.com/package/%40coding-flow/flow-core/?lang=original
项目主页：https://github.com/codingapi/flow-frontend
源码仓库：https://github.com/codingapi/flow-frontend

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

- 包体积（解压后）：51 kB，29 个文件
- 模块格式：ES Module
- TypeScript 类型：包内自带
- 运行依赖：3 个
- peer 依赖：react \>=18，react-dom \>=18
- 首次发布：2026-03-17T06:36:33.447Z
- 最新版本发布：2026-11-07T09:53:59.748Z
- 近 30 天下载量：2794（2026-10-10 至 2026-11-08，npm 官方下载统计）
- 已发布版本数：82（近 12 个月 82 个）

## 中文简介

流动引擎核心解放框架

## 安装

```sh
npm install @coding-flow/flow-core
```

也可以使用：`pnpm add @coding-flow/flow-core`、`yarn add @coding-flow/flow-core`、`bun add @coding-flow/flow-core`

## README

# @coding-flow/flow-core

Flow Engine 前端核心框架库，提供 HTTP 客户端、Hooks、Presenter 等基础能力（不包含 UI 组件）。

## 简介

`flow-core` 是 Flow Engine 的核心框架库，提供与 UI 无关的基础能力：

-   HTTP 客户端封装（基于 axios）
-   React Hooks 工具
-   Presenter 模式实现
-   通用工具函数
-   全局状态管理

### 依赖关系

-   **依赖**: 无

## Setup

安装依赖:

```bash
pnpm install
```

## 开发

构建库:

```bash
pnpm run build
```

监听模式构建:

```bash
pnpm run dev
```

## 核心功能

### HTTP 客户端

基于 axios 封装的 HTTP 客户端，提供:

-   请求拦截器/响应拦截器
-   统一的错误处理
-   类型安全的请求/响应
-   请求取消支持

```typescript
import { httpClient } from '@coding-flow/flow-core';

// GET 请求
const workflow = await httpClient.get<Workflow>('/api/workflows/1');

// POST 请求
const result = await httpClient.post<Workflow>('/api/workflows', workflowData);
```

### React Hooks

提供常用的业务 Hooks:

-   `useWorkflow` - 工作流相关操作
-   `useFlowRecord` - 流程记录相关操作
-   `useApproval` - 审批相关操作
-   自定义 Hooks 工具

### Presenter 模式

实现业务逻辑与 UI 分离的 Presenter 模式:

```typescript
import { Presenter } from '@coding-flow/flow-core';

class WorkflowPresenter extends Presenter {
  async loadWorkflow(id: string): Promise<Workflow> {
    // 加载工作流
  }

  async saveWorkflow(workflow: Workflow): Promise<void> {
    // 保存工作流
  }
}
```

### 工具函数

提供通用工具函数:

-   日期格式化
-   字符串处理
-   对象深拷贝
-   类型判断

## 模块结构

```
flow-core/
├── src/
│   ├── http/           # HTTP 客户端
│   ├── hooks/          # React Hooks
│   ├── presenter/      # Presenter 基类
│   ├── utils/          # 工具函数
│   └── types/          # 基础类型定义
└── README.md
```

## 使用示例

```typescript
import { httpClient, useWorkflow, WorkflowPresenter } from '@coding-flow/flow-core';

// 使用 HTTP 客户端
const workflows = await httpClient.get<Workflow[]>('/api/workflows');

// 使用 Hooks
const { data, loading, error } = useWorkflow('wf-001');

// 使用 Presenter
const presenter = new WorkflowPresenter();
await presenter.loadWorkflow('wf-001');
```

## Learn more

-   [Rslib documentation](https://lib.rsbuild.io/) - Rslib 特性和 API
-   [Flow Engine Docs](https://github.com/codingapi/flow-engine) - 完整文档
-   [CLAUDE.md](https://npmcn.com/package/CLAUDE.md) - 开发指南

## 常见问题

### @coding-flow/flow-core 是什么？

流动引擎核心解放框架

### 如何安装 @coding-flow/flow-core？

在项目目录运行 npm install @coding-flow/flow-core，或使用 pnpm add / yarn add / bun add。它还需要宿主项目提供 peer 依赖：react（\>=18）、react-dom（\>=18）。npm 7 及以上与 pnpm 8 及以上默认会自动安装必需的 peer 依赖，Yarn 需要手动安装。

### @coding-flow/flow-core 支持 TypeScript 吗？

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

### @coding-flow/flow-core 支持 ESM 还是 CommonJS？

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

### @coding-flow/flow-core 可以商用吗？

@coding-flow/flow-core 使用 Apache-2\.0 许可。宽松许可：允许商业使用、修改和再分发，并附带明确的专利授权；分发时需保留许可与 NOTICE 文件，修改过的文件要注明改动。以上为概括，不构成法律意见，请以许可原文为准。

### @coding-flow/flow-core 的下载量有多少？

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

### @coding-flow/flow-core 还在维护吗？

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