@zturnlibs/ztron-api

---

fs#

Classes#

FileHandle#

Defined in: fs.ts:197

作用域内的文件句柄（对齐上游 FileHandle）：读写推进内部游标；close() 会刷出缓冲写入。

Constructors#

Constructor#

new FileHandle(id, path): FileHandle

Defined in: fs.ts:202

Internal

内部构造——请通过 open() 创建。

Parameters#

id#

number

path#

string

Returns#

FileHandle

Properties#

id#

readonly id: number

Defined in: fs.ts:198

path#

readonly path: string

Defined in: fs.ts:199

Methods#

close()#

close(): Promise<void>

Defined in: fs.ts:244

刷出并释放句柄。

Returns#

Promise<void>

flush()#

flush(): Promise<void>

Defined in: fs.ts:239

把缓冲写入刷到磁盘。

Returns#

Promise<void>

read()#

read(length): Promise<Uint8Array<ArrayBufferLike>>

Defined in: fs.ts:208

从游标处读取至多 length 字节（线上为 base64）。

Parameters#

length#

number

Returns#

Promise<Uint8Array<ArrayBufferLike>>

seek()#

seek(offset, whence?): Promise<number>

Defined in: fs.ts:227

移动游标；whence 取 "start"（默认）| "current" | "end"。

Parameters#

offset#

number

whence?#

"end" | "start" | "current"

Returns#

Promise<number>

write()#

write(data): Promise<number>

Defined in: fs.ts:217

在游标处写入字节（并推进游标）。

Parameters#

data#

ArrayBuffer | Uint8Array<ArrayBufferLike>

Returns#

Promise<number>

Interfaces#

DirEntry#

Defined in: fs.ts:24

Properties#

isDirectory#

isDirectory: boolean

Defined in: fs.ts:26

isFile#

isFile: boolean

Defined in: fs.ts:27

name#

name: string

Defined in: fs.ts:25

---

FileMeta#

Defined in: fs.ts:115

Properties#

isDirectory#

isDirectory: boolean

Defined in: fs.ts:117

isFile#

isFile: boolean

Defined in: fs.ts:118

modifiedAt#

modifiedAt: string | null

Defined in: fs.ts:119

size#

size: number

Defined in: fs.ts:116

---

FsPathOptions#

Defined in: fs.ts:9

v1 fs 函数接受的可选尾参。

Properties#

baseDir?#

optional baseDir?: string

Defined in: fs.ts:11

相对路径先按该基目录解析。

---

MakeDirOptions#

Defined in: fs.ts:77

makeDir 的选项。

Properties#

recursive?#

optional recursive?: boolean

Defined in: fs.ts:79

按需创建父目录；目录已存在时不报错。

---

OpenOptions#

Defined in: fs.ts:182

open 的选项。

Properties#

append?#

optional append?: boolean

Defined in: fs.ts:186

写入定位到文件末尾（隐含 write）。

baseDir?#

optional baseDir?: string

Defined in: fs.ts:190

相对路径的基目录。

create?#

optional create?: boolean

Defined in: fs.ts:188

文件缺失时创建（配合 write/append）。

read?#

optional read?: boolean

Defined in: fs.ts:183

write?#

optional write?: boolean

Defined in: fs.ts:184

---

WatchEvent#

Defined in: fs.ts:138

文件系统 watch 事件（对齐 Tauri 的 watchEvent）。

Properties#

path#

path: string

Defined in: fs.ts:143

被改动条目的路径（监视目录时相对该目录；监视文件时即该文件本身）。

type#

type: "modify" | "rename"

Defined in: fs.ts:140

"modify"（内容变化）| "rename"（创建/删除/移动）。

Variables#

fs#

const fs: object

Defined in: fs.ts:164

Type Declaration#

copyFile#

copyFile: (path, dest) => Promise<void>

复制文件（源与目标都必须在作用域内）。

Parameters#

path#

string

dest#

string

Returns#

Promise<void>

exists#

exists: (path, options?) => Promise<boolean>

检查路径是否存在（作用域外的路径报 false）。

Parameters#

path#

string

options?#

FsPathOptions

Returns#

Promise<boolean>

makeDir#

makeDir: (path, options?) => Promise<void>

Parameters#

path#

string

options?#

MakeDirOptions

Returns#

Promise<void>

readDir#

readDir: (path, options?) => Promise<DirEntry[]>

列出一个目录的内容。

Parameters#

path#

string

options?#

FsPathOptions

Returns#

Promise<DirEntry[]>

readFile#

readFile: (path) => Promise<Uint8Array<ArrayBufferLike>>

读取一个二进制文件；以原始字节（Uint8Array）resolve（原始 IPC 响应——注入的 invoke 已解开后端信封）。

Parameters#

path#

string

Returns#

Promise<Uint8Array<ArrayBufferLike>>

readText#

readText: (path, options?) => Promise<string>

读取一个文本文件（按 UTF-8 解码）。

Parameters#

path#

string

options?#

FsPathOptions

Returns#

Promise<string>

remove#

remove: (path) => Promise<void>

删除文件（或空目录）。

Parameters#

path#

string

Returns#

Promise<void>

renameFile#

renameFile: (path, newPath) => Promise<void>

重命名/移动文件（两个路径都必须在作用域内）。

Parameters#

path#

string

newPath#

string

Returns#

Promise<void>

stat#

stat: (path) => Promise<FileMeta>

查询文件元信息（大小/类型/最后修改时间）。

Parameters#

path#

string

Returns#

Promise<FileMeta>

watch#

watch: (path, handler) => Promise<() => Promise<void>>

监视路径变化。后端 watcher 就绪后 resolve 出取消监视函数；之后事件经 handler 流式送达。路径必须位于应用的 fs 作用域内（与所有 fs API 一致）。

Parameters#

path#

string

handler#

(event) => void

Returns#

Promise<() => Promise<void>>

writeFile#

writeFile: (path, data) => Promise<void>

从原始字节（或直接传 base64 字符串）写入一个二进制文件。

Parameters#

path#

string

data#

string | Uint8Array<ArrayBufferLike>

Returns#

Promise<void>

writeText#

writeText: (path, contents, options?) => Promise<void>

写入一个文本文件。

Parameters#

path#

string

contents#

string

options?#

FsPathOptions

Returns#

Promise<void>

Functions#

chmod()#

chmod(path, mode, options?): Promise<void>

Defined in: fs.ts:312

修改文件权限位（unix mode）。

Parameters#

path#

string

mode#

number

options?#

FsPathOptions

Returns#

Promise<void>

---

copyFile()#

copyFile(path, dest): Promise<void>

Defined in: fs.ts:123

复制文件（源与目标都必须在作用域内）。

Parameters#

path#

string

dest#

string

Returns#

Promise<void>

---

exists()#

exists(path, options?): Promise<boolean>

Defined in: fs.ts:62

检查路径是否存在（作用域外的路径报 false）。

Parameters#

path#

string

options?#

FsPathOptions

Returns#

Promise<boolean>

---

lstat()#

lstat(path, options?): Promise<{ isSymlink: boolean; mode: number; size: number; }>

Defined in: fs.ts:281

不跟随符号链接的 stat。

Parameters#

path#

string

options?#

FsPathOptions

Returns#

Promise<{ isSymlink: boolean; mode: number; size: number; }>

---

makeDir()#

makeDir(path, options?): Promise<void>

Defined in: fs.ts:108

Parameters#

path#

string

options?#

MakeDirOptions

Returns#

Promise<void>

---

open()#

open(path, options?): Promise<FileHandle>

Defined in: fs.ts:266

打开一个作用域内的文件句柄。

Parameters#

path#

string

options?#

OpenOptions = {}

Returns#

Promise<FileHandle>

---

readDir()#

readDir(path, options?): Promise<DirEntry[]>

Defined in: fs.ts:52

列出一个目录的内容。

Parameters#

path#

string

options?#

FsPathOptions

Returns#

Promise<DirEntry[]>

---

readFile()#

readFile(path): Promise<Uint8Array<ArrayBufferLike>>

Defined in: fs.ts:85

读取一个二进制文件；以原始字节（Uint8Array）resolve（原始 IPC 响应——注入的 invoke 已解开后端信封）。

Parameters#

path#

string

Returns#

Promise<Uint8Array<ArrayBufferLike>>

---

readLink()#

readLink(path, options?): Promise<string>

Defined in: fs.ts:291

读取符号链接的目标。

Parameters#

path#

string

options?#

FsPathOptions

Returns#

Promise<string>

---

readText()#

readText(path, options?): Promise<string>

Defined in: fs.ts:31

读取一个文本文件（按 UTF-8 解码）。

Parameters#

path#

string

options?#

FsPathOptions

Returns#

Promise<string>

---

remove()#

remove(path): Promise<void>

Defined in: fs.ts:72

删除文件（或空目录）。

Parameters#

path#

string

Returns#

Promise<void>

---

renameFile()#

renameFile(path, newPath): Promise<void>

Defined in: fs.ts:128

重命名/移动文件（两个路径都必须在作用域内）。

Parameters#

path#

string

newPath#

string

Returns#

Promise<void>

---

stat()#

stat(path): Promise<FileMeta>

Defined in: fs.ts:133

查询文件元信息（大小/类型/最后修改时间）。

Parameters#

path#

string

Returns#

Promise<FileMeta>

---

truncate()#

truncate(path, length, options?): Promise<void>

Defined in: fs.ts:301

把文件截断（或零填充扩展）到 length 字节。

Parameters#

path#

string

length#

number

options?#

FsPathOptions

Returns#

Promise<void>

---

watch()#

watch(path, handler): Promise<() => Promise<void>>

Defined in: fs.ts:151

监视路径变化。后端 watcher 就绪后 resolve 出取消监视函数；之后事件经 handler 流式送达。路径必须位于应用的 fs 作用域内（与所有 fs API 一致）。

Parameters#

path#

string

handler#

(event) => void

Returns#

Promise<() => Promise<void>>

---

writeFile()#

writeFile(path, data): Promise<void>

Defined in: fs.ts:90

从原始字节（或直接传 base64 字符串）写入一个二进制文件。

Parameters#

path#

string

data#

string | Uint8Array<ArrayBufferLike>

Returns#

Promise<void>

---

writeText()#

writeText(path, contents, options?): Promise<void>

Defined in: fs.ts:41

写入一个文本文件。

Parameters#

path#

string

contents#

string

options?#

FsPathOptions

Returns#

Promise<void>