# @gd-kirie/ipc 中文文档

规范地址：https://npmcn.com/package/%40gd-kirie/ipc/

版本：0\.16\.0
npm 元数据更新时间：2026-10-29T13:21:39.978Z
中文译文更新时间：2026-11-16T00:58:41.996Z
软件包许可：未声明

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

原始 npm 页面：https://www.npmjs.com/package/%40gd-kirie/ipc
原文对照：https://npmcn.com/package/%40gd-kirie/ipc/?lang=original
源码仓库：https://github.com/gd-kirie/gd-kirie

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

- 包体积（解压后）：51.8 kB，14 个文件
- 模块格式：ES Module
- TypeScript 类型：包内自带
- 运行依赖：1 个
- 首次发布：2026-04-30T08:54:01.147Z
- 最新版本发布：2026-10-29T13:21:37.586Z
- 近 30 天下载量：12532（2026-10-16 至 2026-11-14，npm 官方下载统计）
- 已发布版本数：31（近 12 个月 31 个）

## 中文简介

暂无中文简介

## 安装

```sh
npm install @gd-kirie/ipc
```

也可以使用：`pnpm add @gd-kirie/ipc`、`yarn add @gd-kirie/ipc`、`bun add @gd-kirie/ipc`

## README

# @gd-kirie/ipc (英语)

Kirie WebView页面的瘦浏览器-侧 IPC 传输 .

包由运行在Kirie Webview内部的网页内容导入. 原生平台继续提供低地 电平桥开启 `globalThis`,而这个软件包只用一个打入的小型模块API来包接桥.

## API 密码

```ts
import { onTextReceived, sendText } from "@gd-kirie/ipc";

sendText(JSON.stringify({
  type: "web_ready",
}));

const unsubscribe = onTextReceived((message) => {
  console.log(message);
});

unsubscribe();
```

软件包从 `window.kirie.platform`。 。 。 . 原始后端在页面脚本运行前注入此属性 . 在Web上,第一个API呼叫发现了iframe端口并设置了平台属性.

Android 曝光由 CBOR 包和 AndroidX WebKit 支持的三个频道 串行缓冲器消息 。 iOS 在 WKWebView 脚本上曝光同一道 API 消息, 将每个 CBOR 包作为平台字符串内的基础64 消息 :

-   `sendText()` 编号 : `onTextReceived()` cBOR 文本字符串
-   `sendBinary()` 编号 : `onBinaryReceived()` 用于 CBOR 字节字符串
-   `sendData()` 编号 : `onDataReceived()` 用于通过 CBOR 编码的结构化数据 `cborg`

结构化数据子集仅限于 `null`,布尔斯,数字,弦, 数组,以及带有字符串键的对象。 JSON 消息形状是调用者或 适配器公约,应随 `sendText()` 需要的时候.

## 网络iframe运输

在Web导出时,包会发现其同源母体. 第一个API呼叫集 `window.kirie.platform` 改为 `{ os: "web", backend: "iframe" }`。 。 。 . 这些值延伸 `KiriePlatformOs` 财务报告和审定财务报表 `KiriePlatformBackend`。 。 。 . 每个接收函数返回一个删除其消息收听器的未订阅函数. Iframe 文档加载后, 主机会传送浏览器的一端 `MessageChannel`iframe报告通过港口准备就绪。 准备情况 不取决于车道订阅,所以 仅文本适配器,如 Eventa 不需要空二进制或数据处理器. 只订阅页面所消耗的道 :

```ts
import { onTextReceived, sendText } from "@gd-kirie/ipc";

const stopText = onTextReceived(sendText);

window.addEventListener("pagehide", () => {
  stopText();
}, { once: true });
```

Web 发送文本字符串、 二进制矩阵缓冲器和数据值 转移 `MessagePort` 财务报告和审定财务报表 [结构克隆](https://developer.mozilla.org/en-US/docs/Web/API/Web_Workers_API/Structured_clone_algorithm)。 。 。 . 它没有将有效载荷序列化为JSON或CBOR. 二进制 API 参数和回调仍然使用 `Uint8Array`。 。 。 . 传输复制所选择的字节范围并保持发送者的缓冲完整. 数据只接受所记录的跨平台子集. 它拒绝自定义原型,循环,非无限数量,不安全整数,并筑巢超过64个容器水平.

主机在传输端口时使用精确的目标源. 框架 仅从同一来源的父端接受该端口。 以后车道交通要继续 因此 Kirie 不执行另一个窗口消息路由器或 频道注册. 交叉出处的内容和不透明的出处是不支持的.

`createIframeTransport(window, { origin })` 明确暴露运输. `KirieIframeConfig` 财务报告和审定财务报表 `KirieTransport` 描述其配置和 API. 工厂从母厂接收港口;它不创建或拥有一个iframe.

## 指向输入转发

> \[大 Kirie Web Victors 通常在Godot 上方填充本地主机。 CSS 透明度 不通过土生土长的命中测试 通过哥多,如此明显的哥多控制 在WebView后方不能点击,无需指针转发。 大部分基里语 页面应导入 `@gd-kirie/ipc/pointer-input/auto`。 。 。 .

启用两侧; 导入时浏览器条目注册 :

```gdscript
$KirieNode.pointer_input_forwarding_enabled = true
```

```ts
import "@gd-kirie/ipc/pointer-input/auto";
```

### 自定义事件 :

对于自定义目标或寿命,使用明确条目:

```ts
import {
  createPointerEventsHandler,
  phaseFromPointerEvent,
  sendPointerEvent,
} from "@gd-kirie/ipc/pointer-input";
```

`createPointerEventsHandler()` 返回时 `capture`, (中文(简体) ), `bubble`,以及 `cancel` 操作者; 打电话者拥有他们的注册和除名.

`pointerdown` 模糊决定所有权 : `event.stopPropagation()` 留着 webView 中的序列; 否则将转发其移动、 上行和取消事件 给哥多.

使用哥多特的传送 [`Input.parse_input_event()`](https://docs.godotengine.org/en/stable/classes/class_input.html#class-input-method-parse-input-event) API; 转发鼠标并触摸事件保留其目的地 [`window_id`](https://docs.godotengine.org/en/stable/classes/class_inputeventfromwindow.html#class-inputeventfromwindow-property-window-id)。 。 。 .

## 常见问题

### 如何安装 @gd-kirie/ipc？

在项目目录运行 npm install @gd-kirie/ipc，或使用 pnpm add / yarn add / bun add。

### @gd-kirie/ipc 支持 TypeScript 吗？

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

### @gd-kirie/ipc 支持 ESM 还是 CommonJS？

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

### @gd-kirie/ipc 可以商用吗？

@gd-kirie/ipc 使用 未声明 许可。package\.json 没有声明许可证。没有许可证的代码默认保留全部权利，商用前请联系作者或查看仓库中的 LICENSE 文件。以上为概括，不构成法律意见，请以许可原文为准。

### @gd-kirie/ipc 的下载量有多少？

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

### @gd-kirie/ipc 还在维护吗？

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

