HarmonyOS API：@ohos.fileio (文件管理)

版本：v3.1 Beta

@ohos.fileio (文件管理)

fileio.chmod⁷⁺

chmod(path: string, mode: number): Promise<void>

改变文件权限，使用Promise异步回调。

系统能力：SystemCapability.FileManagement.File.FileIO

参数：

返回值：

示例：

let filePath = pathDir + "/test.txt";
fileio.chmod(filePath, 0o700).then(function() {
    console.info("chmod succeed");
}).catch(function(err){
    console.info("chmod failed with error:"+ err);
});

fileio.chmod⁷⁺

chmod(path: string, mode: number, callback: AsyncCallback<void>): void

改变文件权限，使用callback异步回调。

系统能力：SystemCapability.FileManagement.File.FileIO

参数：

示例：

let filePath = pathDir + "/test.txt";
fileio.chmod(filePath, 0o700, function (err) {
    // do something
});

fileio.chmodSync⁷⁺

chmodSync(path: string, mode: number): void

以同步方法改变文件权限。

系统能力：SystemCapability.FileManagement.File.FileIO

参数：

示例：

let filePath = pathDir + "/test.txt";
fileio.chmodSync(filePath, 0o700);

fileio.fstat⁷⁺

fstat(fd: number): Promise<Stat>

基于文件描述符获取文件状态信息，使用Promise异步回调。

系统能力：SystemCapability.FileManagement.File.FileIO

参数：

返回值：

示例：

let filePath = pathDir + "/test.txt";
let fd = fileio.openSync(filePath);
fileio.fstat(fd).then(function(stat){
    console.info("fstat succeed, the size of file is "+ stat.size);
}).catch(function(err){
    console.info("fstat failed with error:"+ err);
});

fileio.fstat⁷⁺

fstat(fd: number, callback: AsyncCallback<Stat>): void

基于文件描述符获取文件状态信息，使用callback异步回调。

系统能力：SystemCapability.FileManagement.File.FileIO

参数：

示例：

let filePath = pathDir + "/test.txt";
let fd = fileio.openSync(filePath);
fileio.fstat(fd, function (err) {
    // do something
});

fileio.fstatSync⁷⁺

fstatSync(fd: number): Stat

以同步方法基于文件描述符获取文件状态信息。

系统能力：SystemCapability.FileManagement.File.FileIO

参数：

返回值：

示例：

let filePath = pathDir + "/test.txt";
let fd = fileio.openSync(filePath);
let stat = fileio.fstatSync(fd);

fileio.ftruncate⁷⁺

ftruncate(fd: number, len?: number): Promise<void>

基于文件描述符截断文件，使用Promise异步回调。

系统能力：SystemCapability.FileManagement.File.FileIO

参数：

返回值：

示例：

let filePath = pathDir + "/test.txt";
let fd = fileio.openSync(filePath);
fileio.ftruncate(fd, 5).then(function(err) {    
    console.info("truncate file succeed");
}).catch(function(err){
    console.info("truncate file failed with error:"+ err);
});

fileio.ftruncate⁷⁺

ftruncate(fd: number, len?: number, callback: AsyncCallback<void>): void

基于文件描述符截断文件，使用callback异步回调。

系统能力：SystemCapability.FileManagement.File.FileIO

参数：

示例：

let filePath = pathDir + "/test.txt";
let fd = fileio.openSync(filePath);
let len = 5;
fileio.ftruncate(fd, 5, function(err){
    // do something
});

fileio.ftruncateSync⁷⁺

ftruncateSync(fd: number, len?: number): void

以同步方法基于文件描述符截断文件。

系统能力：SystemCapability.FileManagement.File.FileIO

参数：

示例：

let filePath = pathDir + "/test.txt";
let fd = fileio.openSync(filePath);
let len = 5;
fileio.ftruncateSync(fd, len);

fileio.truncate⁷⁺

truncate(path: string, len?: number): Promise<void>

基于文件路径截断文件，使用Promise异步回调。

系统能力：SystemCapability.FileManagement.File.FileIO

参数：

返回值：

示例：

let filePath = pathDir + "/test.txt";
let len = 5;
fileio.truncate(filePath, len).then(function(){
    console.info("truncate file succeed");
}).catch(function(err){
    console.info("truncate file failed with error:"+ err);
});

fileio.truncate⁷⁺

truncate(path: string, len?: number, callback: AsyncCallback<void>): void

基于文件路径截断文件，使用callback异步回调。

系统能力：SystemCapability.FileManagement.File.FileIO

参数：

示例：

let filePath = pathDir + "/test.txt";
let len = 5;
fileio.truncate(filePath, len, function(err){
    // do something
});

fileio.truncateSync⁷⁺

truncateSync(path: string, len?: number): void

以同步方法基于文件路径截断文件。

系统能力：SystemCapability.FileManagement.File.FileIO

参数：

示例：

let filePath = pathDir + "/test.txt";
let len = 5;
fileio.truncateSync(filePath, len);

fileio.readText⁷⁺

readText(filePath: string, options?: { position?: number; length?: number; encoding?: string; }): Promise<string>

基于文本方式读取文件（即直接读取文件的文本内容），使用Promise异步回调。

系统能力：SystemCapability.FileManagement.File.FileIO

参数：

返回值：

示例：

let filePath = pathDir + "/test.txt";
fileio.readText(filePath).then(function(str) {
    console.info("readText succeed:"+ str);
}).catch(function(err){
    console.info("readText failed with error:"+ err);
});

fileio.readText⁷⁺

readText(filePath: string, options: { position?: number; length?: number; encoding?: string; }, callback: AsyncCallback<string>): void

基于文本方式读取文件（即直接读取文件的文本内容），使用callback异步回调。

系统能力：SystemCapability.FileManagement.File.FileIO

参数：

示例：

let filePath = pathDir + "/test.txt";
fileio.readText(filePath, { position: 1, encoding: 'UTF-8' }, function(err, str){
    // do something
});

fileio.readTextSync⁷⁺

readTextSync(filePath: string, options?: { position?: number; length?: number; encoding?: string; }): string

以同步方法基于文本方式读取文件（即直接读取文件的文本内容）。

系统能力：SystemCapability.FileManagement.File.FileIO

参数：

返回值：

示例：

let filePath = pathDir + "/test.txt";
let str = fileio.readTextSync(filePath, {position: 1, length: 3});

fileio.lstat⁷⁺

lstat(path: string): Promise<Stat>

获取链接信息，使用Promise异步回调。

系统能力：SystemCapability.FileManagement.File.FileIO

参数：

返回值：

示例：

let filePath = pathDir + "/test.txt";
fileio.lstat(filePath).then(function(stat){
    console.info("get link status succeed, the size of file is" + stat.size);
}).catch(function(err){
    console.info("get link status failed with error:"+ err);
});

fileio.lstat⁷⁺

lstat(path: string, callback: AsyncCallback<Stat>): void

获取链接信息，使用callback异步回调。

系统能力：SystemCapability.FileManagement.File.FileIO

参数：

示例：

let filePath = pathDir + "/test.txt";
fileio.lstat(filePath, function (err, stat) {
    // do something
});

fileio.lstatSync⁷⁺

lstatSync(path: string): Stat

以同步方法获取链接信息。

系统能力：SystemCapability.FileManagement.File.FileIO

参数：

返回值：

示例：

let filePath = pathDir + "/test.txt";
let stat = fileio.lstatSync(filePath);

fileio.rename⁷⁺

rename(oldPath: string, newPath: string): Promise<void>

重命名文件，使用Promise异步回调。

系统能力：SystemCapability.FileManagement.File.FileIO

参数：

返回值：

示例：

let srcFile = pathDir + "/test.txt";
let dstFile = pathDir + '/new.txt';
fileio.rename(srcFile, dstFile).then(function() {
    console.info("rename succeed");
}).catch(function(err){
    console.info("rename failed with error:"+ err);
});

fileio.rename⁷⁺

rename(oldPath: string, newPath: string, callback: AsyncCallback<void>): void

重命名文件，使用callback异步回调。

系统能力：SystemCapability.FileManagement.File.FileIO

参数：

示例：

let srcFile = pathDir + "/test.txt";
let dstFile = pathDir + '/new.txt';
fileio.rename(srcFile, dstFile, function(err){
});

fileio.renameSync⁷⁺

renameSync(oldPath: string, newPath: string): void

以同步方法重命名文件。

系统能力：SystemCapability.FileManagement.File.FileIO

参数：

示例：

let srcFile = pathDir + "/test.txt";
let dstFile = pathDir + '/new.txt';
fileio.renameSync(srcFile, dstFile);

fileio.fsync⁷⁺

fsync(fd: number): Promise<void>

同步文件数据，使用Promise异步回调。

系统能力：SystemCapability.FileManagement.File.FileIO

参数：

返回值：

示例：

let filePath = pathDir + "/test.txt";
let fd = fileio.openSync(filePath);
fileio.fsync(fd).then(function(){
    console.info("sync data succeed");
}).catch(function(err){
    console.info("sync data failed with error:"+ err);
});

fileio.fsync⁷⁺

fsync(fd: number, callback: AsyncCallback<void>): void

同步文件数据，使用callback异步回调。

系统能力：SystemCapability.FileManagement.File.FileIO

参数：

示例：

let filePath = pathDir + "/test.txt";
let fd = fileio.openSync(filePath);
fileio.fsync(fd, function(err){
    // do something
});

fileio.fsyncSync⁷⁺

fsyncSync(fd: number): void

以同步方法同步文件数据。

系统能力：SystemCapability.FileManagement.File.FileIO

参数：

示例：

let filePath = pathDir + "/test.txt";
let fd = fileio.openSync(filePath);
fileio.fsyncSync(fd);

fileio.fdatasync⁷⁺

fdatasync(fd: number): Promise<void>

实现文件内容数据同步，使用Promise异步回调。

系统能力：SystemCapability.FileManagement.File.FileIO

参数：

返回值：

示例：

let filePath = pathDir + "/test.txt";
let fd = fileio.openSync(filePath);
fileio.fdatasync(fd).then(function(err) {
    console.info("sync data succeed");
}).catch(function(err){
    console.info("sync data failed with error:"+ err);
});

fileio.fdatasync⁷⁺

fdatasync(fd: number, callback: AsyncCallback<void>): void

实现文件内容数据同步，使用callback异步回调。

系统能力：SystemCapability.FileManagement.File.FileIO

参数：

示例：

let filePath = pathDir + "/test.txt";
let fd = fileio.openSync(filePath);
fileio.fdatasync (fd, function (err) {
    // do something
});

fileio.fdatasyncSync⁷⁺

fdatasyncSync(fd: number): void

以同步方法实现文件内容数据同步。

系统能力：SystemCapability.FileManagement.File.FileIO

参数：

示例：

let filePath = pathDir + "/test.txt";
let fd = fileio.openSync(filePath);
let stat = fileio.fdatasyncSync(fd);

fileio.symlink⁷⁺

symlink(target: string, srcPath: string): Promise<void>

基于文件路径创建符号链接，使用Promise异步回调。

系统能力：SystemCapability.FileManagement.File.FileIO

参数：

返回值：

示例：

let srcFile = pathDir + "/test.txt";
let dstFile = pathDir + '/test';
fileio.symlink(srcFile, dstFile).then(function() {
    console.info("symlink succeed");
}).catch(function(err){
    console.info("symlink failed with error:"+ err);
});

fileio.symlink⁷⁺

symlink(target: string, srcPath: string, callback: AsyncCallback<void>): void

基于文件路径创建符号链接，使用callback异步回调。

系统能力：SystemCapability.FileManagement.File.FileIO

参数：

示例：

let srcFile = pathDir + "/test.txt";
let dstFile = pathDir + '/test';
fileio.symlink(srcFile, dstFile, function (err) {
    // do something
});

fileio.symlinkSync⁷⁺

symlinkSync(target: string, srcPath: string): void

以同步的方法基于文件路径创建符号链接。

系统能力：SystemCapability.FileManagement.File.FileIO

参数：

示例：

let srcFile = pathDir + "/test.txt";
let dstFile = pathDir + '/test';
fileio.symlinkSync(srcFile, dstFile);

fileio.chown⁷⁺

chown(path: string, uid: number, gid: number): Promise<void>

基于文件路径改变文件所有者，使用Promise异步回调。

系统能力：SystemCapability.FileManagement.File.FileIO

参数：

返回值：

示例：

let filePath = pathDir + "/test.txt";
let stat = fileio.statSync(filePath);
fileio.chown(filePath, stat.uid, stat.gid).then(function(){
    console.info("chown succeed");
}).catch(function(err){
    console.info("chown failed with error:"+ err);
});

fileio.chown⁷⁺

chown(path: string, uid: number, gid: number, callback: AsyncCallback<void>): void

基于文件路径改变文件所有者，使用callback异步回调。

系统能力：SystemCapability.FileManagement.File.FileIO

参数：

示例：

let filePath = pathDir + "/test.txt";
let stat = fileio.statSync(filePath)
fileio.chown(filePath, stat.uid, stat.gid, function (err){
    // do something
});

fileio.chownSync⁷⁺

chownSync(path: string, uid: number, gid: number): void

以同步的方法基于文件路径改变文件所有者。

系统能力：SystemCapability.FileManagement.File.FileIO

参数：

示例：

let filePath = pathDir + "/test.txt";
let stat = fileio.statSync(filePath)
fileio.chownSync(filePath, stat.uid, stat.gid);

fileio.mkdtemp⁷⁺

mkdtemp(prefix: string): Promise<string>

创建临时目录，使用Promise异步回调。

系统能力：SystemCapability.FileManagement.File.FileIO

参数：

返回值：

示例：

fileio.mkdtemp(pathDir + "/XXXXXX").then(function(pathDir){
    console.info("mkdtemp succeed:"+ pathDir);
}).catch(function(err){
    console.info("mkdtemp failed with error:"+ err);
});

fileio.mkdtemp⁷⁺

mkdtemp(prefix: string, callback: AsyncCallback<string>): void

创建临时目录，使用callback异步回调。

系统能力：SystemCapability.FileManagement.File.FileIO

参数：

示例：

fileio.mkdtemp(pathDir + "/XXXXXX", function (err, res) {
    // do something
});

fileio.mkdtempSync⁷⁺

mkdtempSync(prefix: string): string

以同步的方法创建临时目录。

系统能力：SystemCapability.FileManagement.File.FileIO

参数：

返回值：

示例：

let res = fileio.mkdtempSync(pathDir + "/XXXXXX");

fileio.fchmod⁷⁺

fchmod(fd: number, mode: number): Promise<void>

基于文件描述符改变文件权限，使用Promise异步回调。

系统能力：SystemCapability.FileManagement.File.FileIO

参数：

返回值：

示例：

let filePath = pathDir + "/test.txt";
let fd = fileio.openSync(filePath);
let mode = 0o700;
fileio.fchmod(fd, mode).then(function() {
    console.info("chmod succeed");
}).catch(function(err){
    console.info("chmod failed with error:"+ err);
});

fileio.fchmod⁷⁺

fchmod(fd: number, mode: number, callback: AsyncCallback<void>): void

基于文件描述符改变文件权限，使用callback异步回调。

系统能力：SystemCapability.FileManagement.File.FileIO

参数：

示例：

let filePath = pathDir + "/test.txt";
let fd = fileio.openSync(filePath);
let mode = 0o700;
fileio.fchmod(fd, mode, function (err) {
    // do something
});

fileio.fchmodSync⁷⁺

fchmodSync(fd: number, mode: number): void

以同步方法基于文件描述符改变文件权限。

系统能力：SystemCapability.FileManagement.File.FileIO

参数：

示例：

let filePath = pathDir + "/test.txt";
let fd = fileio.openSync(filePath);
let mode = 0o700;
 fileio.fchmodSync(fd, mode);

fileio.createStream⁷⁺

createStream(path: string, mode: string): Promise<Stream>

基于文件路径打开文件流，使用Promise异步回调。

系统能力：SystemCapability.FileManagement.File.FileIO

参数：

返回值：

示例：

let filePath = pathDir + "/test.txt";
fileio.createStream(filePath, "r+").then(function(stream){
    console.info("createStream succeed");
}).catch(function(err){
    console.info("createStream failed with error:"+ err);
});

fileio.createStream⁷⁺

createStream(path: string, mode: string, callback: AsyncCallback<Stream>): void

基于文件路径打开文件流，使用callback异步回调。

系统能力：SystemCapability.FileManagement.File.FileIO

参数：

示例：

let filePath = pathDir + "/test.txt";
fileio.createStream(filePath, "r+", function(err, stream){
    // do something
});

fileio.createStreamSync⁷⁺

createStreamSync(path: string, mode: string): Stream

以同步方法基于文件路径打开文件流。

系统能力：SystemCapability.FileManagement.File.FileIO

参数：

返回值：

示例：

let filePath = pathDir + "/test.txt";
let ss = fileio.createStreamSync(filePath, "r+");

文章转载自：​​https://developer.harmonyos.com/cn/docs/documentation/doc-references-V3/js-apis-fileio-0000001478181641-V3?catalogVersion=V3#ZH-CN_TOPIC_0000001478181641__fileiocreatestreamsync7​​