Vtron

English

Chinese

English

Chinese

Appearance

On this page

fs

readFile

读取一个文件的内容

read the content of a file

typescript
readFile(path: string): Promise<string | null>;

import { system } from "./system";
system.fs.readFile("path/to/file").then((data)=>{
    //...
})

writeFile

写入文件内容到指定路径，如果文件不存在则创建文件

write content to a file, if the file is not exist, it will be created

typescript
 writeFile(path: string, par: {
        content: string;
        name: string;
        icon: string;
        type: string;
    }): Promise<void>;

import { system } from "./system";
system.fs.writeFile("path/to/file",{
    content:"hello world",
    name:"hello.txt",
    icon:"pngraw",
    type:"text/plain"
})

appendFile

在文件末尾追加内容

append content to the end of a file

typescript
appendFile(path: string, content: string): Promise<void>;

import { system } from "./system";
system.fs.appendFile("path/to/file","hello world")

mkdir

创建一个文件夹

create a folder

typescript
mkdir(path: string): Promise<void>;

import { system } from "./system";
system.fs.mkdir("path/to/folder")

readdir

读取指定路径下的所有文件和文件夹

read all files and folders in a path

typescript
class VtronFile {
    path: string;
    parentPath: string;
    content: string;
    name: string;
    icon: string;
    type: string;
    constructor(path: string, parentPath: string, content: string, name: string, icon: string, type: string);
}

readdir(path: string): Promise<VtronFile[]>;

import { system } from "./system";
system.fs.readdir("path/to/folder").then((files)=>{
    //...
    files.forEach((file)=>{
        console.log(file.name)
    })
})

exists

判断指定路径的文件或文件夹是否存在

check if a file or folder is exist

typescript

exists(path: string): Promise<boolean>;

import { system } from "./system";
system.fs.exists("path/to/file").then((exist)=>{
    //...
})

stat

获取指定路径的文件或文件夹的信息

get the info of a file or folder

typescript
stat(path: string): Promise<VtronFile | null>;

import { system } from "./system";
system.fs.stat("path/to/file").then((file)=>{
    //...
})

删除指定路径的文件

delete a file

typescript
unlink(path: string): Promise<void>;

import { system } from "./system";
system.fs.unlink("path/to/file")

rmdir

删除指定路径的文件夹，这个操作会删除这个文件夹下的所有文件和文件夹

delete a folder, this operation will delete all files and folders in this folder

typescript
rmdir(path: string): Promise<void>;

import { system } from "./system";
system.fs.rmdir("path/to/folder")

rename

重命名指定路径的文件或文件夹

rename a file or folder

typescript
rename(path: string, newPath: string): Promise<void>;

import { system } from "./system";
system.fs.rename("path/to/file","path/to/new/file")