@zturnlibs/ztron-api

---

internals#

Interfaces#

CallbackHandle#

Defined in: internals.ts:20

回调句柄（transformCallback 返回的形态，携带数字 id）。

Properties#

id#

id: number

Defined in: internals.ts:21

---

Internals#

Defined in: internals.ts:25

@zturnlibs/ztron-inject 必须暴露在 window 全局上的完整契约。

Properties#

metadata#

metadata: Record<string, unknown>

Defined in: internals.ts:52

由后端注入的窗口元数据。

Methods#

convertFileSrc()#

convertFileSrc(filePath, protocol?): string

Defined in: internals.ts:46

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

Parameters#

filePath#

string

protocol?#

string

Returns#

string

invoke()#

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

Defined in: internals.ts:27

向后端发送消息并以响应 resolve。

Type Parameters#

T#

T

Parameters#

cmd#

string

args?#

InvokeArgs

options?#

InvokeOptions

Returns#

Promise<T>

postMessage()#

postMessage(message): void

Defined in: internals.ts:49

向后端发送一条原始 IPC 消息。

Parameters#

message#

unknown

Returns#

void

runCallback()#

runCallback(callbackId, ...args): void

Defined in: internals.ts:43

调用一个已注册的回调（由后端经 eval 触发）。

Parameters#

callbackId#

number

args#

...unknown[]

Returns#

void

transformCallback()#

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

Defined in: internals.ts:34

注册一个 JS 回调并把它的标识符返回给后端。

Type Parameters#

T#

T

Parameters#

callback?#

(response) => void

once?#

boolean

Returns#

number

unregisterCallback()#

unregisterCallback(callbackId): void

Defined in: internals.ts:40

按标识符移除之前注册的回调。

Parameters#

callbackId#

number

Returns#

void

---

InvokeOptions#

Defined in: internals.ts:15

转发给后端的 invoke 选项。

Properties#

headers?#

optional headers?: HeadersInit

Defined in: internals.ts:16

Type Aliases#

InvokeArgs#

InvokeArgs = Record<string, unknown> | number[] | ArrayBuffer | Uint8Array

Defined in: internals.ts:11

Internals.invoke 接受的命令参数形态。

Functions#

internals()#

internals(): Internals

Defined in: internals.ts:63

带友好报错的访问器：不在 Ztron WebView 中运行时抛出异常。

Returns#

Internals