Skip to content

k.file ​

文件操作

概述 ​

k.file 提供站点内磁盘目录上文件的操作(读写、复制、删除等)。Kooboo 后台 没有 与 k.file 一一对应的可视化文件管理页。

与「内容 → 文件」菜单

后台 内容 → 文件(/content/files)管理的是 CMS 文件库(CmsFile),可通过站点 URL 访问;与 k.file 不是同一套存储,且目前 没有 k.xxx API 操作 CMS 文件库。操作说明见 后台:文件。

write() ​

写入文本内容到文件。如果文件已存在则覆盖。

ts
k.api.post("write", () => {
    k.file.write("test-folder/test.txt", "hello world")
    const content = k.file.read("test-folder/test.txt")
    return { content: content }
})

参数:

参数类型必填说明
fileNamestring是文件路径
contentstring是文件内容
withAuthorInfoboolean否是否包含作者信息,默认 false

返回: [FileInfo](./file-info.md#fileinfo-属性)

writeBinary() ​

写入字节数组到文件。如果文件已存在则覆盖。用于上传文件、下载的响应内容、生成的图片/PDF 等非文本内容。

ts
k.api.post("upload", () => {
    const file = k.request.files[0]
    const info = k.file.writeBinary(`uploads/${file.fileName}`, file.bytes)
    return { saved: info.name, size: info.size }
})

参数:

参数类型必填说明
fileNamestring是文件路径
binarynumber[]是要写入的字节数组
withAuthorInfoboolean否是否包含作者信息,默认 false

返回: [FileInfo](./file-info.md#fileinfo-属性);字节数组为空时返回 null。

read() ​

读取文件的文本内容。

ts
k.api.get("read", () => {
    return k.file.read("test-folder/test.txt")
})

参数:

参数类型必填说明
fileNamestring是文件路径

返回: string - 文件文本内容

readBinary() ​

读取文件为字节数组。文件不存在时返回 null。

ts
const bytes = k.file.readBinary("file.pdf")
const info = k.file.writeBinary("newname.pdf", bytes)

参数:

参数类型必填说明
fileNamestring是文件路径

返回: number[] - 文件内容的字节数组

append() ​

追加文本内容到文件。如果文件不存在则创建。

ts
k.api.post("append", () => {
    k.file.append("test-folder/append.txt", "追加的内容")
    const content = k.file.read("test-folder/append.txt")
    return { content: content }
})

参数:

参数类型必填说明
fileNamestring是文件路径
contentstring是追加的内容

返回: void

exists() ​

检查文件是否存在。

ts
k.api.get("exists", () => {
    return k.file.exists("test-folder/test.txt")
})

参数:

参数类型必填说明
fileNamestring是文件路径

返回: boolean

get() ​

获取文件信息。

ts
k.api.get("get", () => {
    return k.file.get("test-folder/test.txt")
})

参数:

参数类型必填说明
fileNamestring是文件路径
includeAuthorboolean否是否包含作者信息,默认 false

返回: [FileInfo](./file-info.md#fileinfo-属性)

url() ​

获取文件的相对访问路径。

ts
k.api.get("url", () => {
    return k.file.url("image.jpg")
})

参数:

参数类型必填说明
fileNamestring是文件名或相对路径

返回: string - 相对 URL 路径

rename() ​

重命名文件。

ts
k.api.post("rename", () => {
    k.file.write("test-folder/old.txt", "content")
    k.file.rename("test-folder/old.txt", "test-folder/new.txt")
    const newExists = k.file.exists("test-folder/new.txt")
    const oldExists = k.file.exists("test-folder/old.txt")
    return { newExists: newExists, oldExists: oldExists }
})

参数:

参数类型必填说明
oldNamestring是原文件路径
newNamestring是新文件路径

返回: void

copy() ​

复制文件或目录。

ts
k.api.post("copy", () => {
    k.file.write("test-folder/source.txt", "content")
    k.file.copy("test-folder/source.txt", "test-folder/dest.txt")
    const destExists = k.file.exists("test-folder/dest.txt")
    return { destExists: destExists }
})

参数:

参数类型必填说明
oldNamestring是源路径
newNamestring是目标路径

返回: void

delete() ​

删除文件。

ts
k.api.post("delete", () => {
    k.file.write("test-folder/to-delete.txt", "content")
    k.file.delete("test-folder/to-delete.txt")
    const exists = k.file.exists("test-folder/to-delete.txt")
    return { deleted: !exists }
})

参数:

参数类型必填说明
fileNamestring是文件路径

返回: void

toValidPath() ​

将输入转换为有效的文件路径。

ts
k.api.get("toValidPath", () => {
    return k.file.toValidPath("folder/file@name.txt")
})

参数:

参数类型必填说明
inputstring是输入路径

返回: string

相关文档 ​