@ohos.file.fs (文件管理)

该模块为基础文件操作API，提供基础文件操作能力，包括文件基本管理、文件目录管理、文件信息统计、文件流式读写等常用功能。

说明：

本模块首批接口从API version 9开始支持。后续版本的新增接口，采用上角标单独标记接口的起始版本。

导入模块

import fs from '@ohos.file.fs';

使用说明

使用该功能模块对文件/目录进行操作前，需要先获取其应用沙箱路径，获取方式及其接口用法请参考：

Stage模型

import UIAbility from '@ohos.app.ability.UIAbility';

export default class EntryAbility extends UIAbility {
   onWindowStageCreate(windowStage) {
       let context = this.context;
       let pathDir = context.filesDir;
   }
}

FA模型

import featureAbility from '@ohos.ability.featureAbility';

let context = featureAbility.getContext();
context.getFilesDir().then((data) => {
     let pathDir = data;
})

FA模型context的具体获取方法参见FA模型。

fs.stat

stat(file: string|number): Promise<Stat>

获取文件详细属性信息，使用Promise异步回调。

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

参数：

返回值：

错误码：

接口抛出错误码的详细介绍请参见基础文件IO错误码。

示例：

let filePath = pathDir + "/test.txt";
fs.stat(filePath).then((stat) => {
    console.info("get file info succeed, the size of file is " + stat.size);
}).catch((err) => {
    console.info("get file info failed with error message: " + err.message + ", error code: " + err.code);
});

fs.stat

stat(file: string|number, callback: AsyncCallback<Stat>): void

获取文件详细属性信息，使用callback异步回调。

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

参数：

错误码：

接口抛出错误码的详细介绍请参见基础文件IO错误码。

示例：

fs.stat(pathDir, (err, stat) => {
  if (err) {
    console.info("get file info failed with error message: " + err.message + ", error code: " + err.code);
  } else {
    console.info("get file info succeed, the size of file is " + stat.size);
  }
});

fs.statSync

statSync(file: string|number): Stat

以同步方法获取文件详细属性信息。

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

参数：

返回值：

错误码：

接口抛出错误码的详细介绍请参见基础文件IO错误码。

示例：

let stat = fs.statSync(pathDir);
console.info("get file info succeed, the size of file is " + stat.size);

fs.access

access(path: string): Promise<boolean>

检查文件是否存在，使用Promise异步回调。

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

参数：

返回值：

错误码：

接口抛出错误码的详细介绍请参见基础文件IO错误码。

示例：

let filePath = pathDir + "/test.txt";
fs.access(filePath).then((res) => {
  if (res) {
    console.info("file exists");
  }
}).catch((err) => {
  console.info("access failed with error message: " + err.message + ", error code: " + err.code);
});

fs.access

access(path: string, callback: AsyncCallback<boolean>): void

检查文件是否存在，使用callback异步回调。

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

参数：

错误码：

接口抛出错误码的详细介绍请参见基础文件IO错误码。

示例：

let filePath = pathDir + "/test.txt";
fs.access(filePath, (err, res) => {
  if (err) {
    console.info("access failed with error message: " + err.message + ", error code: " + err.code);
  } else {
    if (res) {
      console.info("file exists");
    }
  }
});

fs.accessSync

accessSync(path: string): boolean

以同步方法检查文件是否存在。

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

参数：

返回值：

错误码：

接口抛出错误码的详细介绍请参见基础文件IO错误码。

示例：

let filePath = pathDir + "/test.txt";
try {
    let res = fs.accessSync(filePath);
    if (res) {
      console.info("file exists");
    }
} catch(err) {
    console.info("accessSync failed with error message: " + err.message + ", error code: " + err.code);
}

fs.close

close(file: File|number): Promise<void>

关闭文件，使用Promise异步回调。

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

参数：

返回值：

错误码：

接口抛出错误码的详细介绍请参见基础文件IO错误码。

示例：

let filePath = pathDir + "/test.txt";
let file = fs.openSync(filePath);
fs.close(file).then(() => {
    console.info("close file succeed");
    fs.closeSync(file);
}).catch((err) => {
    console.info("close file failed with error message: " + err.message + ", error code: " + err.code);
});

fs.close

close(file: File|number, callback: AsyncCallback<void>): void

关闭文件，使用callback异步回调。

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

参数：

错误码：

接口抛出错误码的详细介绍请参见基础文件IO错误码。

示例：

let filePath = pathDir + "/test.txt";
let file = fs.openSync(filePath);
fs.close(file, (err) => {
  if (err) {
    console.info("close file failed with error message: " + err.message + ", error code: " + err.code);
  } else {
    console.info("close file success");
  }
});

fs.closeSync

closeSync(file: File|number): void

以同步方法关闭文件。

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

参数：

错误码：

接口抛出错误码的详细介绍请参见基础文件IO错误码。

示例：

let filePath = pathDir + "/test.txt";
let file = fs.openSync(filePath);
fs.closeSync(file);

fs.copyFile

copyFile(src: string|number, dest: string|number, mode?: number): Promise<void>

复制文件，使用Promise异步回调。

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

参数：

返回值：

错误码：

接口抛出错误码的详细介绍请参见基础文件IO错误码。

示例：

let srcPath = pathDir + "/srcDir/test.txt";
let dstPath = pathDir + "/dstDir/test.txt";
fs.copyFile(srcPath, dstPath).then(() => {
    console.info("copy file succeed");
}).catch((err) => {
    console.info("copy file failed with error message: " + err.message + ", error code: " + err.code);
});

fs.copyFile

copyFile(src: string|number, dest: string|number, mode?: number, callback: AsyncCallback<void>): void

复制文件，使用callback异步回调。

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

参数：

错误码：

接口抛出错误码的详细介绍请参见基础文件IO错误码。

示例：

let srcPath = pathDir + "/srcDir/test.txt";
let dstPath = pathDir + "/dstDir/test.txt";
fs.copyFile(srcPath, dstPath, (err) => {
  if (err) {
    console.info("copy file failed with error message: " + err.message + ", error code: " + err.code);
  } else {
    console.info("copy file success");
  }
});

fs.copyFileSync

copyFileSync(src: string|number, dest: string|number, mode?: number): void

以同步方法复制文件。

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

参数：

错误码：

接口抛出错误码的详细介绍请参见基础文件IO错误码。

示例：

let srcPath = pathDir + "/srcDir/test.txt";
let dstPath = pathDir + "/dstDir/test.txt";
fs.copyFileSync(srcPath, dstPath);

fs.mkdir

mkdir(path: string): Promise<void>

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

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

参数：

返回值：

错误码：

接口抛出错误码的详细介绍请参见基础文件IO错误码。

示例：

let dirPath = pathDir + "/testDir";
fs.mkdir(dirPath).then(() => {
    console.info("mkdir succeed");
}).catch((err) => {
    console.info("mkdir failed with error message: " + err.message + ", error code: " + err.code);
});

fs.mkdir

mkdir(path: string, callback: AsyncCallback<void>): void

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

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

参数：

错误码：

接口抛出错误码的详细介绍请参见基础文件IO错误码。

示例：

let dirPath = pathDir + "/testDir";
fs.mkdir(dirPath, (err) => {
  if (err) {
    console.info("mkdir failed with error message: " + err.message + ", error code: " + err.code);
  } else {
    console.info("mkdir success");
  }
});

fs.mkdirSync

mkdirSync(path: string): void

以同步方法创建目录。

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

参数：

错误码：

接口抛出错误码的详细介绍请参见基础文件IO错误码。

示例：

let dirPath = pathDir + "/testDir";
fs.mkdirSync(dirPath);

fs.open

open(path: string, mode?: number): Promise<File>

打开文件，使用Promise异步回调。支持使用URI打开文件。

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

参数：

返回值：

错误码：

接口抛出错误码的详细介绍请参见基础文件IO错误码。

示例：

let filePath = pathDir + "/test.txt";
fs.open(filePath, fs.OpenMode.READ_WRITE | fs.OpenMode.CREATE).then((file) => {
    console.info("file fd: " + file.fd);
}).catch((err) => {
    console.info("open file failed with error message: " + err.message + ", error code: " + err.code);
});

fs.open

open(path: string, mode?: number, callback: AsyncCallback<File>): void

打开文件，使用callback异步回调。支持使用URI打开文件。

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

参数：

错误码：

接口抛出错误码的详细介绍请参见基础文件IO错误码。

示例：

let filePath = pathDir + "/test.txt";
fs.open(filePath, fs.OpenMode.READ_WRITE | fs.OpenMode.CREATE, (err, file) => {
  if (err) {
    console.info("mkdir failed with error message: " + err.message + ", error code: " + err.code);
  } else {
    console.info("file fd: " + file.fd);
  }
});

fs.openSync

openSync(path: string, mode?: number): File

以同步方法打开文件。支持使用URI打开文件。

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

参数：

返回值：

错误码：

接口抛出错误码的详细介绍请参见基础文件IO错误码。

示例：

let filePath = pathDir + "/test.txt";
let file = fs.openSync(filePath, fs.OpenMode.READ_WRITE | fs.OpenMode.CREATE);
console.info("file fd: " + file.fd);
fs.closeSync(file);

fs.read

read(fd: number, buffer: ArrayBuffer, options?: { offset?: number; length?: number; }): Promise<number>

从文件读取数据，使用Promise异步回调。

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

参数：

返回值：

错误码：

接口抛出错误码的详细介绍请参见基础文件IO错误码。

示例：

let filePath = pathDir + "/test.txt";
let file = fs.openSync(filePath, fs.OpenMode.READ_WRITE);
let buf = new ArrayBuffer(4096);
fs.read(file.fd, buf).then((readLen) => {
    console.info("read file data succeed");
    console.info(String.fromCharCode.apply(null, new Uint8Array(buf.slice(0, readLen))));
    fs.closeSync(file);
}).catch((err) => {
    console.info("read file data failed with error message: " + err.message + ", error code: " + err.code);
});

fs.read

read(fd: number, buffer: ArrayBuffer, options?: { offset?: number; length?: number; }, callback: AsyncCallback<number>): void

从文件读取数据，使用callback异步回调。

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

参数：

错误码：

接口抛出错误码的详细介绍请参见基础文件IO错误码。

示例：

let filePath = pathDir + "/test.txt";
let file = fs.openSync(filePath, fs.OpenMode.READ_WRITE);
let buf = new ArrayBuffer(4096);
fs.read(file.fd, buf, (err, readLen) => {
  if (err) {
    console.info("mkdir failed with error message: " + err.message + ", error code: " + err.code);
  } else {
    console.info("read file data succeed");
    console.info(String.fromCharCode.apply(null, new Uint8Array(buf.slice(0, readLen))));
    fs.closeSync(file);
  }
});

fs.readSync

readSync(fd: number, buffer: ArrayBuffer, options?: { offset?: number; length?: number; }): number

以同步方法从文件读取数据。

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

参数：

返回值：

错误码：

接口抛出错误码的详细介绍请参见基础文件IO错误码。

示例：

let filePath = pathDir + "/test.txt";
let file = fs.openSync(filePath, fs.OpenMode.READ_WRITE);
let buf = new ArrayBuffer(4096);
let num = fs.readSync(file.fd, buf);
fs.closeSync(file);

fs.rmdir

rmdir(path: string): Promise<void>

删除整个目录，使用Promise异步回调。

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

参数：

返回值：

错误码：

接口抛出错误码的详细介绍请参见基础文件IO错误码。

示例：

let dirPath = pathDir + "/testDir";
fs.rmdir(dirPath).then(() => {
    console.info("rmdir succeed");
}).catch((err) => {
    console.info("rmdir failed with error message: " + err.message + ", error code: " + err.code);
});

fs.rmdir

rmdir(path: string, callback: AsyncCallback<void>): void

删除整个目录，使用callback异步回调。

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

参数：

错误码：

接口抛出错误码的详细介绍请参见基础文件IO错误码。

示例：

let dirPath = pathDir + "/testDir";
fs.rmdir(dirPath, (err) => {
  if (err) {
    console.info("rmdir failed with error message: " + err.message + ", error code: " + err.code);
  } else {
    console.info("rmdir succeed");
  }
});

fs.rmdirSync

rmdirSync(path: string): void

以同步方法删除目录。

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

参数：

错误码：

接口抛出错误码的详细介绍请参见基础文件IO错误码。

示例：

let dirPath = pathDir + "/testDir";
fs.rmdirSync(dirPath);

fs.unlink

unlink(path: string): Promise<void>

删除单个文件，使用Promise异步回调。

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

参数：

返回值：

错误码：

接口抛出错误码的详细介绍请参见基础文件IO错误码。

示例：

let filePath = pathDir + "/test.txt";
fs.unlink(filePath).then(() => {
    console.info("remove file succeed");
}).catch((err) => {
    console.info("remove file failed with error message: " + err.message + ", error code: " + err.codeor);
});

fs.unlink

unlink(path: string, callback: AsyncCallback<void>): void

删除文件，使用callback异步回调。

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

参数：

错误码：

接口抛出错误码的详细介绍请参见基础文件IO错误码。

示例：

let filePath = pathDir + "/test.txt";
fs.unlink(filePath, (err) => {
  if (err) {
    console.info("remove file failed with error message: " + err.message + ", error code: " + err.code);
  } else {
    console.info("remove file succeed");
  }
});

fs.unlinkSync

unlinkSync(path: string): void

以同步方法删除文件。

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

参数：

错误码：

接口抛出错误码的详细介绍请参见基础文件IO错误码。

示例：

let filePath = pathDir + "/test.txt";
fs.unlinkSync(filePath);

fs.write

write(fd: number, buffer: ArrayBuffer|string, options?: { offset?: number; length?: number; encoding?: string; }): Promise<number>

将数据写入文件，使用Promise异步回调。

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

参数：

返回值：

错误码：

接口抛出错误码的详细介绍请参见基础文件IO错误码。

示例：

let filePath = pathDir + "/test.txt";
let file = fs.openSync(filePath, fs.OpenMode.READ_WRITE | fs.OpenMode.CREATE);
fs.write(file.fd, "hello, world").then((writeLen) => {
  console.info("write data to file succeed and size is:" + writeLen);
  fs.closeSync(file);
}).catch((err) => {
  console.info("write data to file failed with error message: " + err.message + ", error code: " + err.code);
});

fs.write

write(fd: number, buffer: ArrayBuffer|string, options?: { offset?: number; length?: number; encoding?: string; }, callback: AsyncCallback<number>): void

将数据写入文件，使用callback异步回调。

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

参数：

错误码：

接口抛出错误码的详细介绍请参见基础文件IO错误码。

示例：

let filePath = pathDir + "/test.txt";
let file = fs.openSync(filePath, fs.OpenMode.READ_WRITE | fs.OpenMode.CREATE);
fs.write(file.fd, "hello, world", (err, writeLen) => {
  if (err) {
    console.info("write failed with error message: " + err.message + ", error code: " + err.code);
  } else {
    console.info("write data to file succeed and size is:" + writeLen);
    fs.closeSync(file);
  }
});

fs.writeSync

writeSync(fd: number, buffer: ArrayBuffer|string, options?: { offset?: number; length?: number; encoding?: string; }): number

以同步方法将数据写入文件。

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

参数：

返回值：

错误码：

接口抛出错误码的详细介绍请参见基础文件IO错误码。

示例：

let filePath = pathDir + "/test.txt";
let file = fs.openSync(filePath, fs.OpenMode.READ_WRITE | fs.OpenMode.CREATE);
let writeLen = fs.writeSync(file.fd, "hello, world");
console.info("write data to file succeed and size is:" + writeLen);
fs.closeSync(file);

fs.truncate

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

截断文件，使用Promise异步回调。

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

参数：

返回值：

错误码：

接口抛出错误码的详细介绍请参见基础文件IO错误码。

示例：

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

fs.truncate

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

截断文件，使用callback异步回调。

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

参数：

错误码：

接口抛出错误码的详细介绍请参见基础文件IO错误码。

示例：

let filePath = pathDir + "/test.txt";
let len = 5;
fs.truncate(filePath, len, (err) => {
  if (err) {
    console.info("truncate failed with error message: " + err.message + ", error code: " + err.code);
  } else {
    console.info("truncate success");
  }
});

fs.truncateSync

truncateSync(file: string|number, len?: number): void

以同步方法截断文件。

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

参数：

错误码：

接口抛出错误码的详细介绍请参见基础文件IO错误码。

示例：

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

fs.readText

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

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

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

参数：

返回值：

错误码：

接口抛出错误码的详细介绍请参见基础文件IO错误码。

示例：

let filePath = pathDir + "/test.txt";
fs.readText(filePath).then((str) => {
    console.info("readText succeed:" + str);
}).catch((err) => {
    console.info("readText failed with error message: " + err.message + ", error code: " + err.code);
});

fs.readText

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

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

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

参数：

错误码：

接口抛出错误码的详细介绍请参见基础文件IO错误码。

示例：

let filePath = pathDir + "/test.txt";
fs.readText(filePath, { offset: 1, encoding: 'UTF-8' }, (err, str) => {
  if (err) {
    console.info("read text failed with error message: " + err.message + ", error code: " + err.code);
  } else {
    console.info("readText succeed:" + str);
  }
});

fs.readTextSync

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

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

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

参数：

返回值：

错误码：

接口抛出错误码的详细介绍请参见基础文件IO错误码。

示例：

let filePath = pathDir + "/test.txt";
let str = fs.readTextSync(filePath, {offset: 1, length: 3});
console.info("readText succeed:" + str);

fs.lstat

lstat(path: string): Promise<Stat>

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

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

参数：

返回值：

错误码：

接口抛出错误码的详细介绍请参见基础文件IO错误码。

示例：

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

fs.lstat

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

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

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

参数：

错误码：

接口抛出错误码的详细介绍请参见基础文件IO错误码。

示例：

let filePath = pathDir + "/test.txt";
fs.lstat(filePath, (err, stat) => {
    if (err) {
      console.info("lstat failed with error message: " + err.message + ", error code: " + err.code);
    } else {
      console.info("get link status succeed, the size of file is" + stat.size);
    }
});

fs.lstatSync

lstatSync(path: string): Stat

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

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

参数：

返回值：

错误码：

接口抛出错误码的详细介绍请参见基础文件IO错误码。

示例：

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

fs.rename

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

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

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

参数：

返回值：

错误码：

接口抛出错误码的详细介绍请参见基础文件IO错误码。

示例：

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

fs.rename

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

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

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

参数：

错误码：

接口抛出错误码的详细介绍请参见基础文件IO错误码。

示例：

let srcFile = pathDir + "/test.txt";
let dstFile = pathDir + "/new.txt";
fs.rename(srcFile, dstFile, (err) => {
  if (err) {
    console.info("rename failed with error message: " + err.message + ", error code: " + err.code);
  } else {
    console.info("rename success");
  }
});

fs.renameSync

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

以同步方法重命名文件或文件夹。

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

参数：

错误码：

接口抛出错误码的详细介绍请参见基础文件IO错误码。

示例：

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

fs.fsync

fsync(fd: number): Promise<void>

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

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

参数：

返回值：

错误码：

接口抛出错误码的详细介绍请参见基础文件IO错误码。

示例：

let filePath = pathDir + "/test.txt";
let file = fs.openSync(filePath);
fs.fsync(file.fd).then(() => {
    console.info("sync data succeed");
}).catch((err) => {
    console.info("sync data failed with error message: " + err.message + ", error code: " + err.code);
});

fs.fsync

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

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

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

参数：

错误码：

接口抛出错误码的详细介绍请参见基础文件IO错误码。

示例：

let filePath = pathDir + "/test.txt";
let file = fs.openSync(filePath);
fs.fsync(file.fd, (err) => {
  if (err) {
    console.info("fsync failed with error message: " + err.message + ", error code: " + err.code);
  } else {
    console.info("fsync success");
    fs.closeSync(file);
  }
});

fs.fsyncSync

fsyncSync(fd: number): void

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

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

参数：

错误码：

接口抛出错误码的详细介绍请参见基础文件IO错误码。

示例：

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

fs.fdatasync

fdatasync(fd: number): Promise<void>

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

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

参数：

返回值：

错误码：

接口抛出错误码的详细介绍请参见基础文件IO错误码。

示例：

let filePath = pathDir + "/test.txt";
let file = fs.openSync(filePath);
fs.fdatasync(file.fd).then((err) => {
  console.info("sync data succeed");
  fs.closeSync(file);
}).catch((err) => {
  console.info("sync data failed with error message: " + err.message + ", error code: " + err.code);
});

fs.fdatasync

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

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

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

参数：

错误码：

接口抛出错误码的详细介绍请参见基础文件IO错误码。

示例：

let filePath = pathDir + "/test.txt";
let file = fs.openSync(filePath);
fs.fdatasync (file.fd, (err) => {
  if (err) {
    console.info("fdatasync failed with error message: " + err.message + ", error code: " + err.code);
  } else {
    console.info("fdatasync success");
    fs.closeSync(file);
  }
});

fs.fdatasyncSync

fdatasyncSync(fd: number): void

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

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

参数：

错误码：

接口抛出错误码的详细介绍请参见基础文件IO错误码。

示例：

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

fs.symlink

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

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

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

参数：

返回值：

错误码：

接口抛出错误码的详细介绍请参见基础文件IO错误码。

示例：

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

fs.symlink

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

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

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

参数：

错误码：

接口抛出错误码的详细介绍请参见基础文件IO错误码。

示例：

let srcFile = pathDir + "/test.txt";
let dstFile = pathDir + "/test";
fs.symlink(srcFile, dstFile, (err) => {
  if (err) {
    console.info("symlink failed with error message: " + err.message + ", error code: " + err.code);
  } else {
    console.info("symlink success");
  }
});

fs.symlinkSync

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

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

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

参数：

错误码：

接口抛出错误码的详细介绍请参见基础文件IO错误码。

示例：

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

fs.listFile

listFile(path: string, options?: { recursion?: boolean; listNum?: number; filter?: Filter; }): Promise<string[]>

列出文件夹下所有文件名，支持递归列出所有文件名（包含子目录下），支持文件过滤，使用Promise异步回调。

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

参数：

options参数说明：

返回值：

错误码：

接口抛出错误码的详细介绍请参见基础文件IO错误码。

示例：

let options = {
  "recursion": false,
  "listNum": 0,
  "filter": {
    "suffix": [".png", ".jpg", ".jpeg"],
    "displayName": ["%abc", "efg%"],
    "fileSizeOver": 1024,
    "lastModifiedAfter": new Date().getTime(),
  }
};
fs.listFile(pathDir, options).then((filenames) => {
  console.info("listFile succeed");
  for (let i = 0; i < filenames.length; i++) {
    console.info("fileName: %s", filenames[i]);
  }
}).catch((err) => {
    console.info("list file failed with error message: " + err.message + ", error code: " + err.code);
});

fs.listFile

listFile(path: string, options?: { recursion?: boolean; listNum?: number; filter?: Filter; }, callback: AsyncCallback<string[]>): void

列出文件夹下所有文件名，支持递归列出所有文件名（包含子目录下），支持文件过滤，使用Callback异步回调。

参数：

options参数说明：

错误码：

接口抛出错误码的详细介绍请参见基础文件IO错误码。

示例：

let options = {
  "recursion": false,
  "listNum": 0,
  "filter": {
    "suffix": [".png", ".jpg", ".jpeg"],
    "displayName": ["%abc", "efg%"],
    "fileSizeOver": 1024,
    "lastModifiedAfter": new Date().getTime(),
  }
};
fs.listFile(pathDir, options, (err, filenames) => {
  if (err) {
    console.info("list file failed with error message: " + err.message + ", error code: " + err.code);
  } else {
    console.info("listFile succeed");
    for (let i = 0; i < filenames.length; i++) {
      console.info("filename: %s", filenames[i]);
    }
  }
});

fs.listFileSync

listFileSync(path: string, options?: { recursion?: boolean; listNum?: number; filter?: Filter; }): string[]

以同步方式列出文件夹下所有文件名，支持递归列出所有文件名（包含子目录下），支持文件过滤。

参数：

options参数说明：

返回值：

错误码：

接口抛出错误码的详细介绍请参见基础文件IO错误码。

示例：

let options = {
  "recursion": false,
  "listNum": 0,
  "filter": {
    "suffix": [".png", ".jpg", ".jpeg"],
    "displayName": ["%abc", "efg%"],
    "fileSizeOver": 1024,
    "lastModifiedAfter": new Date().getTime(),
  }
};
let filenames = fs.listFileSync(pathDir, options);
console.info("listFile succeed");
for (let i = 0; i < filenames.length; i++) {
  console.info("filename: %s", filenames[i]);
}

fs.moveFile

moveFile(src: string, dest: string, mode?: number): Promise<void>

移动文件，使用Promise异步回调。

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

参数：

返回值：

错误码：

接口抛出错误码的详细介绍请参见基础文件IO错误码。

示例：

let srcPath = pathDir + "/source.txt";
let destPath = pathDir + "/dest.txt";
fs.moveFile(srcPath, destPath, 0).then(() => {
    console.info("move file succeed");
}).catch((err) => {
    console.info("move file failed with error message: " + err.message + ", error code: " + err.code);
});

fs.moveFile

moveFile(src: string, dest: string, mode?: number, callback: AsyncCallback<void>): void

移动文件，使用Callback异步回调。

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

参数：

错误码：

接口抛出错误码的详细介绍请参见基础文件IO错误码。

示例：

let srcPath = pathDir + "/source.txt";
let destPath = pathDir + "/dest.txt";
fs.moveFile(srcPath, destPath, 0, (err) => {
  if (err) {
    console.info("move file failed with error message: " + err.message + ", error code: " + err.code);
  } else {
    console.info("move file succeed");
  }  
});

fs.moveFileSync

moveFile(src: string, dest: string, mode?: number): void

以同步方式移动文件。

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

参数：

错误码：

接口抛出错误码的详细介绍请参见基础文件IO错误码。

示例：

let srcPath = pathDir + "/source.txt";
let destPath = pathDir + "/dest.txt";
fs.moveFileSync(srcPath, destPath, 0);
console.info("move file succeed");

fs.mkdtemp

mkdtemp(prefix: string): Promise<string>

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

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

参数：

返回值：

错误码：

接口抛出错误码的详细介绍请参见基础文件IO错误码。

示例：

fs.mkdtemp(pathDir + "/XXXXXX").then((pathDir) => {
    console.info("mkdtemp succeed:" + pathDir);
}).catch((err) => {
    console.info("mkdtemp failed with error message: " + err.message + ", error code: " + err.code);
});

fs.mkdtemp

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

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

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

参数：

错误码：

接口抛出错误码的详细介绍请参见基础文件IO错误码。

示例：

fs.mkdtemp(pathDir + "/XXXXXX", (err, res) => {
  if (err) {
    console.info("mkdtemp failed with error message: " + err.message + ", error code: " + err.code);
  } else {
    console.info("mkdtemp success");
  }
});

fs.mkdtempSync

mkdtempSync(prefix: string): string

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

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

参数：

返回值：

错误码：

接口抛出错误码的详细介绍请参见基础文件IO错误码。

示例：

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

fs.createStream

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

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

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

参数：

返回值：

错误码：

接口抛出错误码的详细介绍请参见基础文件IO错误码。

示例：

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

fs.createStream

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

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

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

参数：

错误码：

接口抛出错误码的详细介绍请参见基础文件IO错误码。

示例：

let filePath = pathDir + "/test.txt";
fs.createStream(filePath, "r+", (err, stream) => {
  if (err) {
    console.info("create stream failed with error message: " + err.message + ", error code: " + err.code);
  } else {
    console.info("create stream success");
  }
});

fs.createStreamSync

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

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

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

参数：

返回值：

错误码：

接口抛出错误码的详细介绍请参见基础文件IO错误码。

示例：

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

fs.fdopenStream

fdopenStream(fd: number, mode: string): Promise<Stream>

基于文件描述符打开文件流，使用Promise异步回调。

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

参数：

返回值：

错误码：

接口抛出错误码的详细介绍请参见基础文件IO错误码。

示例：

let filePath = pathDir + "/test.txt";
let file = fs.openSync(filePath);
fs.fdopenStream(file.fd, "r+").then((stream) => {
    console.info("openStream succeed");
    fs.closeSync(file);
}).catch((err) => {
    console.info("openStream failed with error message: " + err.message + ", error code: " + err.code);
});

fs.fdopenStream

fdopenStream(fd: number, mode: string, callback: AsyncCallback<Stream>): void

基于文件描述符打开文件流，使用callback异步回调。

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

参数：

错误码：

接口抛出错误码的详细介绍请参见基础文件IO错误码。

示例：

let filePath = pathDir + "/test.txt";
let file = fs.openSync(filePath, fs.OpenMode.READ_ONLY);
fs.fdopenStream(file.fd, "r+", (err, stream) => {
  if (err) {
    console.info("fdopen stream failed with error message: " + err.message + ", error code: " + err.code);
  } else {
    console.info("fdopen stream success");
    fs.closeSync(file);
  }
});

fs.fdopenStreamSync

fdopenStreamSync(fd: number, mode: string): Stream

以同步方法基于文件描述符打开文件流。

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

参数：

返回值：

错误码：

接口抛出错误码的详细介绍请参见基础文件IO错误码。

示例：

let filePath = pathDir + "/test.txt";
let file = fs.openSync(filePath, fs.OpenMode.READ_ONLY | fs.OpenMode.CREATE);
let ss = fs.fdopenStreamSync(file.fd, "r+");
fs.closeSync(file);

Stat

文件具体信息，在调用Stat的方法前，需要先通过stat()方法（同步或异步）来构建一个Stat实例。

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

属性

isBlockDevice

isBlockDevice(): boolean

用于判断文件是否是块特殊文件。一个块特殊文件只能以块为粒度进行访问，且访问的时候带缓存。

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

返回值：

错误码：

接口抛出错误码的详细介绍请参见基础文件IO错误码。

示例：

let filePath = pathDir + "/test.txt";
let isBLockDevice = fs.statSync(filePath).isBlockDevice();

isCharacterDevice

isCharacterDevice(): boolean

用于判断文件是否是字符特殊文件。一个字符特殊设备可进行随机访问，且访问的时候不带缓存。

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

返回值：

错误码：

接口抛出错误码的详细介绍请参见基础文件IO错误码。

示例：

let filePath = pathDir + "/test.txt";
let isCharacterDevice = fs.statSync(filePath).isCharacterDevice();

isDirectory

isDirectory(): boolean

用于判断文件是否是目录。

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

返回值：

错误码：

接口抛出错误码的详细介绍请参见基础文件IO错误码。

示例：

let dirPath = pathDir + "/test";
let isDirectory = fs.statSync(dirPath).isDirectory(); 

isFIFO

isFIFO(): boolean

用于判断文件是否是命名管道（有时也称为FIFO）。命名管道通常用于进程间通信。

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

返回值：

错误码：

接口抛出错误码的详细介绍请参见基础文件IO错误码。

示例：

let filePath = pathDir + "/test.txt";
let isFIFO = fs.statSync(filePath).isFIFO(); 

isFile

isFile(): boolean

用于判断文件是否是普通文件。

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

返回值：

错误码：

接口抛出错误码的详细介绍请参见基础文件IO错误码。

示例：

let filePath = pathDir + "/test.txt";
let isFile = fs.statSync(filePath).isFile();

isSocket

isSocket(): boolean

用于判断文件是否是套接字。

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

返回值：

错误码：

接口抛出错误码的详细介绍请参见基础文件IO错误码。

示例：

let filePath = pathDir + "/test.txt";
let isSocket = fs.statSync(filePath).isSocket(); 

isSymbolicLink

isSymbolicLink(): boolean

用于判断文件是否是符号链接。

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

返回值：

错误码：

接口抛出错误码的详细介绍请参见基础文件IO错误码。

示例：

let filePath = pathDir + "/test";
let isSymbolicLink = fs.statSync(filePath).isSymbolicLink(); 

Stream

文件流，在调用Stream的方法前，需要先通过createStream()方法（同步或异步）来构建一个Stream实例。

close

close(): Promise<void>

关闭文件流，使用Promise异步回调。

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

返回值：

错误码：

接口抛出错误码的详细介绍请参见基础文件IO错误码。

示例：

let filePath = pathDir + "/test.txt";
let ss= fs.createStreamSync(filePath, "r+");
ss.close().then(() => {
    console.info("close fileStream succeed");
}).catch((err) => {
    console.info("close fileStream  failed with error message: " + err.message + ", error code: " + err.code);
});

close

close(callback: AsyncCallback<void>): void

异步关闭文件流，使用callback异步回调。

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

参数：

错误码：

接口抛出错误码的详细介绍请参见基础文件IO错误码。

示例：

let filePath = pathDir + "/test.txt";
let ss= fs.createStreamSync(filePath, "r+");
ss.close((err) => {
  if (err) {
    console.info("close stream failed with error message: " + err.message + ", error code: " + err.code);
  } else {
    console.info("close stream success"):
  }
});

closeSync

closeSync(): void

同步关闭文件流。

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

错误码：

接口抛出错误码的详细介绍请参见基础文件IO错误码。

示例：

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

flush

flush(): Promise<void>

刷新文件流，使用Promise异步回调。

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

返回值：

错误码：

接口抛出错误码的详细介绍请参见基础文件IO错误码。

示例：

let filePath = pathDir + "/test.txt";
let ss= fs.createStreamSync(filePath, "r+");
ss.flush().then(() => {
    console.info("flush succeed");
}).catch((err) => {
    console.info("flush failed with error message: " + err.message + ", error code: " + err.code);
});

flush

flush(callback: AsyncCallback<void>): void

异步刷新文件流，使用callback异步回调。

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

参数：

错误码：

接口抛出错误码的详细介绍请参见基础文件IO错误码。

示例：

let filePath = pathDir + "/test.txt";
let ss= fs.createStreamSync(filePath, "r+");
ss.flush((err) => {
  if (err) {
    console.info("flush stream failed with error message: " + err.message + ", error code: " + err.code);
  } else {
    console.info("flush success");
  }
});

flushSync

flushSync(): void

同步刷新文件流。

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

错误码：

接口抛出错误码的详细介绍请参见基础文件IO错误码。

示例：

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

write

write(buffer: ArrayBuffer|string, options?: { offset?: number; length?: number; encoding?: string; }): Promise<number>

将数据写入流文件，使用Promise异步回调。

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

参数：

返回值：

错误码：

接口抛出错误码的详细介绍请参见基础文件IO错误码。

示例：

let filePath = pathDir + "/test.txt";
let ss= fs.createStreamSync(filePath, "r+");
ss.write("hello, world",{ offset: 5, length: 5, encoding: 'utf-8' }).then((number) => {
    console.info("write succeed and size is:" + number);
}).catch((err) => {
    console.info("write failed with error message: " + err.message + ", error code: " + err.code);
});

write

write(buffer: ArrayBuffer|string, options?: { offset?: number; length?: number; encoding?: string; }, callback: AsyncCallback<number>): void

将数据写入流文件，使用callback异步回调。

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

参数：

错误码：

接口抛出错误码的详细介绍请参见基础文件IO错误码。

示例：

let filePath = pathDir + "/test.txt";
let ss= fs.createStreamSync(filePath, "r+");
ss.write("hello, world", { offset: 5, length: 5, encoding :'utf-8'}, (err, bytesWritten) => {
  if (err) {
    console.info("write stream failed with error message: " + err.message + ", error code: " + err.code);
  } else {
    if (bytesWritten) {
      console.info("write succeed and size is:" + bytesWritten);
    }
  }
});

writeSync

writeSync(buffer: ArrayBuffer|string, options?: { offset?: number; length?: number; encoding?: string; }): number

以同步方法将数据写入流文件。

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

参数：

返回值：

错误码：

接口抛出错误码的详细介绍请参见基础文件IO错误码。

示例：

let filePath = pathDir + "/test.txt";
let ss= fs.createStreamSync(filePath,"r+");
let num = ss.writeSync("hello, world", {offset: 5, length: 5, encoding :'utf-8'});

read

read(buffer: ArrayBuffer, options?: { offset?: number; length?: number; }): Promise<number>

从流文件读取数据，使用Promise异步回调。

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

参数：

返回值：

错误码：

接口抛出错误码的详细介绍请参见基础文件IO错误码。

示例：

let filePath = pathDir + "/test.txt";
let ss = fs.createStreamSync(filePath, "r+");
let buf = new ArrayBuffer(4096);
ss.read(buf, {offset: 5, length: 5}).then((readLen) => {
  console.info("read data succeed");
  console.log(String.fromCharCode.apply(null, new Uint8Array(buf.slice(0, readLen))));
}).catch((err) => {
    console.info("read data failed with error message: " + err.message + ", error code: " + err.code);
});

read

read(buffer: ArrayBuffer, options?: { position?: number; offset?: number; length?: number; }, callback: AsyncCallback<number>): void

从流文件读取数据，使用callback异步回调。

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

参数：

错误码：

接口抛出错误码的详细介绍请参见基础文件IO错误码。

示例：

let filePath = pathDir + "/test.txt";
let ss = fs.createStreamSync(filePath, "r+");
let buf = new ArrayBuffer(4096)
ss.read(buf, {offset: 5, length: 5}, (err, readLen) => {
  if (err) {
    console.info("read stream failed with error message: " + err.message + ", error code: " + err.code);
  } else {
    console.info("read data succeed");
    console.log(String.fromCharCode.apply(null, new Uint8Array(buf.slice(0, readLen))));
  }
});

readSync

readSync(buffer: ArrayBuffer, options?: { offset?: number; length?: number; }): number

以同步方法从流文件读取数据。

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

参数：

返回值：

错误码：

接口抛出错误码的详细介绍请参见基础文件IO错误码。

示例：

let filePath = pathDir + "/test.txt";
let ss = fs.createStreamSync(filePath, "r+");
let num = ss.readSync(new ArrayBuffer(4096), {offset: 5, length: 5});

File

由open接口打开的File对象。

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

属性

lock

lock(exclusive?: boolean): Promise<void>

文件阻塞式施加共享锁或独占锁，使用Promise异步回调。

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

参数：

返回值：

错误码：

接口抛出错误码的详细介绍请参见基础文件IO错误码。

示例：

let file = fs.openSync(path, fs.OpenMode.READ_WRITE | fs.OpenMode.CREATE);
file.lock(true).then(() => {
  console.log("lock file successful");
}).catch((err) => {
    console.info("lock file failed with error message: " + err.message + ", error code: " + err.code);
});

lock

lock(exclusive?: boolean, callback: AsyncCallback<void>): void

文件阻塞式施加共享锁或独占锁，使Callback异步回调。

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

参数：

错误码：

接口抛出错误码的详细介绍请参见基础文件IO错误码。

示例：

let file = fs.openSync(path, fs.OpenMode.READ_WRITE | fs.OpenMode.CREATE);
file.lock(true, (err) => {
  if (err) {
    console.info("lock file failed with error message: " + err.message + ", error code: " + err.code);
  } else {
    console.log("lock file successful");
  }
});

tryLock

tryLock(exclusive?: boolean): void

文件非阻塞式施加共享锁或独占锁。

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

参数：

错误码：

接口抛出错误码的详细介绍请参见基础文件IO错误码。

示例：

let file = fs.openSync(path, fs.OpenMode.READ_WRITE | fs.OpenMode.CREATE);
file.tryLock(true);
console.log("lock file successful");

unlock

unlock(): void

以同步方式给文件解锁。

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

错误码：

接口抛出错误码的详细介绍请参见基础文件IO错误码。

示例：

let file = fs.openSync(path, fs.OpenMode.READ_WRITE | fs.OpenMode.CREATE);
file.tryLock(true);
file.unlock();
console.log("unlock file successful");

OpenMode

open接口flags参数常量。文件打开标签。

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

Filter

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

文件过滤配置项类型，支持listFile接口使用。