@zturnlibs/ztron-api

---

core#

Classes#

Channel#

Defined in: core.ts:34

用于从后端接收有序流式消息的通道。保留 Tauri 实现的顺序逻辑：消息携带单调递增的 index 并按序投递，乱序消息排队等候补齐。

Type Parameters#

T#

T = unknown

Constructors#

Constructor#

new Channel<T>(onmessage?): Channel<T>

Defined in: core.ts:44

Parameters#

onmessage?#

(response) => void

Returns#

Channel<T>

Properties#

id#

id: number

Defined in: core.ts:36

transformCallback 返回的回调 id。

Accessors#

onmessage#

Get Signature#

get onmessage(): (response) => void

Defined in: core.ts:101

Returns#

(response) => void

Set Signature#

set onmessage(handler): void

Defined in: core.ts:97

Parameters#

handler#

(response) => void

Returns#

void

Methods#

__ZTRON_TO_IPC_KEY__()#

__ZTRON_TO_IPC_KEY__(): string

Defined in: core.ts:105

Returns#

string

dispose()#

dispose(): void

Defined in: core.ts:93

客户端主动注销该通道的回调注册（幂等）：注销后到达的后端消息将被静默丢弃。与 end() 的区别：end 由流式语义驱动，dispose 用于组件卸载等需要立即清理的场景。

Returns#

void

toJSON()#

toJSON(): string

Defined in: core.ts:109

Returns#

string

---

Resource#

Defined in: core.ts:147

存储在资源表中、由后端持有的资源。存活于主进程，通过 close() 显式释放。

Constructors#

Constructor#

new Resource(rid): Resource

Defined in: core.ts:154

Parameters#

rid#

number

Returns#

Resource

Accessors#

rid#

Get Signature#

get rid(): number

Defined in: core.ts:150

Returns#

number

Methods#

close()#

close(): Promise<void>

Defined in: core.ts:159

销毁并从内存中清理该资源。

Returns#

Promise<void>

Variables#

SERIALIZE_TO_IPC_FN#

const SERIALIZE_TO_IPC_FN: "__ZTRON_TO_IPC_KEY__" = "__ZTRON_TO_IPC_KEY__"

Defined in: core.ts:12

特殊类型用于定义自身如何跨 IPC 序列化的键。若该值变更，请与 inject 包保持同步。

Functions#

addPluginListener()#

addPluginListener<T>(plugin, event, cb): Promise<() => Promise<void>>

Defined in: core.ts:181

注册后端插件监听器，镜像 Tauri 的 addPluginListener（plugin:|__listener / __unlistener 命令）。log 等插件因事件名不能含 | 而改用它。

Type Parameters#

T#

T = unknown

Parameters#

plugin#

string

event#

string

cb#

(payload) => void

Returns#

Promise<() => Promise<void>>

一个 Promise，resolve 为取消监听函数。

---

convertFileSrc()#

convertFileSrc(filePath, protocol?): string

Defined in: core.ts:137

把设备文件路径转换为 WebView 可加载的 URL。

Parameters#

filePath#

string

文件路径。

protocol?#

string

使用的协议，缺省为 asset。

Returns#

string

WebView 中可作为来源使用的 URL。

---

invoke()#

invoke<T>(cmd, args?, options?): Promise<T>

Defined in: core.ts:122

向 Ztron 后端发送一条消息。

Type Parameters#

T#

T

Parameters#

cmd#

string

命令名称。

args?#

InvokeArgs = {}

传给命令的可选参数。

options?#

InvokeOptions

请求选项。

Returns#

Promise<T>

一个 Promise，成功时 resolve 为后端响应，失败时 reject。

---

isZtron()#

isZtron(): boolean

Defined in: core.ts:165

当前上下文是否为 Ztron WebView。

Returns#

boolean

---

transformCallback()#

transformCallback<T>(callback?, once?): number

Defined in: core.ts:20

把回调存入已知位置，返回后端日后可调用它的标识符。

Type Parameters#

T#

T = unknown

Parameters#

callback?#

(response) => void

once?#

boolean = false

Returns#

number

与该回调关联的唯一标识符。

References#

InvokeArgs#

Re-exports InvokeArgs

---

InvokeOptions#

Re-exports InvokeOptions