@zturnlibs/ztron-api

---

internals#

Interfaces#

CallbackHandle#

Defined in: internals.ts:20

A callback handle returned by transformCallback.

Properties#

id#

id: number

Defined in: internals.ts:21

---

Internals#

Defined in: internals.ts:25

The full contract @zturnlibs/ztron-inject must expose on the window global.

Properties#

metadata#

metadata: Record<string, unknown>

Defined in: internals.ts:52

Window metadata injected by the backend.

Methods#

convertFileSrc()#

convertFileSrc(filePath, protocol?): string

Defined in: internals.ts:46

Converts a file path to a URL loadable by the WebView.

Parameters#

filePath#

string

protocol?#

string

Returns#

string

invoke()#

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

Defined in: internals.ts:27

Sends a message to the backend and resolves with its response.

Type Parameters#

T#

T

Parameters#

cmd#

string

args?#

InvokeArgs

options?#

InvokeOptions

Returns#

Promise<T>

postMessage()#

postMessage(message): void

Defined in: internals.ts:49

Sends a raw IPC message to the backend.

Parameters#

message#

unknown

Returns#

void

runCallback()#

runCallback(callbackId, ...args): void

Defined in: internals.ts:43

Invokes a registered callback (called by the backend via eval).

Parameters#

callbackId#

number

args#

...unknown[]

Returns#

void

transformCallback()#

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

Defined in: internals.ts:34

Registers a JS callback and returns its identifier for the backend.

Type Parameters#

T#

T

Parameters#

callback?#

(response) => void

once?#

boolean

Returns#

number

unregisterCallback()#

unregisterCallback(callbackId): void

Defined in: internals.ts:40

Removes a previously registered callback by its identifier.

Parameters#

callbackId#

number

Returns#

void

---

InvokeOptions#

Defined in: internals.ts:15

Invoke options forwarded to the backend.

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

Command arguments accepted by Internals.invoke.

Functions#

internals()#

internals(): Internals

Defined in: internals.ts:63

Accessor with a helpful error when running outside of a Ztron WebView.

Returns#

Internals