文件管理

導入模塊

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異步回調(diào)。

系統(tǒng)能力：SystemCapability.FileManagement.File.FileIO

參數(shù)：

返回值：

錯誤碼：

接口拋出錯誤碼的詳細介紹請參見基礎文件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.error("get file info failed with error message: " + err.message + ", error code: " + err.code);
});

fs.stat

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

獲取文件詳細屬性信息，使用callback異步回調(diào)。

系統(tǒng)能力：SystemCapability.FileManagement.File.FileIO

參數(shù)：

錯誤碼：

接口拋出錯誤碼的詳細介紹請參見基礎文件IO錯誤碼。

示例：

fs.stat(pathDir, (err, stat) => {
  if (err) {
    console.error("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

以同步方法獲取文件詳細屬性信息。

系統(tǒng)能力：SystemCapability.FileManagement.File.FileIO

參數(shù)：

返回值：

錯誤碼：

接口拋出錯誤碼的詳細介紹請參見基礎文件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異步回調(diào)。

系統(tǒng)能力：SystemCapability.FileManagement.File.FileIO

參數(shù)：

返回值：

錯誤碼：

接口拋出錯誤碼的詳細介紹請參見基礎文件IO錯誤碼。

示例：

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

fs.access

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

檢查文件是否存在，使用callback異步回調(diào)。

系統(tǒng)能力：SystemCapability.FileManagement.File.FileIO

參數(shù)：

錯誤碼：

接口拋出錯誤碼的詳細介紹請參見基礎文件IO錯誤碼。

示例：

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

fs.accessSync

accessSync(path: string): boolean

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

系統(tǒng)能力：SystemCapability.FileManagement.File.FileIO

參數(shù)：

返回值：

錯誤碼：

接口拋出錯誤碼的詳細介紹請參見基礎文件IO錯誤碼。

示例：

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

fs.close

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

關閉文件，使用Promise異步回調(diào)。

系統(tǒng)能力：SystemCapability.FileManagement.File.FileIO

參數(shù)：

返回值：

錯誤碼：

接口拋出錯誤碼的詳細介紹請參見基礎文件IO錯誤碼。

示例：

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

fs.close

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

關閉文件，使用callback異步回調(diào)。

系統(tǒng)能力：SystemCapability.FileManagement.File.FileIO

參數(shù)：

錯誤碼：

接口拋出錯誤碼的詳細介紹請參見基礎文件IO錯誤碼。

示例：

let filePath = pathDir + "/test.txt";
let file = fs.openSync(filePath);
fs.close(file, (err) => {
  if (err) {
    console.error("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

以同步方法關閉文件。

系統(tǒng)能力：SystemCapability.FileManagement.File.FileIO

參數(shù)：

錯誤碼：

接口拋出錯誤碼的詳細介紹請參見基礎文件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異步回調(diào)。

系統(tǒng)能力：SystemCapability.FileManagement.File.FileIO

參數(shù)：

返回值：

錯誤碼：

接口拋出錯誤碼的詳細介紹請參見基礎文件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.error("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異步回調(diào)。

系統(tǒng)能力：SystemCapability.FileManagement.File.FileIO

參數(shù)：

錯誤碼：

接口拋出錯誤碼的詳細介紹請參見基礎文件IO錯誤碼。

示例：

let srcPath = pathDir + "/srcDir/test.txt";
let dstPath = pathDir + "/dstDir/test.txt";
fs.copyFile(srcPath, dstPath, (err) => {
  if (err) {
    console.error("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

以同步方法復制文件。

系統(tǒng)能力：SystemCapability.FileManagement.File.FileIO

參數(shù)：

錯誤碼：

接口拋出錯誤碼的詳細介紹請參見基礎文件IO錯誤碼。

示例：

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

fs.mkdir

mkdir(path: string): Promise<void>

創(chuàng)建目錄，使用Promise異步回調(diào)。

系統(tǒng)能力：SystemCapability.FileManagement.File.FileIO

參數(shù)：

返回值：

錯誤碼：

接口拋出錯誤碼的詳細介紹請參見基礎文件IO錯誤碼。

示例：

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

fs.mkdir

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

創(chuàng)建目錄，使用callback異步回調(diào)。

系統(tǒng)能力：SystemCapability.FileManagement.File.FileIO

參數(shù)：

錯誤碼：

接口拋出錯誤碼的詳細介紹請參見基礎文件IO錯誤碼。

示例：

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

fs.mkdirSync

mkdirSync(path: string): void

以同步方法創(chuàng)建目錄。

系統(tǒng)能力：SystemCapability.FileManagement.File.FileIO

參數(shù)：

錯誤碼：

接口拋出錯誤碼的詳細介紹請參見基礎文件IO錯誤碼。

示例：

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

fs.open

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

打開文件，使用Promise異步回調(diào)。支持使用URI打開文件。

系統(tǒng)能力：SystemCapability.FileManagement.File.FileIO

參數(shù)：

返回值：

錯誤碼：

接口拋出錯誤碼的詳細介紹請參見基礎文件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.error("open file failed with error message: " + err.message + ", error code: " + err.code);
});

fs.open

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

打開文件，使用callback異步回調(diào)。支持使用URI打開文件。

系統(tǒng)能力：SystemCapability.FileManagement.File.FileIO

參數(shù)：

錯誤碼：

接口拋出錯誤碼的詳細介紹請參見基礎文件IO錯誤碼。

示例：

let filePath = pathDir + "/test.txt";
fs.open(filePath, fs.OpenMode.READ_WRITE | fs.OpenMode.CREATE, (err, file) => {
  if (err) {
    console.error("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打開文件。

系統(tǒng)能力：SystemCapability.FileManagement.File.FileIO

參數(shù)：

返回值：

錯誤碼：

接口拋出錯誤碼的詳細介紹請參見基礎文件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>

從文件讀取數(shù)據(jù)，使用Promise異步回調(diào)。

系統(tǒng)能力：SystemCapability.FileManagement.File.FileIO

參數(shù)：

返回值：

錯誤碼：

接口拋出錯誤碼的詳細介紹請參見基礎文件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.error("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

從文件讀取數(shù)據(jù)，使用callback異步回調(diào)。

系統(tǒng)能力：SystemCapability.FileManagement.File.FileIO

參數(shù)：

錯誤碼：

接口拋出錯誤碼的詳細介紹請參見基礎文件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.error("read 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

以同步方法從文件讀取數(shù)據(jù)。

系統(tǒng)能力：SystemCapability.FileManagement.File.FileIO

參數(shù)：

返回值：

錯誤碼：

接口拋出錯誤碼的詳細介紹請參見基礎文件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異步回調(diào)。

系統(tǒng)能力：SystemCapability.FileManagement.File.FileIO

參數(shù)：

返回值：

錯誤碼：

接口拋出錯誤碼的詳細介紹請參見基礎文件IO錯誤碼。

示例：

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

fs.rmdir

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

刪除整個目錄，使用callback異步回調(diào)。

系統(tǒng)能力：SystemCapability.FileManagement.File.FileIO

參數(shù)：

錯誤碼：

接口拋出錯誤碼的詳細介紹請參見基礎文件IO錯誤碼。

示例：

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

fs.rmdirSync

rmdirSync(path: string): void

以同步方法刪除目錄。

系統(tǒng)能力：SystemCapability.FileManagement.File.FileIO

參數(shù)：

錯誤碼：

接口拋出錯誤碼的詳細介紹請參見基礎文件IO錯誤碼。

示例：

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

fs.unlink

unlink(path: string): Promise<void>

刪除單個文件，使用Promise異步回調(diào)。

系統(tǒng)能力：SystemCapability.FileManagement.File.FileIO

參數(shù)：

返回值：

錯誤碼：

接口拋出錯誤碼的詳細介紹請參見基礎文件IO錯誤碼。

示例：

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

fs.unlink

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

刪除文件，使用callback異步回調(diào)。

系統(tǒng)能力：SystemCapability.FileManagement.File.FileIO

參數(shù)：

錯誤碼：

接口拋出錯誤碼的詳細介紹請參見基礎文件IO錯誤碼。

示例：

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

fs.unlinkSync

unlinkSync(path: string): void

以同步方法刪除文件。

系統(tǒng)能力：SystemCapability.FileManagement.File.FileIO

參數(shù)：

錯誤碼：

接口拋出錯誤碼的詳細介紹請參見基礎文件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>

將數(shù)據(jù)寫入文件，使用Promise異步回調(diào)。

系統(tǒng)能力：SystemCapability.FileManagement.File.FileIO

參數(shù)：

返回值：

錯誤碼：

接口拋出錯誤碼的詳細介紹請參見基礎文件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.error("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

將數(shù)據(jù)寫入文件，使用callback異步回調(diào)。

系統(tǒng)能力：SystemCapability.FileManagement.File.FileIO

參數(shù)：

錯誤碼：

接口拋出錯誤碼的詳細介紹請參見基礎文件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.error("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

以同步方法將數(shù)據(jù)寫入文件。

系統(tǒng)能力：SystemCapability.FileManagement.File.FileIO

參數(shù)：

返回值：

錯誤碼：

接口拋出錯誤碼的詳細介紹請參見基礎文件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異步回調(diào)。

系統(tǒng)能力：SystemCapability.FileManagement.File.FileIO

參數(shù)：

返回值：

錯誤碼：

接口拋出錯誤碼的詳細介紹請參見基礎文件IO錯誤碼。

示例：

let filePath = pathDir + "/test.txt";
let len = 5;
fs.truncate(filePath, len).then(() => {
    console.info("truncate file succeed");
}).catch((err) => {
    console.error("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異步回調(diào)。

系統(tǒng)能力：SystemCapability.FileManagement.File.FileIO

參數(shù)：

錯誤碼：

接口拋出錯誤碼的詳細介紹請參見基礎文件IO錯誤碼。

示例：

let filePath = pathDir + "/test.txt";
let len = 5;
fs.truncate(filePath, len, (err) => {
  if (err) {
    console.error("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

以同步方法截斷文件。

系統(tǒng)能力：SystemCapability.FileManagement.File.FileIO

參數(shù)：

錯誤碼：

接口拋出錯誤碼的詳細介紹請參見基礎文件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>

基于文本方式讀取文件（即直接讀取文件的文本內(nèi)容），使用Promise異步回調(diào)。

系統(tǒng)能力：SystemCapability.FileManagement.File.FileIO

參數(shù)：

返回值：

錯誤碼：

接口拋出錯誤碼的詳細介紹請參見基礎文件IO錯誤碼。

示例：

let filePath = pathDir + "/test.txt";
fs.readText(filePath).then((str) => {
    console.info("readText succeed:" + str);
}).catch((err) => {
    console.error("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

基于文本方式讀取文件（即直接讀取文件的文本內(nèi)容），使用callback異步回調(diào)。

系統(tǒng)能力：SystemCapability.FileManagement.File.FileIO

參數(shù)：

錯誤碼：

接口拋出錯誤碼的詳細介紹請參見基礎文件IO錯誤碼。

示例：

let filePath = pathDir + "/test.txt";
fs.readText(filePath, { offset: 1, encoding: 'utf-8' }, (err, str) => {
  if (err) {
    console.error("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

以同步方法基于文本方式讀取文件（即直接讀取文件的文本內(nèi)容）。

系統(tǒng)能力：SystemCapability.FileManagement.File.FileIO

參數(shù)：

返回值：

錯誤碼：

接口拋出錯誤碼的詳細介紹請參見基礎文件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異步回調(diào)。

系統(tǒng)能力：SystemCapability.FileManagement.File.FileIO

參數(shù)：

返回值：

錯誤碼：

接口拋出錯誤碼的詳細介紹請參見基礎文件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.error("get link status failed with error message: " + err.message + ", error code: " + err.code);
});

fs.lstat

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

獲取鏈接文件信息，使用callback異步回調(diào)。

系統(tǒng)能力：SystemCapability.FileManagement.File.FileIO

參數(shù)：

錯誤碼：

接口拋出錯誤碼的詳細介紹請參見基礎文件IO錯誤碼。

示例：

let filePath = pathDir + "/test.txt";
fs.lstat(filePath, (err, stat) => {
    if (err) {
      console.error("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

以同步方法獲取鏈接文件信息。

系統(tǒng)能力：SystemCapability.FileManagement.File.FileIO

參數(shù)：

返回值：

錯誤碼：

接口拋出錯誤碼的詳細介紹請參見基礎文件IO錯誤碼。

示例：

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

fs.rename

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

重命名文件或文件夾，使用Promise異步回調(diào)。

系統(tǒng)能力：SystemCapability.FileManagement.File.FileIO

參數(shù)：

返回值：

錯誤碼：

接口拋出錯誤碼的詳細介紹請參見基礎文件IO錯誤碼。

示例：

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

fs.rename

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

重命名文件或文件夾，使用callback異步回調(diào)。

系統(tǒng)能力：SystemCapability.FileManagement.File.FileIO

參數(shù)：

錯誤碼：

接口拋出錯誤碼的詳細介紹請參見基礎文件IO錯誤碼。

示例：

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

fs.renameSync

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

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

系統(tǒng)能力：SystemCapability.FileManagement.File.FileIO

參數(shù)：

錯誤碼：

接口拋出錯誤碼的詳細介紹請參見基礎文件IO錯誤碼。

示例：

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

fs.fsync

fsync(fd: number): Promise<void>

同步文件數(shù)據(jù)，使用Promise異步回調(diào)。

系統(tǒng)能力：SystemCapability.FileManagement.File.FileIO

參數(shù)：

返回值：

錯誤碼：

接口拋出錯誤碼的詳細介紹請參見基礎文件IO錯誤碼。

示例：

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

fs.fsync

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

同步文件數(shù)據(jù)，使用callback異步回調(diào)。

系統(tǒng)能力：SystemCapability.FileManagement.File.FileIO

參數(shù)：

錯誤碼：

接口拋出錯誤碼的詳細介紹請參見基礎文件IO錯誤碼。

示例：

let filePath = pathDir + "/test.txt";
let file = fs.openSync(filePath);
fs.fsync(file.fd, (err) => {
  if (err) {
    console.error("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

以同步方法同步文件數(shù)據(jù)。

系統(tǒng)能力：SystemCapability.FileManagement.File.FileIO

參數(shù)：

錯誤碼：

接口拋出錯誤碼的詳細介紹請參見基礎文件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>

實現(xiàn)文件內(nèi)容數(shù)據(jù)同步，使用Promise異步回調(diào)。

系統(tǒng)能力：SystemCapability.FileManagement.File.FileIO

參數(shù)：

返回值：

錯誤碼：

接口拋出錯誤碼的詳細介紹請參見基礎文件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.error("sync data failed with error message: " + err.message + ", error code: " + err.code);
});

fs.fdatasync

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

實現(xiàn)文件內(nèi)容數(shù)據(jù)同步，使用callback異步回調(diào)。

系統(tǒng)能力：SystemCapability.FileManagement.File.FileIO

參數(shù)：

錯誤碼：

接口拋出錯誤碼的詳細介紹請參見基礎文件IO錯誤碼。

示例：

let filePath = pathDir + "/test.txt";
let file = fs.openSync(filePath);
fs.fdatasync (file.fd, (err) => {
  if (err) {
    console.error("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

以同步方法實現(xiàn)文件內(nèi)容數(shù)據(jù)同步。

系統(tǒng)能力：SystemCapability.FileManagement.File.FileIO

參數(shù)：

錯誤碼：

接口拋出錯誤碼的詳細介紹請參見基礎文件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>

基于文件路徑創(chuàng)建符號鏈接，使用Promise異步回調(diào)。

系統(tǒng)能力：SystemCapability.FileManagement.File.FileIO

參數(shù)：

返回值：

錯誤碼：

接口拋出錯誤碼的詳細介紹請參見基礎文件IO錯誤碼。

示例：

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

fs.symlink

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

基于文件路徑創(chuàng)建符號鏈接，使用callback異步回調(diào)。

系統(tǒng)能力：SystemCapability.FileManagement.File.FileIO

參數(shù)：

錯誤碼：

接口拋出錯誤碼的詳細介紹請參見基礎文件IO錯誤碼。

示例：

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

fs.symlinkSync

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

以同步的方法基于文件路徑創(chuàng)建符號鏈接。

系統(tǒng)能力：SystemCapability.FileManagement.File.FileIO

參數(shù)：

錯誤碼：

接口拋出錯誤碼的詳細介紹請參見基礎文件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異步回調(diào)。

系統(tǒng)能力：SystemCapability.FileManagement.File.FileIO

參數(shù)：

options參數(shù)說明：

返回值：

錯誤碼：

接口拋出錯誤碼的詳細介紹請參見基礎文件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.error("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異步回調(diào)。

參數(shù)：

options參數(shù)說明：

錯誤碼：

接口拋出錯誤碼的詳細介紹請參見基礎文件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.error("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[];

以同步方式列出文件夾下所有文件名，支持遞歸列出所有文件名（包含子目錄下），支持文件過濾。

參數(shù)：

options參數(shù)說明：

返回值：

錯誤碼：

接口拋出錯誤碼的詳細介紹請參見基礎文件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異步回調(diào)。

系統(tǒng)能力：SystemCapability.FileManagement.File.FileIO

參數(shù)：

錯誤碼：

接口拋出錯誤碼的詳細介紹請參見基礎文件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.error("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異步回調(diào)。

系統(tǒng)能力：SystemCapability.FileManagement.File.FileIO

參數(shù)：

錯誤碼：

接口拋出錯誤碼的詳細介紹請參見基礎文件IO錯誤碼。

示例：

let srcPath = pathDir + "/source.txt";
let destPath = pathDir + "/dest.txt";
fs.moveFile(srcPath, destPath, 0, (err) => {
  if (err) {
    console.error("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;

以同步方式移動文件。

系統(tǒng)能力：SystemCapability.FileManagement.File.FileIO

參數(shù)：

錯誤碼：

接口拋出錯誤碼的詳細介紹請參見基礎文件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>

創(chuàng)建臨時目錄，使用Promise異步回調(diào)。

系統(tǒng)能力：SystemCapability.FileManagement.File.FileIO

參數(shù)：

返回值：

錯誤碼：

接口拋出錯誤碼的詳細介紹請參見基礎文件IO錯誤碼。

示例：

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

fs.mkdtemp

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

創(chuàng)建臨時目錄，使用callback異步回調(diào)。

系統(tǒng)能力：SystemCapability.FileManagement.File.FileIO

參數(shù)：

錯誤碼：

接口拋出錯誤碼的詳細介紹請參見基礎文件IO錯誤碼。

示例：

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

fs.mkdtempSync

mkdtempSync(prefix: string): string

以同步的方法創(chuàng)建臨時目錄。

系統(tǒng)能力：SystemCapability.FileManagement.File.FileIO

參數(shù)：

返回值：

錯誤碼：

接口拋出錯誤碼的詳細介紹請參見基礎文件IO錯誤碼。

示例：

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

fs.createStream

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

基于文件路徑打開文件流，使用Promise異步回調(diào)。

系統(tǒng)能力：SystemCapability.FileManagement.File.FileIO

參數(shù)：

返回值：

錯誤碼：

接口拋出錯誤碼的詳細介紹請參見基礎文件IO錯誤碼。

示例：

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

fs.createStream

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

基于文件路徑打開文件流，使用callback異步回調(diào)。

系統(tǒng)能力：SystemCapability.FileManagement.File.FileIO

參數(shù)：

錯誤碼：

接口拋出錯誤碼的詳細介紹請參見基礎文件IO錯誤碼。

示例：

let filePath = pathDir + "/test.txt";
fs.createStream(filePath, "r+", (err, stream) => {
  if (err) {
    console.error("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

以同步方法基于文件路徑打開文件流。

系統(tǒng)能力：SystemCapability.FileManagement.File.FileIO

參數(shù)：

返回值：

錯誤碼：

接口拋出錯誤碼的詳細介紹請參見基礎文件IO錯誤碼。

示例：

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

fs.fdopenStream

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

基于文件描述符打開文件流，使用Promise異步回調(diào)。

系統(tǒng)能力：SystemCapability.FileManagement.File.FileIO

參數(shù)：

返回值：

錯誤碼：

接口拋出錯誤碼的詳細介紹請參見基礎文件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.error("openStream failed with error message: " + err.message + ", error code: " + err.code);
});

fs.fdopenStream

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

基于文件描述符打開文件流，使用callback異步回調(diào)。

系統(tǒng)能力：SystemCapability.FileManagement.File.FileIO

參數(shù)：

錯誤碼：

接口拋出錯誤碼的詳細介紹請參見基礎文件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.error("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

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

系統(tǒng)能力：SystemCapability.FileManagement.File.FileIO

參數(shù)：

返回值：

錯誤碼：

接口拋出錯誤碼的詳細介紹請參見基礎文件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

文件具體信息，在調(diào)用Stat的方法前，需要先通過stat()方法（同步或異步）來構(gòu)建一個Stat實例。

系統(tǒng)能力：以下各項對應的系統(tǒng)能力均為SystemCapability.FileManagement.File.FileIO。

屬性

isBlockDevice

isBlockDevice(): boolean

用于判斷文件是否是塊特殊文件。一個塊特殊文件只能以塊為粒度進行訪問，且訪問的時候帶緩存。

系統(tǒng)能力：SystemCapability.FileManagement.File.FileIO

返回值：

錯誤碼：

接口拋出錯誤碼的詳細介紹請參見基礎文件IO錯誤碼。

示例：

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

isCharacterDevice

isCharacterDevice(): boolean

用于判斷文件是否是字符特殊文件。一個字符特殊設備可進行隨機訪問，且訪問的時候不帶緩存。

系統(tǒng)能力：SystemCapability.FileManagement.File.FileIO

返回值：

錯誤碼：

接口拋出錯誤碼的詳細介紹請參見基礎文件IO錯誤碼。

示例：

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

isDirectory

isDirectory(): boolean

用于判斷文件是否是目錄。

系統(tǒng)能力：SystemCapability.FileManagement.File.FileIO

返回值：

錯誤碼：

接口拋出錯誤碼的詳細介紹請參見基礎文件IO錯誤碼。

示例：

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

isFIFO

isFIFO(): boolean

用于判斷文件是否是命名管道（有時也稱為FIFO）。命名管道通常用于進程間通信。