@ohos.fileio (文件管理)

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

说明：

• 本模块首批接口从API version 6开始支持。后续版本的新增接口，采用上角标单独标记接口的起始版本。
• 本模块从API version 9开始废弃，建议使用@ohos.file.fs替代。

导入模块

import fileio from '@ohos.fileio';

使用说明

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

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

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

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

fileio.stat

stat(path: string): Promise<Stat>

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

说明：

从API version 9开始废弃，请使用fs.stat替代。

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

参数：

返回值：

示例：

import { BusinessError } from '@ohos.base';
let filePath = pathDir + "test.txt";
fileio.stat(filePath).then((stat: fileio.Stat) => {
  console.info("getFileInfo succeed, the size of file is " + stat.size);
}).catch((err: BusinessError) => {
  console.info("getFileInfo failed with error:" + err);
});

fileio.stat

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

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

说明：

从API version 9开始废弃，请使用fs.stat替代。

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

参数：

示例：

import { BusinessError } from '@ohos.base';
fileio.stat(pathDir, (err: BusinessError, stat: fileio.Stat) => {
  // example code in Stat
});

fileio.statSync

statSync(path: string): Stat

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

说明：

从API version 9开始废弃，请使用fs.statSync替代。

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

参数：

返回值：

示例：

let stat = fileio.statSync(pathDir);
// example code in Stat

fileio.opendir

opendir(path: string): Promise<Dir>

打开文件目录，使用Promise异步回调。

说明：

从API version 9开始废弃，请使用fs.listFile替代。

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

参数：

返回值：

示例：

import { BusinessError } from '@ohos.base';
let dirPath = pathDir + "/testDir";
fileio.opendir(dirPath).then((dir: fileio.Dir) => {
  console.info("opendir succeed");
}).catch((err: BusinessError) => {
  console.info("opendir failed with error:" + err);
});

fileio.opendir

opendir(path: string, callback: AsyncCallback<Dir>): void

打开文件目录，使用callback异步回调。

说明：

从API version 9开始废弃，请使用fs.listFile替代。

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

参数：

示例：

import { BusinessError } from '@ohos.base';
fileio.opendir(pathDir, (err: BusinessError, dir: fileio.Dir) => {
  // example code in Dir struct
  // use read/readSync/close
});

fileio.opendirSync

opendirSync(path: string): Dir

以同步方法打开文件目录。

说明：

从API version 9开始废弃，请使用fs.listFileSync替代。

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

参数：

返回值：

示例：

let dir = fileio.opendirSync(pathDir);
// example code in Dir struct
// use read/readSync/close

fileio.access

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

检查当前进程是否可访问某文件，使用Promise异步回调。

说明：

从API version 9开始废弃，请使用fs.access替代。

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

参数：

返回值：

示例：

import { BusinessError } from '@ohos.base';
let filePath = pathDir + "/test.txt";
fileio.access(filePath).then(() => {
  console.info("access succeed");
}).catch((err: BusinessError) => {
  console.info("access failed with error:" + err);
});

fileio.access

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

检查当前进程是否可访问某文件，使用callback异步回调。

说明：

从API version 9开始废弃，请使用fs.access替代。

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

参数：

示例：

import { BusinessError } from '@ohos.base';
let filePath = pathDir + "/test.txt";
fileio.access(filePath, (err: BusinessError) => {
  // do something
});

fileio.accessSync

accessSync(path: string, mode?: number): void

以同步方法检查当前进程是否可访问某文件。

说明：

从API version 9开始废弃，请使用fs.accessSync替代。

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

参数：

示例：

import { BusinessError } from '@ohos.base';
let filePath = pathDir + "/test.txt";
try {
  fileio.accessSync(filePath);
} catch(err: unknown) {
  console.info("accessSync failed with error:" + err);
}

fileio.close⁷⁺

close(fd: number): Promise<void>

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

说明：

从API version 9开始废弃，请使用fs.close替代。

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

参数：

返回值：

示例：

import { BusinessError } from '@ohos.base';
let filePath = pathDir + "/test.txt";
let fd = fileio.openSync(filePath);
fileio.close(fd).then(() => {
  console.info("close file succeed");
}).catch((err: BusinessError) => {
  console.info("close file failed with error:" + err);
});

fileio.close⁷⁺

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

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

说明：

从API version 9开始废弃，请使用fs.close替代。

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

参数：

示例：

import { BusinessError } from '@ohos.base';
let filePath = pathDir + "/test.txt";
let fd = fileio.openSync(filePath);
fileio.close(fd, (err: BusinessError) => {
  // do something
});

fileio.closeSync

closeSync(fd: number): void

以同步方法关闭文件。

说明：

从API version 9开始废弃，请使用fs.closeSync替代。

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

参数：

示例：

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

fileio.copyFile

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

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

说明：

从API version 9开始废弃，请使用fs.copyFile替代。

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

参数：

返回值：

示例：

import { BusinessError } from '@ohos.base';
let srcPath = pathDir + "srcDir/test.txt";
let dstPath = pathDir + "dstDir/test.txt";
fileio.copyFile(srcPath, dstPath).then(() => {
  console.info("copyFile succeed");
}).catch((err: BusinessError) => {
  console.info("copyFile failed with error:" + err);
});

fileio.copyFile

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

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

说明：

从API version 9开始废弃，请使用fs.copyFile替代。

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

参数：

示例：

import { BusinessError } from '@ohos.base';
let srcPath = pathDir + "srcDir/test.txt";
let dstPath = pathDir + "dstDir/test.txt";
fileio.copyFile(srcPath, dstPath, (err: BusinessError) => {
  // do something
});

fileio.copyFileSync

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

以同步方法复制文件。

说明：

从API version 9开始废弃，请使用fs.copyFileSync替代。

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

参数：

示例：

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

fileio.mkdir

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

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

说明：

从API version 9开始废弃，请使用fs.mkdir替代。

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

参数：

返回值：

示例：

import { BusinessError } from '@ohos.base';
let dirPath = pathDir + '/testDir';
fileio.mkdir(dirPath).then(() => {
  console.info("mkdir succeed");
}).catch((error: BusinessError) => {
  console.info("mkdir failed with error:" + error);
});

fileio.mkdir

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

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

说明：

从API version 9开始废弃，请使用fs.mkdir替代。

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

参数：

示例：

import { BusinessError } from '@ohos.base';
let dirPath = pathDir + '/testDir';
fileio.mkdir(dirPath, (err: BusinessError) => {
  console.info("mkdir succeed");
});

fileio.mkdirSync

mkdirSync(path: string, mode?: number): void

以同步方法创建目录。

说明：

从API version 9开始废弃，请使用fs.mkdirSync替代。

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

参数：

示例：

let dirPath = pathDir + '/testDir';
fileio.mkdirSync(dirPath);

fileio.open⁷⁺

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

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

说明：

从API version 9开始废弃，请使用fs.open替代。

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

参数：

返回值：

示例：

import { BusinessError } from '@ohos.base';
let filePath = pathDir + "/test.txt";
fileio.open(filePath, 0o1, 0o0200).then((number: number) => {
  console.info("open file succeed");
}).catch((err: BusinessError) => {
  console.info("open file failed with error:" + err);
});

fileio.open⁷⁺

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

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

说明：

从API version 9开始废弃，请使用fs.open替代。

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

参数：

示例：

import { BusinessError } from '@ohos.base';
let filePath = pathDir + "/test.txt";
fileio.open(filePath, 0, (err: BusinessError, fd: number) => {
  // do something
});

fileio.openSync

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

以同步方法打开文件。

说明：

从API version 9开始废弃，请使用fs.openSync替代。

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

参数：

返回值：

示例：

let filePath = pathDir + "/test.txt";
let fd = fileio.openSync(filePath, 0o102, 0o640);

let filePath = pathDir + "/test.txt";
let fd = fileio.openSync(filePath, 0o102, 0o666);
fileio.writeSync(fd, 'hello world');
let fd1 = fileio.openSync(filePath, 0o2002);
fileio.writeSync(fd1, 'hello world');
class Option {
  offset: number = 0;
  length: number = 4096;
  position: number = 0;
}
let option = new Option();
option.position = 0;
let buf = new ArrayBuffer(4096)
let num = fileio.readSync(fd1, buf, option);
console.info("num == " + num);

fileio.read

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

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

说明：

从API version 9开始废弃，请使用fs.read替代。

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

参数：

返回值：

示例：

import { BusinessError } from '@ohos.base';
import buffer from '@ohos.buffer';
import { ReadOut } from '@ohos.fileio';
let filePath = pathDir + "/test.txt";
let fd = fileio.openSync(filePath, 0o102, 0o640);
let arrayBuffer = new ArrayBuffer(4096);
fileio.read(fd, arrayBuffer).then((readResult: fileio.ReadOut) => {
  console.info("read file data succeed");
  let buf = buffer.from(arrayBuffer, 0, readResult.bytesRead);
  console.log(`The content of file: ${buf.toString()}`);
  fileio.closeSync(fd);
}).catch((err: BusinessError) => {
  console.info("read file data failed with error:" + err);
});

fileio.read

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

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

说明：

从API version 9开始废弃，请使用fs.read替代。

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

参数：

示例：

import { BusinessError } from '@ohos.base';
import buffer from '@ohos.buffer';
import { ReadOut } from '@ohos.fileio';
let filePath = pathDir + "/test.txt";
let fd = fileio.openSync(filePath, 0o102, 0o640);
let arrayBuffer = new ArrayBuffer(4096);
fileio.read(fd, arrayBuffer, (err: BusinessError, readResult: fileio.ReadOut) => {
  if (readResult) {
    console.info("read file data succeed");
    let buf = buffer.from(arrayBuffer, 0, readResult.bytesRead);
    console.info(`The content of file: ${buf.toString()}`);
  }
  fileio.closeSync(fd);
});

fileio.readSync

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

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

说明：

从API version 9开始废弃，请使用fs.readSync替代。

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

参数：

返回值：

示例：

let filePath = pathDir + "/test.txt";
let fd = fileio.openSync(filePath, 0o102, 0o640);
let buf = new ArrayBuffer(4096);
let num = fileio.readSync(fd, buf);

fileio.rmdir⁷⁺

rmdir(path: string): Promise<void>

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

说明：

从API version 9开始废弃，请使用fs.rmdir替代。

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

参数：

返回值：

示例：

import { BusinessError } from '@ohos.base';
let dirPath = pathDir + '/testDir';
fileio.rmdir(dirPath).then(() => {
  console.info("rmdir succeed");
}).catch((err: BusinessError) => {
  console.info("rmdir failed with error:" + err);
});

fileio.rmdir⁷⁺

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

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

说明：

从API version 9开始废弃，请使用fs.rmdir替代。

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

参数：

示例：

import { BusinessError } from '@ohos.base';
let dirPath = pathDir + '/testDir';
fileio.rmdir(dirPath, (err: BusinessError) => {
  // do something
  console.info("rmdir succeed");
});

fileio.rmdirSync⁷⁺

rmdirSync(path: string): void

以同步方法删除目录。

说明：

从API version 9开始废弃，请使用fs.rmdirSync替代。

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

参数：

示例：

let dirPath = pathDir + '/testDir';
fileio.rmdirSync(dirPath);

fileio.unlink

unlink(path: string): Promise<void>

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

说明：

从API version 9开始废弃，请使用fs.unlink替代。

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

参数：

返回值：

示例：

import { BusinessError } from '@ohos.base';
let filePath = pathDir + "/test.txt";
fileio.unlink(filePath).then(() => {
  console.info("remove file succeed");
}).catch((error: BusinessError) => {
  console.info("remove file failed with error:" + error);
});

fileio.unlink

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

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

说明：

从API version 9开始废弃，请使用fs.unlink替代。

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

参数：

示例：

import { BusinessError } from '@ohos.base';
let filePath = pathDir + "/test.txt";
fileio.unlink(filePath, (err: BusinessError) => {
  console.info("remove file succeed");
});

fileio.unlinkSync

unlinkSync(path: string): void

以同步方法删除文件。

说明：

从API version 9开始废弃，请使用fs.unlinkSync替代。

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

参数：

示例：

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

fileio.write

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

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

说明：

从API version 9开始废弃，请使用fs.write替代。

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

参数：

返回值：

示例：

import { BusinessError } from '@ohos.base';
let filePath = pathDir + "/test.txt";
let fd = fileio.openSync(filePath, 0o100 | 0o2, 0o666);
fileio.write(fd, "hello, world").then((number: number) => {
  console.info("write data to file succeed and size is:" + number);
}).catch((err: BusinessError) => {
  console.info("write data to file failed with error:" + err);
});

fileio.write

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

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

说明：

从API version 9开始废弃，请使用fs.write替代。

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

参数：

示例：

import { BusinessError } from '@ohos.base';
let filePath = pathDir + "/test.txt";
let fd = fileio.openSync(filePath, 0o100 | 0o2, 0o666);
fileio.write(fd, "hello, world", (err: BusinessError, bytesWritten: number) => {
  if (bytesWritten) {
    console.info("write data to file succeed and size is:" + bytesWritten);
  }
});

fileio.writeSync

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

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

说明：

从API version 9开始废弃，请使用fs.writeSync替代。

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

参数：

返回值：

示例：

let filePath = pathDir + "/test.txt";
let fd = fileio.openSync(filePath, 0o100 | 0o2, 0o666);
let num = fileio.writeSync(fd, "hello, world");

fileio.hash

hash(path: string, algorithm: string): Promise<string>

计算文件的哈希值，使用Promise异步回调。

说明：

从API version 9开始废弃，请使用hash.write替代。

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

参数：

返回值：

示例：

import { BusinessError } from '@ohos.base';
let filePath = pathDir + "/test.txt";
fileio.hash(filePath, "sha256").then((str: string) => {
  console.info("calculate file hash succeed:" + str);
}).catch((err: BusinessError) => {
  console.info("calculate file hash failed with error:" + err);
});

fileio.hash

hash(path: string, algorithm: string, callback: AsyncCallback<string>): void

计算文件的哈希值，使用callback异步回调。

说明：

从API version 9开始废弃，请使用hash.write替代。

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

参数：

示例：

import { BusinessError } from '@ohos.base';
let filePath = pathDir + "/test.txt";
fileio.hash(filePath, "sha256", (err: BusinessError, hashStr: string) => {
  if (hashStr) {
    console.info("calculate file hash succeed:" + hashStr);
  }
});

fileio.chmod⁷⁺

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

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

说明：

从API version 9开始废弃。

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

参数：

返回值：

示例：

import { BusinessError } from '@ohos.base';
let filePath = pathDir + "/test.txt";
fileio.chmod(filePath, 0o700).then(() => {
  console.info("chmod succeed");
}).catch((err: BusinessError) => {
  console.info("chmod failed with error:" + err);
});

fileio.chmod⁷⁺

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

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

说明：

从API version 9开始废弃。

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

参数：

示例：

import { BusinessError } from '@ohos.base';
let filePath = pathDir + "/test.txt";
fileio.chmod(filePath, 0o700, (err: BusinessError) => {
  // do something
});

fileio.chmodSync⁷⁺

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

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

说明：

从API version 9开始废弃。

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

参数：

示例：

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

fileio.fstat⁷⁺

fstat(fd: number): Promise<Stat>

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

说明：

从API version 9开始废弃，请使用fs.stat替代。

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

参数：

返回值：

示例：

import { BusinessError } from '@ohos.base';
let filePath = pathDir + "/test.txt";
let fd = fileio.openSync(filePath);
fileio.fstat(fd).then((stat: fileio.Stat) => {
  console.info("fstat succeed, the size of file is " + stat.size);
}).catch((err: BusinessError) => {
  console.info("fstat failed with error:" + err);
});

fileio.fstat⁷⁺

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

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

说明：

从API version 9开始废弃，请使用fs.stat替代。

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

参数：

示例：

import { BusinessError } from '@ohos.base';
let filePath = pathDir + "/test.txt";
let fd = fileio.openSync(filePath);
fileio.fstat(fd, (err: BusinessError) => {
  // do something
});

fileio.fstatSync⁷⁺

fstatSync(fd: number): Stat

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

说明：

从API version 9开始废弃，请使用fs.statSync替代。

系统能力：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异步回调。

说明：

从API version 9开始废弃，请使用fs.truncate替代。

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

参数：

返回值：

示例：

import { BusinessError } from '@ohos.base';
let filePath = pathDir + "/test.txt";
let fd = fileio.openSync(filePath);
fileio.ftruncate(fd, 5).then(() => {
  console.info("truncate file succeed");
}).catch((err: BusinessError) => {
  console.info("truncate file failed with error:" + err);
});

fileio.ftruncate⁷⁺

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

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

说明：

从API version 9开始废弃，请使用fs.truncate替代。

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

参数：

示例：

import { BusinessError } from '@ohos.base';
let filePath = pathDir + "/test.txt";
let fd = fileio.openSync(filePath);
let len = 5;
fileio.ftruncate(fd, 5, (err: BusinessError) => {
  // do something
});

fileio.ftruncateSync⁷⁺

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

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

说明：

从API version 9开始废弃，请使用fs.truncateSync替代。

系统能力：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异步回调。

说明：

从API version 9开始废弃，请使用fs.truncate替代。

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

参数：

返回值：

示例：

import { BusinessError } from '@ohos.base';
let filePath = pathDir + "/test.txt";
let len = 5;
fileio.truncate(filePath, len).then(() => {
  console.info("truncate file succeed");
}).catch((err: BusinessError) => {
  console.info("truncate file failed with error:" + err);
});

fileio.truncate⁷⁺

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

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

说明：

从API version 9开始废弃，请使用fs.truncate替代。

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

参数：

示例：

import { BusinessError } from '@ohos.base';
let filePath = pathDir + "/test.txt";
let len = 5;
fileio.truncate(filePath, len, (err: BusinessError) => {
  // do something
});

fileio.truncateSync⁷⁺

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

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

说明：

从API version 9开始废弃，请使用fs.truncateSync替代。

系统能力：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异步回调。

说明：

从API version 9开始废弃，请使用fs.readText替代。

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

参数：

返回值：

示例：

import { BusinessError } from '@ohos.base';
let filePath = pathDir + "/test.txt";
fileio.readText(filePath).then((str: string) => {
  console.info("readText succeed:" + str);
}).catch((err: BusinessError) => {
  console.info("readText failed with error:" + err);
});

fileio.readText⁷⁺

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

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

说明：

从API version 9开始废弃，请使用fs.readText替代。

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

参数：

示例：

import { BusinessError } from '@ohos.base';
let filePath = pathDir + "/test.txt";
class Option {
  length: number = 4096;
  position: number = 0;
  encoding: string = 'utf-8';
}
let option = new Option();
option.position = 1;
option.encoding = 'utf-8';
fileio.readText(filePath, option, (err: BusinessError, str: string) => {
  // do something
});

fileio.readTextSync⁷⁺

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

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

说明：

从API version 9开始废弃，请使用fs.readTextSync替代。

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

参数：

返回值：

示例：

let filePath = pathDir + "/test.txt";
class Option {
  length: number = 4096;
  position: number = 0;
  encoding: string = 'utf-8';
}
let option = new Option();
option.position = 1;
option.length = 3;
let str = fileio.readTextSync(filePath, option);

fileio.lstat⁷⁺

lstat(path: string): Promise<Stat>

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

说明：

从API version 9开始废弃，请使用fs.lstat替代。

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

参数：

返回值：

示例：

import { BusinessError } from '@ohos.base';
let filePath = pathDir + "/test.txt";
fileio.lstat(filePath).then((stat: fileio.Stat) => {
  console.info("get link status succeed, the size of file is" + stat.size);
}).catch((err: BusinessError) => {
  console.info("get link status failed with error:" + err);
});

fileio.lstat⁷⁺

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

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

说明：

从API version 9开始废弃，请使用fs.lstat替代。

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

参数：

示例：

import { BusinessError } from '@ohos.base';
let filePath = pathDir + "/test.txt";
fileio.lstat(filePath, (err: BusinessError, stat: fileio.Stat) => {
  // do something
});

fileio.lstatSync⁷⁺

lstatSync(path: string): Stat

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

说明：

从API version 9开始废弃，请使用fs.lstatSync替代。

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

参数：

返回值：

示例：

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

fileio.rename⁷⁺

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

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

说明：

从API version 9开始废弃，请使用fs.rename替代。

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

参数：

返回值：

示例：

import { BusinessError } from '@ohos.base';
let srcFile = pathDir + "/test.txt";
let dstFile = pathDir + '/new.txt';
fileio.rename(srcFile, dstFile).then(() => {
  console.info("rename succeed");
}).catch((err: BusinessError) => {
  console.info("rename failed with error:" + err);
});

fileio.rename⁷⁺

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

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

说明：

从API version 9开始废弃，请使用fs.rename替代。

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

参数：

示例：

import { BusinessError } from '@ohos.base';
let srcFile = pathDir + "/test.txt";
let dstFile = pathDir + '/new.txt';
fileio.rename(srcFile, dstFile, (err: BusinessError) => {
});

fileio.renameSync⁷⁺

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

以同步方法重命名文件。

说明：

从API version 9开始废弃，请使用fs.renameSync替代。

系统能力：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异步回调。

说明：

从API version 9开始废弃，请使用fs.fsync替代。

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

参数：

返回值：

示例：

import { BusinessError } from '@ohos.base';
let filePath = pathDir + "/test.txt";
let fd = fileio.openSync(filePath);
fileio.fsync(fd).then(() => {
  console.info("sync data succeed");
}).catch((err: BusinessError) => {
  console.info("sync data failed with error:" + err);
});

fileio.fsync⁷⁺

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

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

说明：

从API version 9开始废弃，请使用fs.fsync替代。

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

参数：

示例：

import { BusinessError } from '@ohos.base';
let filePath = pathDir + "/test.txt";
let fd = fileio.openSync(filePath);
fileio.fsync(fd, (err: BusinessError) => {
  // do something
});

fileio.fsyncSync⁷⁺

fsyncSync(fd: number): void

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

说明：

从API version 9开始废弃，请使用fs.fsyncSync替代。

系统能力：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异步回调。

说明：

从API version 9开始废弃，请使用fs.fdatasync替代。

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

参数：

返回值：

示例：

import { BusinessError } from '@ohos.base';
let filePath = pathDir + "/test.txt";
let fd = fileio.openSync(filePath);
fileio.fdatasync(fd).then(() => {
  console.info("sync data succeed");
}).catch((err: BusinessError) => {
  console.info("sync data failed with error:" + err);
});

fileio.fdatasync⁷⁺

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

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

说明：

从API version 9开始废弃，请使用fs.fdatasync替代。

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

参数：

示例：

import { BusinessError } from '@ohos.base';
let filePath = pathDir + "/test.txt";
let fd = fileio.openSync(filePath);
fileio.fdatasync (fd, (err: BusinessError) => {
  // do something
});

fileio.fdatasyncSync⁷⁺

fdatasyncSync(fd: number): void

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

说明：

从API version 9开始废弃，请使用fs.fdatasyncSync替代。

系统能力：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异步回调。

说明：

从API version 9开始废弃，请使用fs.symlink替代。

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

参数：

返回值：

示例：

import { BusinessError } from '@ohos.base';
let srcFile = pathDir + "/test.txt";
let dstFile = pathDir + '/test';
fileio.symlink(srcFile, dstFile).then(() => {
  console.info("symlink succeed");
}).catch((err: BusinessError) => {
  console.info("symlink failed with error:" + err);
});

fileio.symlink⁷⁺

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

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

说明：

从API version 9开始废弃，请使用fs.symlink替代。

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

参数：

示例：

import { BusinessError } from '@ohos.base';
let srcFile = pathDir + "/test.txt";
let dstFile = pathDir + '/test';
fileio.symlink(srcFile, dstFile, (err: BusinessError) => {
  // do something
});

fileio.symlinkSync⁷⁺

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

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

说明：

从API version 9开始废弃，请使用fs.symlinkSync替代。

系统能力：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异步回调。

说明：

从API version 9开始废弃。

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

参数：

返回值：

示例：

import { BusinessError } from '@ohos.base';
let filePath = pathDir + "/test.txt";
let stat = fileio.statSync(filePath);
fileio.chown(filePath, stat.uid, stat.gid).then(() => {
  console.info("chown succeed");
}).catch((err: BusinessError) => {
  console.info("chown failed with error:" + err);
});

fileio.chown⁷⁺

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

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

说明：

从API version 9开始废弃。

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

参数：

示例：

import { BusinessError } from '@ohos.base';
let filePath = pathDir + "/test.txt";
let stat = fileio.statSync(filePath)
fileio.chown(filePath, stat.uid, stat.gid, (err: BusinessError) => {
  // do something
});

fileio.chownSync⁷⁺

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

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

说明：

从API version 9开始废弃。

系统能力：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异步回调。

说明：

从API version 9开始废弃，请使用fs.mkdtemp替代。

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

参数：

返回值：

示例：

import { BusinessError } from '@ohos.base';
fileio.mkdtemp(pathDir + "/XXXXXX").then((pathDir: string) => {
  console.info("mkdtemp succeed:" + pathDir);
}).catch((err: BusinessError) => {
  console.info("mkdtemp failed with error:" + err);
});

fileio.mkdtemp⁷⁺

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

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

说明：

从API version 9开始废弃，请使用fs.mkdtemp替代。

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

参数：

示例：

import { BusinessError } from '@ohos.base';
fileio.mkdtemp(pathDir + "/XXXXXX", (err: BusinessError, res: string) => {
  // do something
});

fileio.mkdtempSync⁷⁺

mkdtempSync(prefix: string): string

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

说明：

从API version 9开始废弃，请使用fs.mkdtempSync替代。

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

参数：

返回值：

示例：

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

fileio.fchmod⁷⁺

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

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

说明：

从API version 9开始废弃。

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

参数：

返回值：

示例：

import { BusinessError } from '@ohos.base';
let filePath = pathDir + "/test.txt";
let fd = fileio.openSync(filePath);
let mode: number = 0o700;
fileio.fchmod(fd, mode).then(() => {
  console.info("chmod succeed");
}).catch((err: BusinessError) => {
  console.info("chmod failed with error:" + err);
});

fileio.fchmod⁷⁺

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

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

说明：

从API version 9开始废弃。

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

参数：

示例：

import { BusinessError } from '@ohos.base';
let filePath = pathDir + "/test.txt";
let fd = fileio.openSync(filePath);
let mode: number = 0o700;
fileio.fchmod(fd, mode, (err: BusinessError) => {
  // do something
});

fileio.fchmodSync⁷⁺

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

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

说明：

从API version 9开始废弃。

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

参数：

示例：

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

fileio.createStream⁷⁺

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

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

说明：

从API version 9开始废弃，请使用fs.createStream替代。

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

参数：

返回值：

示例：

import { BusinessError } from '@ohos.base';
let filePath = pathDir + "/test.txt";
fileio.createStream(filePath, "r+").then((stream: fileio.Stream) => {
  console.info("createStream succeed");
}).catch((err: BusinessError) => {
  console.info("createStream failed with error:" + err);
});

fileio.createStream⁷⁺

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

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

说明：

从API version 9开始废弃，请使用fs.createStream替代。

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

参数：

示例：

import { BusinessError } from '@ohos.base';
let filePath = pathDir + "/test.txt";
fileio.createStream(filePath, "r+", (err: BusinessError, stream: fileio.Stream) => {
  // do something
});

fileio.createStreamSync⁷⁺

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

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

说明：

从API version 9开始废弃，请使用fs.createStreamSync替代。

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

参数：

返回值：

示例：

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

fileio.fdopenStream⁷⁺

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

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

说明：

从API version 9开始废弃，请使用fs.fdopenStream替代。

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

参数：

返回值：

示例：

import { BusinessError } from '@ohos.base';
let filePath = pathDir + "/test.txt";
let fd = fileio.openSync(filePath);
fileio.fdopenStream(fd, "r+").then((stream: fileio.Stream) => {
  console.info("openStream succeed");
}).catch((err: BusinessError) => {
  console.info("openStream failed with error:" + err);
});

fileio.fdopenStream⁷⁺

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

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

说明：

从API version 9开始废弃，请使用fs.fdopenStream替代。

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

参数：

示例：

import { BusinessError } from '@ohos.base';
let filePath = pathDir + "/test.txt";
let fd = fileio.openSync(filePath);
fileio.fdopenStream(fd, "r+", (err: BusinessError, stream: fileio.Stream) => {
  // do something
});

fileio.fdopenStreamSync⁷⁺

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

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

说明：

从API version 9开始废弃，请使用fs.fdopenStreamSync替代。

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

参数：

返回值：

示例：

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

fileio.fchown⁷⁺

fchown(fd: number, uid: number, gid: number): Promise<void>

基于文件描述符改变文件所有者，使用Promise异步回调。

说明：

从API version 9开始废弃。

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

参数：

返回值：

示例：

import { BusinessError } from '@ohos.base';
let filePath = pathDir + "/test.txt";
let fd = fileio.openSync(filePath);
let stat = fileio.statSync(filePath);
fileio.fchown(fd, stat.uid, stat.gid).then(() => {
  console.info("chown succeed");
}).catch((err: BusinessError) => {
  console.info("chown failed with error:" + err);
});

fileio.fchown⁷⁺

fchown(fd: number, uid: number, gid: number, callback: AsyncCallback<void>): void

基于文件描述符改变文件所有者，使用callback异步回调。

说明：

从API version 9开始废弃。

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

参数：

示例：

import { BusinessError } from '@ohos.base';
let filePath = pathDir + "/test.txt";
let fd = fileio.openSync(filePath);
let stat = fileio.statSync(filePath);
fileio.fchown(fd, stat.uid, stat.gid, (err: BusinessError) => {
  // do something
});

fileio.fchownSync⁷⁺

fchownSync(fd: number, uid: number, gid: number): void

以同步方法基于文件描述符改变文件所有者。

说明：

从API version 9开始废弃。

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

参数：

示例：

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

fileio.lchown⁷⁺

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

基于文件路径改变文件所有者，更改符号链接本身的所有者，而不是符号链接所指向的实际文件，使用Promise异步回调。

说明：

从API version 9开始废弃。

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

参数：

返回值：

示例：

import { BusinessError } from '@ohos.base';
let filePath = pathDir + "/test.txt";
let stat = fileio.statSync(filePath);
fileio.lchown(filePath, stat.uid, stat.gid).then(() => {
  console.info("chown succeed");
}).catch((err: BusinessError) => {
  console.info("chown failed with error:" + err);
});

fileio.lchown⁷⁺

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

基于文件路径改变文件所有者，更改符号链接本身的所有者，而不是更改符号链接所指向的实际文件，使用callback异步回调。

说明：

从API version 9开始废弃。

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

参数：

示例：

import { BusinessError } from '@ohos.base';
let filePath = pathDir + "/test.txt";
let stat = fileio.statSync(filePath);
fileio.lchown(filePath, stat.uid, stat.gid, (err: BusinessError) => {
  // do something
});

fileio.lchownSync⁷⁺

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

以同步方法基于文件路径改变文件所有者，更改符号链接本身的所有者，而不是更改符号链接所指向的实际文件。

说明：

从API version 9开始废弃。

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

参数：

示例：

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

fileio.createWatcher⁷⁺

createWatcher(filename: string, events: number, callback: AsyncCallback<number>): Watcher

监听文件或者目录的变化，使用callback异步回调。

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

参数：

返回值：

示例：

let filePath = pathDir + "/test.txt";
fileio.createWatcher(filePath, 1, (err, event) => {
  console.info("event: " + event + "errmsg: " + JSON.stringify(err));
});

Readout

仅用于read方法，获取文件的读取结果。

说明：

从API version 9开始废弃。

系统能力：以下各项对应的系统能力均为SystemCapability.FileManagement.File.FileIO。

Stat

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

说明：

从API version 9开始废弃，请使用fs.Stat替代。

系统能力：以下各项对应的系统能力均为SystemCapability.FileManagement.File.FileIO。

属性

isBlockDevice

isBlockDevice(): boolean

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

说明：

从API version 9开始废弃，请使用fs.Stat.isBlockDevice替代。

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

返回值：

示例：

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

isCharacterDevice

isCharacterDevice(): boolean

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

说明：

从API version 9开始废弃，请使用fs.Stat.isCharacterDevice替代。

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

返回值：

示例：

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

isDirectory

isDirectory(): boolean

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

说明：

从API version 9开始废弃，请使用fs.Stat.isDirectory替代。

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

返回值：

示例：

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

isFIFO

isFIFO(): boolean

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

说明：

从API version 9开始废弃，请使用fs.Stat.isFIFO替代。

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

返回值：

示例：

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

isFile

isFile(): boolean

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

说明：

从API version 9开始废弃，请使用fs.Stat.isFile替代。

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

返回值：

示例：

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

isSocket

isSocket(): boolean

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

说明：

从API version 9开始废弃，请使用fs.Stat.isSocket替代。

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

返回值：

示例：

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

isSymbolicLink

isSymbolicLink(): boolean

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

说明：

从API version 9开始废弃，请使用fs.Stat.isSymbolicLink替代。

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

返回值：

示例：

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

Watcher⁷⁺

Watcher是文件变化监听的实例，调用Watcher.stop()方法（同步或异步）来停止文件监听。

stop⁷⁺

stop(): Promise<void>

关闭watcher监听，使用Promise异步回调。

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

示例：

let filePath = pathDir + "/test.txt";
let watcher = fileio.createWatcher(filePath, 1, (err, event) => {
  console.info("event: " + event + "errmsg: " + JSON.stringify(err));
});
watcher.stop().then(() => {
  console.info("close watcher succeed");
});

stop⁷⁺

stop(callback: AsyncCallback<void>): void

关闭watcher监听，使用callback异步回调。

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

参数：

示例：

let filePath = pathDir + "/test.txt";
let watcher = fileio.createWatcher(filePath, 1, (err, event) => {
  console.info("event: " + event + "errmsg: " + JSON.stringify(err));
});
watcher.stop(() => {
  console.info("close watcher succeed");
})

Stream

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

说明：

从API version 9开始废弃，请使用fs.Stream替代。

close⁷⁺

close(): Promise<void>

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

说明：

从API version 9开始废弃，请使用fs.Stream.close替代。

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

返回值：

示例：

import { BusinessError } from '@ohos.base';
let filePath = pathDir + "/test.txt";
let ss = fileio.createStreamSync(filePath, "r+");
ss.close().then(() => {
  console.info("close fileStream succeed");
}).catch((err: BusinessError) => {
  console.info("close fileStream  failed with error:" + err);
});

close⁷⁺

close(callback: AsyncCallback<void>): void

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

说明：

从API version 9开始废弃，请使用fs.Stream.close替代。

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

参数：

示例：

import { BusinessError } from '@ohos.base';
let filePath = pathDir + "/test.txt";
let ss = fileio.createStreamSync(filePath, "r+");
ss.close((err: BusinessError) => {
  // do something
});

closeSync

closeSync(): void

同步关闭文件流。

说明：

从API version 9开始废弃，请使用fs.Stream.closeSync替代。

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

示例：

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

flush⁷⁺

flush(): Promise<void>

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

说明：

从API version 9开始废弃，请使用fs.Stream.flush替代。

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

返回值：

示例：

import { BusinessError } from '@ohos.base';
let filePath = pathDir + "/test.txt";
let ss = fileio.createStreamSync(filePath, "r+");
ss.flush().then(() => {
  console.info("flush succeed");
}).catch((err: BusinessError) => {
  console.info("flush failed with error:" + err);
});

flush⁷⁺

flush(callback: AsyncCallback<void>): void

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

说明：

从API version 9开始废弃，请使用fs.Stream.flush替代。

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

参数：

示例：

import { BusinessError } from '@ohos.base';
let filePath = pathDir + "/test.txt";
let ss = fileio.createStreamSync(filePath, "r+");
ss.flush((err: BusinessError) => {
  // do something
});

flushSync⁷⁺

flushSync(): void

同步刷新文件流。

说明：

从API version 9开始废弃，请使用fs.Stream.flushSync替代。

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

示例：

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

write⁷⁺

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

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

说明：

从API version 9开始废弃，请使用fs.Stream.write替代。

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

参数：

返回值：

示例：

import { BusinessError } from '@ohos.base';
let filePath = pathDir + "/test.txt";
let ss = fileio.createStreamSync(filePath, "r+");
class Option {
  offset: number = 0;
  length: number = 4096;
  position: number = 0;
  encoding: string = 'utf-8';
}
let option = new Option();
option.offset = 1;
option.length = 5;
option.position = 5;
ss.write("hello, world", option).then((number: number) => {
  console.info("write succeed and size is:" + number);
}).catch((err: BusinessError) => {
  console.info("write failed with error:" + err);
});

write⁷⁺

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

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

说明：

从API version 9开始废弃，请使用fs.Stream.write替代。

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

参数：

示例：

import { BusinessError } from '@ohos.base';
let filePath = pathDir + "/test.txt";
let ss = fileio.createStreamSync(filePath, "r+");
class Option {
  offset: number = 0;
  length: number = 4096;
  position: number = 0;
  encoding: string = 'utf-8';
}
let option = new Option();
option.offset = 1;
option.length = 5;
option.position = 5;
ss.write("hello, world", option, (err: BusinessError, bytesWritten: number) => {
  if (bytesWritten) {
    // do something
    console.info("write succeed and size is:" + bytesWritten);
  }
});

writeSync⁷⁺

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

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

说明：

从API version 9开始废弃，请使用fs.Stream.writeSync替代。

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

参数：

返回值：

示例：

let filePath = pathDir + "/test.txt";
let ss = fileio.createStreamSync(filePath,"r+");
class Option {
  offset: number = 0;
  length: number = 4096;
  position: number = 0;
  encoding: string = 'utf-8';
}
let option = new Option();
option.offset = 1;
option.length = 5;
option.position = 5;
let num = ss.writeSync("hello, world", option);

read⁷⁺

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

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

说明：

从API version 9开始废弃，请使用fs.Stream.read替代。

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

参数：

返回值：

示例：

import { BusinessError } from '@ohos.base';
import buffer from '@ohos.buffer';
import { ReadOut } from '@ohos.fileio';
let filePath = pathDir + "/test.txt";
let ss = fileio.createStreamSync(filePath, "r+");
let arrayBuffer = new ArrayBuffer(4096);
class Option {
  offset: number = 0;
  length: number = 4096;
  position: number = 0;
}
let option = new Option();
option.offset = 1;
option.length = 5;
option.position = 5;
ss.read(arrayBuffer, option).then((readResult: ReadOut) => {
  console.info("read data succeed");
  let buf = buffer.from(arrayBuffer, 0, readResult.bytesRead);
  console.info(`The content of file: ${buf.toString()}`);
}).catch((err: BusinessError) => {
  console.info("read data failed with error:" + err);
});

read⁷⁺

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

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

说明：

从API version 9开始废弃，请使用fs.Stream.read替代。

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

参数：

示例：

import { BusinessError } from '@ohos.base';
import buffer from '@ohos.buffer';
import { ReadOut } from '@ohos.fileio';
let filePath = pathDir + "/test.txt";
let ss = fileio.createStreamSync(filePath, "r+");
let arrayBuffer = new ArrayBuffer(4096);
class Option {
  offset: number = 0;
  length: number = 4096;
  position: number = 0;
}
let option = new Option();
option.offset = 1;
option.length = 5;
option.position = 5;
ss.read(arrayBuffer, option, (err: BusinessError, readResult: ReadOut) => {
  if (readResult.bytesRead) {
    console.info("read data succeed");
    let buf = buffer.from(arrayBuffer, 0, readResult.bytesRead);
    console.info(`The content of file: ${buf.toString()}`);
  }
});

readSync⁷⁺

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

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

说明：

从API version 9开始废弃，请使用fs.Stream.readSync替代。

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

参数：

返回值：

示例：

let filePath = pathDir + "/test.txt";
let ss = fileio.createStreamSync(filePath, "r+");
class Option {
  offset: number = 0;
  length: number = 4096;
  position: number = 0;
}
let option = new Option();
option.offset = 1;
option.length = 5;
option.position = 5;
let buf = new ArrayBuffer(4096)
let num = ss.readSync(buf, option);

Dir

管理目录，在调用Dir的方法前，需要先通过opendir方法（同步或异步）来构建一个Dir实例。

说明：

从API version 9开始废弃，请使用fs.listFile替代。

read

read(): Promise<Dirent>

读取下一个目录项，使用Promise异步回调。

说明：

从API version 9开始废弃，请使用fs.listFile替代。

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

返回值：

示例：

import { BusinessError } from '@ohos.base';
dir.read().then((dirent: fileio.Dirent) => {
  console.log("read succeed, the name of dirent is " + dirent.name);
}).catch((err: BusinessError) => {
  console.info("read failed with error:" + err);
});

read

read(callback: AsyncCallback<Dirent>): void

读取下一个目录项，使用callback异步回调。

说明：

从API version 9开始废弃，请使用fs.listFile替代。

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

参数：

示例：

import { BusinessError } from '@ohos.base';
dir.read((err: BusinessError, dirent: fileio.Dirent) => {
  if (dirent) {
    // do something
    console.log("read succeed, the name of file is " + dirent.name);
  }
});

readSync

readSync(): Dirent

同步读取下一个目录项。

说明：

从API version 9开始废弃，请使用fs.listFileSync替代。

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

返回值：

示例：

let dirent = dir.readSync();

close⁷⁺

close(): Promise<void>

异步关闭目录，使用promise形式返回结果。目录被关闭后，Dir中持有的文件描述将被释放，后续将无法从Dir中读取目录项。

说明：

从API version 9开始废弃，请使用fs.listFile替代。

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

示例：

import { BusinessError } from '@ohos.base';
dir.close().then(() => {
  console.info("close dir successfully");
});

close⁷⁺

close(callback: AsyncCallback<void>): void

异步关闭目录，使用callback形式返回结果。目录被关闭后，Dir中持有的文件描述将被释放，后续将无法从Dir中读取目录项。

说明：

从API version 9开始废弃，请使用fs.listFile替代。

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

示例：

import { BusinessError } from '@ohos.base';
dir.close((err: BusinessError) => {
  console.info("close dir successfully");
});

closeSync

closeSync(): void

用于关闭目录。目录被关闭后，Dir中持有的文件描述将被释放，后续将无法从Dir中读取目录项。

说明：

从API version 9开始废弃，请使用fs.listFileSync替代。

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

示例：

dir.closeSync();

Dirent

在调用Dirent的方法前，需要先通过dir.read()方法（同步或异步）来构建一个Dirent实例。

说明：

从API version 9开始废弃，请使用fs.listFile替代。

系统能力：以下各项对应的系统能力均为SystemCapability.FileManagement.File.FileIO。

属性

isBlockDevice

isBlockDevice(): boolean

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

说明：

从API version 9开始废弃。

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

返回值：

示例：

let dir = fileio.opendirSync(pathDir);
let isBLockDevice = dir.readSync().isBlockDevice();

isCharacterDevice

isCharacterDevice(): boolean

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

说明：

从API version 9开始废弃。

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

返回值：

示例：

let dir = fileio.opendirSync(pathDir);
let isCharacterDevice = dir.readSync().isCharacterDevice(); 

isDirectory

isDirectory(): boolean

用于判断当前目录项是否是目录。

说明：

从API version 9开始废弃。

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

返回值：

示例：

let dir = fileio.opendirSync(pathDir);
let isDirectory = dir.readSync().isDirectory(); 

isFIFO

isFIFO(): boolean

用于判断当前目录项是否是命名管道（有时也称为FIFO）。命名管道通常用于进程间通信。

说明：

从API version 9开始废弃。

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

返回值：

示例：

let dir = fileio.opendirSync(pathDir);
let isFIFO = dir.readSync().isFIFO(); 

isFile

isFile(): boolean

用于判断当前目录项是否是普通文件。

说明：

从API version 9开始废弃。

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

返回值：

示例：

let dir = fileio.opendirSync(pathDir);
let isFile = dir.readSync().isFile(); 

isSocket

isSocket(): boolean

用于判断当前目录项是否是套接字。

说明：

从API version 9开始废弃。

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

返回值：

示例：

let dir = fileio.opendirSync(pathDir);
let isSocket = dir.readSync().isSocket(); 

isSymbolicLink

isSymbolicLink(): boolean

用于判断当前目录项是否是符号链接。

说明：

从API version 9开始废弃。

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

返回值：

示例：

let dir = fileio.opendirSync(pathDir);
let isSymbolicLink = dir.readSync().isSymbolicLink();