@zturnlibs/ztron-api

---

shell#

Classes#

Command#

Defined in: shell.ts:70

对齐 Tauri Command 类的命令构建器。stdout/stderr 经 ztron://shell-output / ztron://shell-error 事件流式送达。

Constructors#

Constructor#

new Command(program, args?, options?): Command

Defined in: shell.ts:76

Parameters#

program#

string

args?#

string[] = []

options?#

CommandOptions = {}

Returns#

Command

Properties#

args#

readonly args: string[]

Defined in: shell.ts:72

options#

readonly options: CommandOptions

Defined in: shell.ts:73

program#

readonly program: string

Defined in: shell.ts:71

Methods#

execute()#

execute(): Promise<ExecResult>

Defined in: shell.ts:163

运行命令并收集全量输出，resolve 为该输出。

Returns#

Promise<ExecResult>

kill()#

kill(cid, signal?): Promise<void>

Defined in: shell.ts:158

终止已 spawn 的命令（默认 SIGTERM）。

Parameters#

cid#

string

signal?#

number = 15

Returns#

Promise<void>

on()#

on(event, handler): this

Defined in: shell.ts:87

注册事件监听器；返回 this 以便链式调用。

Parameters#

event#

CommandEvent

handler#

(data) => void

Returns#

this

spawn()#

spawn(): Promise<void>

Defined in: shell.ts:99

spawn 命令并流式发出输出事件；进程退出时 resolve。

Returns#

Promise<void>

spawnInteractive()#

spawnInteractive(): Promise<string>

Defined in: shell.ts:126

长驻 spawn：启动后 resolve 出命令 id；输出持续经 on("stdout"/"stderr") 流式送达，终止经 on("terminated")（{cid, code}）。配合 write 与 kill 驱动交互式进程。

Returns#

Promise<string>

status()#

status(): Promise<number>

Defined in: shell.ts:197

运行命令并 resolve 其退出码。

Returns#

Promise<number>

write()#

write(cid, data): Promise<void>

Defined in: shell.ts:153

向已 spawn 命令的标准输入写入（spawnInteractive 返回的 cid）。

Parameters#

cid#

string

data#

string

Returns#

Promise<void>

sidecar()#

static sidecar(): never

Defined in: shell.ts:202

不支持（Ztron 无 sidecar 打包）。

Returns#

never

Interfaces#

CommandOptions#

Defined in: shell.ts:59

Properties#

cwd?#

optional cwd?: string

Defined in: shell.ts:60

env?#

optional env?: Record<string, string>

Defined in: shell.ts:61

---

ExecResult#

Defined in: shell.ts:5

Properties#

code#

code: number

Defined in: shell.ts:6

stderr#

stderr: string

Defined in: shell.ts:8

stdout#

stdout: string

Defined in: shell.ts:7

Variables#

shell#

const shell: object

Defined in: shell.ts:207

Type Declaration#

Command#

Command: typeof Command

execute#

execute: (program, args, options) => Promise<ExecResult>

Parameters#

program#

string

args?#

string[] = []

options?#

cwd?#

string

env?#

Record<string, string>

Returns#

Promise<ExecResult>

executeStream#

executeStream: (program, args, options) => Promise<{ code: number; }>

执行命令，stdout 块一到就回调 onChunk（适合长时命令）。resolve 为退出码。

Parameters#

program#

string

args?#

string[] = []

options?#

object & object = {}

Returns#

Promise<{ code: number; }>

open#

open: (url) => Promise<{ opened: boolean; }>

用默认浏览器打开 http(s) URL（发出后不等待）。

Parameters#

url#

string

Returns#

Promise<{ opened: boolean; }>

Functions#

execute()#

execute(program, args?, options?): Promise<ExecResult>

Defined in: shell.ts:11

Parameters#

program#

string

args?#

string[] = []

options?#

cwd?#

string

env?#

Record<string, string>

Returns#

Promise<ExecResult>

---

executeStream()#

executeStream(program, args?, options?): Promise<{ code: number; }>

Defined in: shell.ts:27

执行命令，stdout 块一到就回调 onChunk（适合长时命令）。resolve 为退出码。

Parameters#

program#

string

args?#

string[] = []

options?#

object & object = {}

Returns#

Promise<{ code: number; }>

---

open()#

open(url): Promise<{ opened: boolean; }>

Defined in: shell.ts:55

用默认浏览器打开 http(s) URL（发出后不等待）。

Parameters#

url#

string

Returns#

Promise<{ opened: boolean; }>