# @haikit/core 中文文档

规范地址：https://npmcn.com/package/%40haikit/core/

版本：0\.35\.2
npm 元数据更新时间：2026-11-07T06:43:28.055Z
中文译文更新时间：2026-11-17T14:37:14.801Z
软件包许可：MIT

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

原始 npm 页面：https://www.npmjs.com/package/%40haikit/core
原文对照：https://npmcn.com/package/%40haikit/core/?lang=original
项目主页：https://github.com/wfoxd/haikit/tree/main/packages/core#readme
源码仓库：https://github.com/wfoxd/haikit

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

- 包体积（解压后）：112 kB，8 个文件
- 模块格式：ES Module
- TypeScript 类型：包内自带
- Node.js 要求：\>=22
- 运行依赖：0 个
- 首次发布：2026-09-23T05:33:36.100Z
- 最新版本发布：2026-11-07T06:43:27.721Z
- 近 30 天下载量：4837（2026-10-17 至 2026-11-15，npm 官方下载统计）
- 已发布版本数：48（近 12 个月 48 个）

## 中文简介

Haikit合同层:声明一次UI表面,在服务器和浏览器上执行. 无常态,零运行时间依赖.

## 安装

```sh
npm install @haikit/core
```

也可以使用：`pnpm add @haikit/core`、`yarn add @haikit/core`、`bun add @haikit/core`

## README

# @ haikit/ 核心

合同层. 零运行时间依赖性——由 服务器运行时间,浏览器客户端,每个适配器,以及两个应用程序的一半.

```ts
import { defineSurface, resolve, query } from "@haikit/core";

export const picker = defineSurface({
  name: "flight_table",
  version: 1,
  props: z.object({ flights: z.array(Flight) }),
  actions: { select: resolve(z.string()) },
  queries: { filter: query(FilterArgs) },
});
```

石刻已被接受 **结构** - 任何与一个 `.parse()` 方法有效, 所以zod是你的选择 而不是这个包的依赖.

## 四项保证

在类型体系中强制执行 `test/types/guarantees.ts`数字 :

|  |  |
| --- | --- |
| 表面不存在 `digest`,或者没有通知 `model` 文本 | 两个字段都需要 |
| 查询的结果只能由 `cap()` | `Capped` 没有其他构造器 |
| `mode: "elicit"` 需要一个 `resolve` 动作 | 否则拨打时不打字 |
| 不存在未申报的行动 | 合同 _实值_ 许可列表 |

表面也可以声明 `staleAfterMs`,其数据可在多大程度上采取行动: 毫秒,或 `"never"`,这是默认值。 一次任何表面在一个 谈话已经过窗了 谈话结束.

通知,宣布日期: `defineNotice`,是服务器告诉一个 任何请求之外的对话。 其有效载荷去浏览器 及其 `model` 在下一个用户信息中向模型提供文本; `model` 返回时 `null` 当模型不需要听到它. `hai.notify` 键入 合同。 宣布的通知 `kind: "wake"` 也开始转弯,所以 `model` 必须返回文本 : `null` 是一个编译错误.

一个信号,以 `defineSignal`,是对每个开放浏览器的广播, 比如网上有多少人 它属于没有对话,从来没有 到达模型,所以没有服务器的一半: `hai.signal` 类型有效载荷 单从合同.

`npm run typetest` 在 repo 根上, 将这些测试汇编两次—— 一次与它们的 `@ts-expect-error` 指令(必须是干净的),一旦剥去 线条必须出错。 保证无声停止工作会失败.

## 常见问题

### @haikit/core 是什么？

Haikit合同层:声明一次UI表面,在服务器和浏览器上执行\. 无常态,零运行时间依赖\.

### 如何安装 @haikit/core？

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

### @haikit/core 支持 TypeScript 吗？

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

### @haikit/core 支持 ESM 还是 CommonJS？

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

### @haikit/core 需要什么版本的 Node\.js？

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

### @haikit/core 可以商用吗？

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

### @haikit/core 的下载量有多少？

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

### @haikit/core 还在维护吗？

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

