# @godspeedai/cognate-kernel-api 中文文档

规范地址：https://npmcn.com/package/%40godspeedai/cognate-kernel-api/

版本：0\.10\.0
npm 元数据更新时间：2026-11-16T03:42:48.500Z
中文译文更新时间：2026-11-16T18:01:37.648Z
软件包许可：Apache-2\.0

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

原始 npm 页面：https://www.npmjs.com/package/%40godspeedai/cognate-kernel-api
原文对照：https://npmcn.com/package/%40godspeedai/cognate-kernel-api/?lang=original
项目主页：https://github.com/GodSpeedAI/Cognate#readme
源码仓库：https://github.com/GodSpeedAI/Cognate

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

- 包体积（解压后）：67.5 kB，13 个文件
- 模块格式：ES Module
- TypeScript 类型：未声明
- 运行依赖：0 个
- 首次发布：2026-10-09T02:28:50.282Z
- 最新版本发布：2026-11-16T03:42:48.139Z
- 近 30 天下载量：7115（2026-10-17 至 2026-11-15，npm 官方下载统计）
- 已发布版本数：20（近 12 个月 20 个）

## 中文简介

框架自有内核合同:背景,范围,能力,组件,纤维,效果. 没有引擎类型.

## 安装

```sh
npm install @godspeedai/cognate-kernel-api
```

也可以使用：`pnpm add @godspeedai/cognate-kernel-api`、`yarn add @godspeedai/cognate-kernel-api`、`bun add @godspeedai/cognate-kernel-api`

## README

# @ godspideai/ cognate- 内核- api

Cognate的框架自有内核合同:组件,范围,能力,纤维,效果,和政策——作为TypeScript类型外加几个决定性的帮助者. 这里没有引擎密码船.

**何时使用此软件包 :** 您正在创建必须针对内核输入的能力组件或写入代码,或者您正在实施内核引擎。 申请通常通过 [`@godspeedai/cognate-runtime-bun`](https://www.npmjs.com/package/@godspeedai/cognate-runtime-bun) 或 [`@godspeedai/cognate`](https://www.npmjs.com/package/@godspeedai/cognate) 伞.

## 安装

```sh
bun add @godspeedai/cognate-kernel-api
```

要求数 [阿宝](https://bun.sh/) >= 1.4.0.

## 盒子里的东西

-   **类型** —— 说 `Kernel`, (中文(简体) ), `Scope`, (中文(简体) ), `Component`, (中文(简体) ), `FiberContext`, (中文(简体) ), `CapabilityLease`, (中文(简体) ), `Effects`, (中文(简体) ), `Policy`, (中文(简体) ), `InvocationResult`,其他内核词汇.
-   **`isCompatible(requirement, contract)`** ——决定能力资格:相同能力id,相同主要版本需要小/patch QQ,每个需要的属性相等. 不需要发动机.
-   **政策** —— 说 `denyAll` (没有授权,除非你这么说), `rulePolicy(policyId, rules)` (第一匹配规则决定,不否认匹配),和 `allowCapabilities(policyId, ids)` 明确允许列表.
-   **`isUnavailable(value)`** ——类型后卫区分失败解析与租赁.
-   **输入错误** —— 说 `CleanupError`, (中文(简体) ), `PermanentActivationError`, (中文(简体) ), `ActivationTimeoutError`, (中文(简体) ), `UndeclaredCapabilityError`, (中文(简体) ), `ScopeClosedError`。 。 。 .

## 快开始

宣布一个提供能力的组成部分,并选择政策加以援引:

```ts
import { allowCapabilities, isCompatible } from "@godspeedai/cognate-kernel-api";
import type { Component } from "@godspeedai/cognate-kernel-api";

const greeter: Component = {
  id: "greeter",
  provides: [{ id: "greet", version: "1.0.0" }],
  activate(fiber) {
    // Reversible effects, torn down in reverse order on disposal.
    fiber.effects.register(() => console.log("greeter cleaned up"));
    // Publish the capability; visible only after activation succeeds.
    fiber.provide({ id: "greet", version: "1.0.0" }, async (name: string) => ({
      hello: name,
    }));
  },
};

// Deterministic eligibility — computed locally, no engine involved:
isCompatible({ capability: "greet", version: "1.0.0" }, greeter.provides![0]!); // true

// Every invocation passes through a policy; anything not allowed is denied.
const policy = allowCapabilities("allow-greetings", ["greet"]);
```

上载组件、解决租赁问题和援引能力需要引擎:使用 [`@godspeedai/cognate-kernel-cordis`](https://www.npmjs.com/package/@godspeedai/cognate-kernel-cordis) 或运行时间, 嵌入一个.

## 语义上说合同定下来

-   决议从不考虑政策;每次援引都是如此,默认就是否认。 每项决定均作为 `invocation` 审计活动通过 `kernel.observe`。 。 。 .
-   召见从不扔出: 它返回一个 `InvocationResult` 输入失败的.. `unavailable`, (中文(简体) ), `denied`, (中文(简体) ), `deadline_exceeded`, (中文(简体) ), `cancelled`,或 `failed`。 。 。 .
-   活化是全-或-无:失败活化会按倒序处理尝试的效果并发布什么.
-   处置为一等能,按倒序运行每个处置者,并拒绝一次 `CleanupError` 如果任何处置者失败.
-   提供的能力在范围上是显而易见的,只有后代才有;儿童的范围可能会缩小其本能,但绝不会通过继承而获得权威.

## 供引擎执行者使用的合规包

如果您执行 `KernelFactory`,在自己的测试套房中执行可执行合同时不变:

```ts
import { contractSuite } from "@godspeedai/cognate-kernel-api/conformance";
import { createCordisKernel } from "@godspeedai/cognate-kernel-cordis";

contractSuite("my-kernel", createCordisKernel);
```

副路径输出出六套套套房(`contractSuite`, (中文(简体) ), `lifecycleSuite`, (中文(简体) ), `effectsSuite`, (中文(简体) ), `dependenciesSuite`, (中文(简体) ), `scopesSuite`, (中文(简体) ), `authoritySuite`加上一个 `fixtures` 与现成主机、供应商和消费者进行内核测试的命名空间.

## 限制

-   这个软件包在运行时除了它输出的小助手之外,不会执行任何东西:它不会挂载组件,匹配提供者,或者授权调用. 与引擎执行对等.
-   类型仅是编译时间;在TypeScript检查之前,任何部件都无法对照合同验证.

## 相关软件包

-   [`@godspeedai/cognate-kernel-cordis`](https://www.npmjs.com/package/@godspeedai/cognate-kernel-cordis) ——本合同的内核引擎实施.
-   [`@godspeedai/cognate-runtime-bun`](https://www.npmjs.com/package/@godspeedai/cognate-runtime-bun) ——嵌入内核的参考运行时间.
-   [`@godspeedai/cognate`](https://www.npmjs.com/package/@godspeedai/cognate) ——SDK伞;最容易得到工作内核后置运行时间的方法.

## 许可证

阿帕奇 - 2.0

## 常见问题

### @godspeedai/cognate-kernel-api 是什么？

框架自有内核合同:背景,范围,能力,组件,纤维,效果\. 没有引擎类型\.

### 如何安装 @godspeedai/cognate-kernel-api？

在项目目录运行 npm install @godspeedai/cognate-kernel-api，或使用 pnpm add / yarn add / bun add。

### @godspeedai/cognate-kernel-api 支持 TypeScript 吗？

该包的 package\.json 没有声明类型入口。需要类型提示时，可以在 npm 上查找社区维护的 @types/godspeedai\_\_cognate-kernel-api 是否存在。

### @godspeedai/cognate-kernel-api 支持 ESM 还是 CommonJS？

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

### @godspeedai/cognate-kernel-api 可以商用吗？

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

### @godspeedai/cognate-kernel-api 的下载量有多少？

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

### @godspeedai/cognate-kernel-api 还在维护吗？

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

