From 84e547ed7c34f9641e4df42ae48791a3e42308ae Mon Sep 17 00:00:00 2001 From: 18721213663 Date: Wed, 21 Jun 2023 11:57:36 +0800 Subject: [PATCH] fileio_add_deprecated Signed-off-by: 18721213663 --- .../reference/apis/js-apis-file-fs.md | 25 +- .../reference/apis/js-apis-fileio.md | 497 +++++++++++++++++- 2 files changed, 504 insertions(+), 18 deletions(-) diff --git a/zh-cn/application-dev/reference/apis/js-apis-file-fs.md b/zh-cn/application-dev/reference/apis/js-apis-file-fs.md index 9dbb1be5c2..b2e930b5c0 100644 --- a/zh-cn/application-dev/reference/apis/js-apis-file-fs.md +++ b/zh-cn/application-dev/reference/apis/js-apis-file-fs.md @@ -280,7 +280,6 @@ close(file: number|File): Promise<void> 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); }); @@ -3330,18 +3329,18 @@ open接口flags参数常量。文件打开标签。 **系统能力**：SystemCapability.FileManagement.File.FileIO -| 名称 | 类型 | 可读 | 可写 | 说明 | -| ---- | ------ |---- |----| ------- | -| READ_ONLY | number | 是 | 否 | 只读打开。 | -| WRITE_ONLY | number | 是 | 否 | 只写打开。 | -| READ_WRITE | number | 是 | 否 | 读写打开。 | -| CREATE | number | 是 | 否 | 若文件不存在，则创建文件。 | -| TRUNC | number | 是 | 否 | 如果文件存在且以只写或读写的方式打开文件，则将其长度裁剪为零。 | -| APPEND | number | 是 | 否 | 以追加方式打开，后续写将追加到文件末尾。 | -| NONBLOCK | number | 是 | 否 | 如果path指向FIFO、块特殊文件或字符特殊文件，则本次打开及后续 IO 进行非阻塞操作。 | -| DIR | number | 是 | 否 | 如果path不指向目录，则出错。 | -| NOFOLLOW | number | 是 | 否 | 如果path指向符号链接，则出错。 | -| SYNC | number | 是 | 否 | 以同步IO的方式打开文件。 | +| 名称 | 类型 | 值 | 说明 | +| ---- | ------ |---- | ------- | +| READ_ONLY | number | 0o0 | 只读打开。 | +| WRITE_ONLY | number | 0o1 | 只写打开。 | +| READ_WRITE | number | 0o2 | 读写打开。 | +| CREATE | number | 0o100 | 若文件不存在，则创建文件。 | +| TRUNC | number | 0o1000 | 如果文件存在且以只写或读写的方式打开文件，则将其长度裁剪为零。 | +| APPEND | number | 0o2000 | 以追加方式打开，后续写将追加到文件末尾。 | +| NONBLOCK | number | 0o4000 | 如果path指向FIFO、块特殊文件或字符特殊文件，则本次打开及后续 IO 进行非阻塞操作。 | +| DIR | number | 0o200000 | 如果path不指向目录，则出错。 | +| NOFOLLOW | number | 0o400000 | 如果path指向符号链接，则出错。 | +| SYNC | number | 0o4010000 | 以同步IO的方式打开文件。 | ## Filter diff --git a/zh-cn/application-dev/reference/apis/js-apis-fileio.md b/zh-cn/application-dev/reference/apis/js-apis-fileio.md index 367b069c7a..ff647b5d77 100644 --- a/zh-cn/application-dev/reference/apis/js-apis-fileio.md +++ b/zh-cn/application-dev/reference/apis/js-apis-fileio.md @@ -51,6 +51,10 @@ stat(path: string): Promise<Stat> 获取文件信息，使用Promise异步回调。 +> **说明**： +> +> 从API version 9开始废弃，请使用[fs.stat](js-apis-file-fs.md#stat)替代。 + **系统能力**：SystemCapability.FileManagement.File.FileIO **参数：** @@ -83,6 +87,10 @@ stat(path: string, callback: AsyncCallback<Stat>): void 获取文件信息，使用callback异步回调。 +> **说明**： +> +> 从API version 9开始废弃，请使用[fs.stat](js-apis-file-fs.md#fsstat-1)替代。 + **系统能力**：SystemCapability.FileManagement.File.FileIO **参数：** @@ -107,6 +115,10 @@ statSync(path: string): Stat 以同步方法获取文件的信息。 +> **说明**： +> +> 从API version 9开始废弃，请使用[fs.statSync](js-apis-file-fs.md#fsstatsync)替代。 + **系统能力**：SystemCapability.FileManagement.File.FileIO **参数：** @@ -136,6 +148,10 @@ opendir(path: string): Promise<Dir> 打开文件目录，使用Promise异步回调。 +> **说明**： +> +> 从API version 9开始废弃，请使用[fs.listFile](js-apis-file-fs.md#fslistfile)替代。 + **系统能力**：SystemCapability.FileManagement.File.FileIO **参数：** @@ -161,13 +177,17 @@ opendir(path: string): Promise<Dir> }); ``` - + ## fileio.opendir opendir(path: string, callback: AsyncCallback<Dir>): void 打开文件目录，使用callback异步回调。 +> **说明**： +> +> 从API version 9开始废弃，请使用[fs.listFile](js-apis-file-fs.md#fslistfile-1)替代。 + **系统能力**：SystemCapability.FileManagement.File.FileIO **参数：** @@ -193,8 +213,11 @@ opendirSync(path: string): Dir 以同步方法打开文件目录。 -**系统能力**：SystemCapability.FileManagement.File.FileIO +> **说明**： +> +> 从API version 9开始废弃，请使用[fs.listFileSync](js-apis-file-fs.md#fslistfilesync)替代。 +**系统能力**：SystemCapability.FileManagement.File.FileIO **参数：** @@ -223,6 +246,10 @@ access(path: string, mode?: number): Promise<void> 检查当前进程是否可访问某文件，使用Promise异步回调。 +> **说明**： +> +> 从API version 9开始废弃，请使用[fs.access](js-apis-file-fs.md#fsaccess)替代。 + **系统能力**：SystemCapability.FileManagement.File.FileIO **参数：** @@ -256,6 +283,10 @@ access(path: string, mode?: number, callback: AsyncCallback<void>): void 检查当前进程是否可访问某文件，使用callback异步回调。 +> **说明**： +> +> 从API version 9开始废弃，请使用[fs.access](js-apis-file-fs.md#fsaccess-1)替代。 + **系统能力**：SystemCapability.FileManagement.File.FileIO **参数：** @@ -282,6 +313,10 @@ accessSync(path: string, mode?: number): void 以同步方法检查当前进程是否可访问某文件。 +> **说明**： +> +> 从API version 9开始废弃，请使用[fs.accessSync](js-apis-file-fs.md#fsaccesssync)替代。 + **系统能力**：SystemCapability.FileManagement.File.FileIO **参数：** @@ -309,6 +344,10 @@ close(fd: number): Promise<void> 关闭文件，使用Promise异步回调。 +> **说明**： +> +> 从API version 9开始废弃，请使用[fs.close](js-apis-file-fs.md#fsclose)替代。 + **系统能力**：SystemCapability.FileManagement.File.FileIO **参数：** @@ -342,6 +381,10 @@ close(fd: number, callback: AsyncCallback<void>): void 关闭文件，使用callback异步回调。 +> **说明**： +> +> 从API version 9开始废弃，请使用[fs.close](js-apis-file-fs.md#fsclose-1)替代。 + **系统能力**：SystemCapability.FileManagement.File.FileIO **参数：** @@ -368,6 +411,10 @@ closeSync(fd: number): void 以同步方法关闭文件。 +> **说明**： +> +> 从API version 9开始废弃，请使用[fs.closeSync](js-apis-file-fs.md#fsclosesync)替代。 + **系统能力**：SystemCapability.FileManagement.File.FileIO **参数：** @@ -391,6 +438,10 @@ copyFile(src: string|number, dest: string|number, mode?: number): Promise<voi 复制文件，使用Promise异步回调。 +> **说明**： +> +> 从API version 9开始废弃，请使用[fs.copyFile](js-apis-file-fs.md#fscopyfile)替代。 + **系统能力**：SystemCapability.FileManagement.File.FileIO **参数：** @@ -426,6 +477,10 @@ copyFile(src: string|number, dest: string|number, mode: number, callback: AsyncC 复制文件，使用callback异步回调。 +> **说明**： +> +> 从API version 9开始废弃，请使用[fs.copyFile](js-apis-file-fs.md#fscopyfile-1)替代。 + **系统能力**：SystemCapability.FileManagement.File.FileIO **参数：** @@ -454,6 +509,10 @@ copyFileSync(src: string|number, dest: string|number, mode?: number): void 以同步方法复制文件。 +> **说明**： +> +> 从API version 9开始废弃，请使用[fs.copyFileSync](js-apis-file-fs.md#fscopyfilesync)替代。 + **系统能力**：SystemCapability.FileManagement.File.FileIO **参数：** @@ -479,6 +538,10 @@ mkdir(path: string, mode?: number): Promise<void> 创建目录，使用Promise异步回调。 +> **说明**： +> +> 从API version 9开始废弃，请使用[fs.mkdir](js-apis-file-fs.md#fsmkdir)替代。 + **系统能力**：SystemCapability.FileManagement.File.FileIO **参数：** @@ -512,6 +575,10 @@ mkdir(path: string, mode: number, callback: AsyncCallback<void>): void 创建目录，使用callback异步回调。 +> **说明**： +> +> 从API version 9开始废弃，请使用[fs.mkdir](js-apis-file-fs.md#fsmkdir-1)替代。 + **系统能力**：SystemCapability.FileManagement.File.FileIO **参数：** @@ -538,6 +605,10 @@ mkdirSync(path: string, mode?: number): void 以同步方法创建目录。 +> **说明**： +> +> 从API version 9开始废弃，请使用[fs.mkdirSync](js-apis-file-fs.md#fsmkdirsync)替代。 + **系统能力**：SystemCapability.FileManagement.File.FileIO **参数：** @@ -561,6 +632,10 @@ open(path: string, flags?: number, mode?: number): Promise<number> 打开文件，使用Promise异步回调。 +> **说明**： +> +> 从API version 9开始废弃，请使用[fs.open](js-apis-file-fs.md#fsopen)替代。 + **系统能力**：SystemCapability.FileManagement.File.FileIO **参数：** @@ -595,6 +670,10 @@ open(path: string, flags: number, mode: number, callback: AsyncCallback<numbe 打开文件，使用callback异步回调。 +> **说明**： +> +> 从API version 9开始废弃，请使用[fs.open](js-apis-file-fs.md#fsopen-1)替代。 + **系统能力**：SystemCapability.FileManagement.File.FileIO **参数：** @@ -622,6 +701,10 @@ openSync(path: string, flags?: number, mode?: number): number 以同步方法打开文件。 +> **说明**： +> +> 从API version 9开始废弃，请使用[fs.openSync](js-apis-file-fs.md#fsopensync)替代。 + **系统能力**：SystemCapability.FileManagement.File.FileIO **参数：** @@ -661,6 +744,10 @@ read(fd: number, buffer: ArrayBuffer, options?: { offset?: number; length?: numb 从文件读取数据，使用Promise异步回调。 +> **说明**： +> +> 从API version 9开始废弃，请使用[fs.read](js-apis-file-fs.md#fsread)替代。 + **系统能力**：SystemCapability.FileManagement.File.FileIO **参数：** @@ -698,6 +785,10 @@ read(fd: number, buffer: ArrayBuffer, options: { offset?: number; length?: numbe 从文件读取数据，使用callback异步回调。 +> **说明**： +> +> 从API version 9开始废弃，请使用[fs.read](js-apis-file-fs.md#fsread-1)替代。 + **系统能力**：SystemCapability.FileManagement.File.FileIO **参数：** @@ -730,6 +821,10 @@ readSync(fd: number, buffer: ArrayBuffer, options?: { offset?: number; length?: 以同步方法从文件读取数据。 +> **说明**： +> +> 从API version 9开始废弃，请使用[fs.readSync](js-apis-file-fs.md#fsreadsync)替代。 + **系统能力**：SystemCapability.FileManagement.File.FileIO **参数：** @@ -762,6 +857,10 @@ rmdir(path: string): Promise<void> 删除目录，使用Promise异步回调。 +> **说明**： +> +> 从API version 9开始废弃，请使用[fs.rmdir](js-apis-file-fs.md#fsrmdir)替代。 + **系统能力**：SystemCapability.FileManagement.File.FileIO **参数：** @@ -794,6 +893,10 @@ rmdir(path: string, callback: AsyncCallback<void>): void 删除目录，使用callback异步回调。 +> **说明**： +> +> 从API version 9开始废弃，请使用[fs.rmdir](js-apis-file-fs.md#fsrmdir-1)替代。 + **系统能力**：SystemCapability.FileManagement.File.FileIO **参数：** @@ -820,6 +923,10 @@ rmdirSync(path: string): void 以同步方法删除目录。 +> **说明**： +> +> 从API version 9开始废弃，请使用[fs.rmdirSync](js-apis-file-fs.md#fsrmdirsync)替代。 + **系统能力**：SystemCapability.FileManagement.File.FileIO **参数：** @@ -842,6 +949,10 @@ unlink(path: string): Promise<void> 删除文件，使用Promise异步回调。 +> **说明**： +> +> 从API version 9开始废弃，请使用[fs.unlink](js-apis-file-fs.md#fsunlink)替代。 + **系统能力**：SystemCapability.FileManagement.File.FileIO **参数：** @@ -874,6 +985,10 @@ unlink(path: string, callback: AsyncCallback<void>): void 删除文件，使用callback异步回调。 +> **说明**： +> +> 从API version 9开始废弃，请使用[fs.unlink](js-apis-file-fs.md#fsunlink-1)替代。 + **系统能力**：SystemCapability.FileManagement.File.FileIO **参数：** @@ -899,6 +1014,10 @@ unlinkSync(path: string): void 以同步方法删除文件。 +> **说明**： +> +> 从API version 9开始废弃，请使用[fs.unlinkSync](js-apis-file-fs.md#fsunlinksync)替代。 + **系统能力**：SystemCapability.FileManagement.File.FileIO **参数：** @@ -921,6 +1040,10 @@ write(fd: number, buffer: ArrayBuffer|string, options?: { offset?: number; lengt 将数据写入文件，使用Promise异步回调。 +> **说明**： +> +> 从API version 9开始废弃，请使用[fs.write](js-apis-file-fs.md#fswrite)替代。 + **系统能力**：SystemCapability.FileManagement.File.FileIO **参数：** @@ -956,6 +1079,10 @@ write(fd: number, buffer: ArrayBuffer|string, options: { offset?: number; length 将数据写入文件，使用callback异步回调。 +> **说明**： +> +> 从API version 9开始废弃，请使用[fs.write](js-apis-file-fs.md#fswrite-1)替代。 + **系统能力**：SystemCapability.FileManagement.File.FileIO **参数：** @@ -986,6 +1113,10 @@ writeSync(fd: number, buffer: ArrayBuffer|string, options?: { offset?: number; l 以同步方法将数据写入文件。 +> **说明**： +> +> 从API version 9开始废弃，请使用[fs.writeSync](js-apis-file-fs.md#fswritesync)替代。 + **系统能力**：SystemCapability.FileManagement.File.FileIO **参数：** @@ -1017,6 +1148,10 @@ hash(path: string, algorithm: string): Promise<string> 计算文件的哈希值，使用Promise异步回调。 +> **说明**： +> +> 从API version 9开始废弃，请使用[hash.write](js-apis-file-hash.md#hashhash)替代。 + **系统能力**：SystemCapability.FileManagement.File.FileIO **参数：** @@ -1050,6 +1185,10 @@ hash(path: string, algorithm: string, callback: AsyncCallback<string>): vo 计算文件的哈希值，使用callback异步回调。 +> **说明**： +> +> 从API version 9开始废弃，请使用[hash.write](js-apis-file-hash.md#hashhash-1)替代。 + **系统能力**：SystemCapability.FileManagement.File.FileIO **参数：** @@ -1078,6 +1217,10 @@ chmod(path: string, mode: number): Promise<void> 改变文件权限，使用Promise异步回调。 +> **说明**： +> +> 从API version 9开始废弃。 + **系统能力**：SystemCapability.FileManagement.File.FileIO **参数：** @@ -1111,6 +1254,10 @@ chmod(path: string, mode: number, callback: AsyncCallback<void>): void 改变文件权限，使用callback异步回调。 +> **说明**： +> +> 从API version 9开始废弃。 + **系统能力**：SystemCapability.FileManagement.File.FileIO **参数：** @@ -1137,6 +1284,10 @@ chmodSync(path: string, mode: number): void 以同步方法改变文件权限。 +> **说明**： +> +> 从API version 9开始废弃。 + **系统能力**：SystemCapability.FileManagement.File.FileIO **参数：** @@ -1160,6 +1311,10 @@ fstat(fd: number): Promise<Stat> 基于文件描述符获取文件状态信息，使用Promise异步回调。 +> **说明**： +> +> 从API version 9开始废弃，请使用[fs.stat](js-apis-file-fs.md#fsstat)替代。 + **系统能力**：SystemCapability.FileManagement.File.FileIO **参数：** @@ -1193,6 +1348,10 @@ fstat(fd: number, callback: AsyncCallback<Stat>): void 基于文件描述符获取文件状态信息，使用callback异步回调。 +> **说明**： +> +> 从API version 9开始废弃，请使用[fs.stat](js-apis-file-fs.md#fsstat-1)替代。 + **系统能力**：SystemCapability.FileManagement.File.FileIO **参数：** @@ -1219,6 +1378,10 @@ fstatSync(fd: number): Stat 以同步方法基于文件描述符获取文件状态信息。 +> **说明**： +> +> 从API version 9开始废弃，请使用[fs.statSync](js-apis-file-fs.md#fsstatsync)替代。 + **系统能力**：SystemCapability.FileManagement.File.FileIO **参数：** @@ -1248,6 +1411,10 @@ ftruncate(fd: number, len?: number): Promise<void> 基于文件描述符截断文件，使用Promise异步回调。 +> **说明**： +> +> 从API version 9开始废弃，请使用[fs.truncate](js-apis-file-fs.md#fstruncate)替代。 + **系统能力**：SystemCapability.FileManagement.File.FileIO **参数：** @@ -1282,6 +1449,10 @@ ftruncate(fd: number, len?: number, callback: AsyncCallback<void>): void 基于文件描述符截断文件，使用callback异步回调。 +> **说明**： +> +> 从API version 9开始废弃，请使用[fs.truncate](js-apis-file-fs.md#fstruncate-1)替代。 + **系统能力**：SystemCapability.FileManagement.File.FileIO **参数：** @@ -1310,6 +1481,10 @@ ftruncateSync(fd: number, len?: number): void 以同步方法基于文件描述符截断文件。 +> **说明**： +> +> 从API version 9开始废弃，请使用[fs.truncateSync](js-apis-file-fs.md#fstruncatesync)替代。 + **系统能力**：SystemCapability.FileManagement.File.FileIO **参数：** @@ -1335,6 +1510,10 @@ truncate(path: string, len?: number): Promise<void> 基于文件路径截断文件，使用Promise异步回调。 +> **说明**： +> +> 从API version 9开始废弃，请使用[fs.truncate](js-apis-file-fs.md#fstruncate)替代。 + **系统能力**：SystemCapability.FileManagement.File.FileIO **参数：** @@ -1369,6 +1548,10 @@ truncate(path: string, len?: number, callback: AsyncCallback<void>): void 基于文件路径截断文件，使用callback异步回调。 +> **说明**： +> +> 从API version 9开始废弃，请使用[fs.truncate](js-apis-file-fs.md#fstruncate-1)替代。 + **系统能力**：SystemCapability.FileManagement.File.FileIO **参数：** @@ -1396,6 +1579,10 @@ truncateSync(path: string, len?: number): void 以同步方法基于文件路径截断文件。 +> **说明**： +> +> 从API version 9开始废弃，请使用[fs.truncateSync](js-apis-file-fs.md#fstruncatesync)替代。 + **系统能力**：SystemCapability.FileManagement.File.FileIO **参数：** @@ -1420,6 +1607,10 @@ readText(filePath: string, options?: { position?: number; length?: number; encod 基于文本方式读取文件（即直接读取文件的文本内容），使用Promise异步回调。 +> **说明**： +> +> 从API version 9开始废弃，请使用[fs.readText](js-apis-file-fs.md#fsreadtext)替代。 + **系统能力**：SystemCapability.FileManagement.File.FileIO **参数：** @@ -1453,6 +1644,10 @@ readText(filePath: string, options: { position?: number; length?: number; encodi 基于文本方式读取文件（即直接读取文件的文本内容），使用callback异步回调。 +> **说明**： +> +> 从API version 9开始废弃，请使用[fs.readText](js-apis-file-fs.md#fsreadtext-1)替代。 + **系统能力**：SystemCapability.FileManagement.File.FileIO **参数：** @@ -1479,6 +1674,10 @@ readTextSync(filePath: string, options?: { position?: number; length?: number; e 以同步方法基于文本方式读取文件（即直接读取文件的文本内容）。 +> **说明**： +> +> 从API version 9开始废弃，请使用[fs.readTextSync](js-apis-file-fs.md#fsreadtextsync)替代。 + **系统能力**：SystemCapability.FileManagement.File.FileIO **参数：** @@ -1508,6 +1707,10 @@ lstat(path: string): Promise<Stat> 获取链接信息，使用Promise异步回调。 +> **说明**： +> +> 从API version 9开始废弃，请使用[fs.lstat](js-apis-file-fs.md#fslstat)替代。 + **系统能力**：SystemCapability.FileManagement.File.FileIO **参数：** @@ -1540,6 +1743,10 @@ lstat(path: string, callback: AsyncCallback<Stat>): void 获取链接信息，使用callback异步回调。 +> **说明**： +> +> 从API version 9开始废弃，请使用[fs.lstat](js-apis-file-fs.md#fslstat-1)替代。 + **系统能力**：SystemCapability.FileManagement.File.FileIO **参数：** @@ -1565,6 +1772,10 @@ lstatSync(path: string): Stat 以同步方法获取链接信息。 +> **说明**： +> +> 从API version 9开始废弃，请使用[fs.lstatSync](js-apis-file-fs.md#fslstatsync)替代。 + **系统能力**：SystemCapability.FileManagement.File.FileIO **参数：** @@ -1593,6 +1804,10 @@ rename(oldPath: string, newPath: string): Promise<void> 重命名文件，使用Promise异步回调。 +> **说明**： +> +> 从API version 9开始废弃，请使用[fs.rename](js-apis-file-fs.md#fsrename)替代。 + **系统能力**：SystemCapability.FileManagement.File.FileIO **参数：** @@ -1627,6 +1842,10 @@ rename(oldPath: string, newPath: string, callback: AsyncCallback<void>): v 重命名文件，使用callback异步回调。 +> **说明**： +> +> 从API version 9开始废弃，请使用[fs.rename](js-apis-file-fs.md#fsrename-1)替代。 + **系统能力**：SystemCapability.FileManagement.File.FileIO **参数：** @@ -1646,13 +1865,16 @@ rename(oldPath: string, newPath: string, callback: AsyncCallback<void>): v }); ``` - ## fileio.renameSync7+ renameSync(oldPath: string, newPath: string): void 以同步方法重命名文件。 +> **说明**： +> +> 从API version 9开始废弃，请使用[fs.renameSync](js-apis-file-fs.md#fsrenamesync)替代。 + **系统能力**：SystemCapability.FileManagement.File.FileIO **参数：** @@ -1677,6 +1899,10 @@ fsync(fd: number): Promise<void> 同步文件数据，使用Promise异步回调。 +> **说明**： +> +> 从API version 9开始废弃，请使用[fs.fsync](js-apis-file-fs.md#fsfsync)替代。 + **系统能力**：SystemCapability.FileManagement.File.FileIO **参数：** @@ -1710,6 +1936,10 @@ fsync(fd: number, callback: AsyncCallback<void>): void 同步文件数据，使用callback异步回调。 +> **说明**： +> +> 从API version 9开始废弃，请使用[fs.fsync](js-apis-file-fs.md#fsfsync-1)替代。 + **系统能力**：SystemCapability.FileManagement.File.FileIO **参数：** @@ -1736,6 +1966,10 @@ fsyncSync(fd: number): void 以同步方法同步文件数据。 +> **说明**： +> +> 从API version 9开始废弃，请使用[fs.fsyncSync](js-apis-file-fs.md#fsfsyncsync)替代。 + **系统能力**：SystemCapability.FileManagement.File.FileIO **参数：** @@ -1759,6 +1993,10 @@ fdatasync(fd: number): Promise<void> 实现文件内容数据同步，使用Promise异步回调。 +> **说明**： +> +> 从API version 9开始废弃，请使用[fs.fdatasync](js-apis-file-fs.md#fsfdatasync)替代。 + **系统能力**：SystemCapability.FileManagement.File.FileIO **参数：** @@ -1792,6 +2030,10 @@ fdatasync(fd: number, callback: AsyncCallback<void>): void 实现文件内容数据同步，使用callback异步回调。 +> **说明**： +> +> 从API version 9开始废弃，请使用[fs.fdatasync](js-apis-file-fs.md#fsfdatasync-1)替代。 + **系统能力**：SystemCapability.FileManagement.File.FileIO **参数：** @@ -1818,6 +2060,10 @@ fdatasyncSync(fd: number): void 以同步方法实现文件内容数据同步。 +> **说明**： +> +> 从API version 9开始废弃，请使用[fs.fdatasyncSync](js-apis-file-fs.md#fsfdatasyncsync)替代。 + **系统能力**：SystemCapability.FileManagement.File.FileIO **参数：** @@ -1841,6 +2087,10 @@ symlink(target: string, srcPath: string): Promise<void> 基于文件路径创建符号链接，使用Promise异步回调。 +> **说明**： +> +> 从API version 9开始废弃，请使用[fs.symlink](js-apis-file-fs.md#fssymlink)替代。 + **系统能力**：SystemCapability.FileManagement.File.FileIO **参数：** @@ -1875,6 +2125,10 @@ symlink(target: string, srcPath: string, callback: AsyncCallback<void>): v 基于文件路径创建符号链接，使用callback异步回调。 +> **说明**： +> +> 从API version 9开始废弃，请使用[fs.symlink](js-apis-file-fs.md#fssymlink-1)替代。 + **系统能力**：SystemCapability.FileManagement.File.FileIO **参数：** @@ -1902,6 +2156,10 @@ symlinkSync(target: string, srcPath: string): void 以同步的方法基于文件路径创建符号链接。 +> **说明**： +> +> 从API version 9开始废弃，请使用[fs.symlinkSync](js-apis-file-fs.md#fssymlinksync)替代。 + **系统能力**：SystemCapability.FileManagement.File.FileIO **参数：** @@ -1926,6 +2184,10 @@ chown(path: string, uid: number, gid: number): Promise<void> 基于文件路径改变文件所有者，使用Promise异步回调。 +> **说明**： +> +> 从API version 9开始废弃。 + **系统能力**：SystemCapability.FileManagement.File.FileIO **参数：** @@ -1961,6 +2223,10 @@ chown(path: string, uid: number, gid: number, callback: AsyncCallback<void> 基于文件路径改变文件所有者，使用callback异步回调。 +> **说明**： +> +> 从API version 9开始废弃。 + **系统能力**：SystemCapability.FileManagement.File.FileIO **参数：** @@ -1982,13 +2248,16 @@ chown(path: string, uid: number, gid: number, callback: AsyncCallback<void> }); ``` - ## fileio.chownSync7+ chownSync(path: string, uid: number, gid: number): void 以同步的方法基于文件路径改变文件所有者。 +> **说明**： +> +> 从API version 9开始废弃。 + **系统能力**：SystemCapability.FileManagement.File.FileIO **参数：** @@ -2014,6 +2283,10 @@ mkdtemp(prefix: string): Promise<string> 创建临时目录，使用Promise异步回调。 +> **说明**： +> +> 从API version 9开始废弃，请使用[fs.mkdtemp](js-apis-file-fs.md#fsmkdtemp)替代。 + **系统能力**：SystemCapability.FileManagement.File.FileIO **参数：** @@ -2045,6 +2318,10 @@ mkdtemp(prefix: string, callback: AsyncCallback<string>): void 创建临时目录，使用callback异步回调。 +> **说明**： +> +> 从API version 9开始废弃，请使用[fs.mkdtemp](js-apis-file-fs.md#fsmkdtemp-1)替代。 + **系统能力**：SystemCapability.FileManagement.File.FileIO **参数：** @@ -2069,6 +2346,10 @@ mkdtempSync(prefix: string): string 以同步的方法创建临时目录。 +> **说明**： +> +> 从API version 9开始废弃，请使用[fs.mkdtempSync](js-apis-file-fs.md#fsmkdtempsync)替代。 + **系统能力**：SystemCapability.FileManagement.File.FileIO **参数：** @@ -2096,6 +2377,10 @@ fchmod(fd: number, mode: number): Promise<void> 基于文件描述符改变文件权限，使用Promise异步回调。 +> **说明**： +> +> 从API version 9开始废弃。 + **系统能力**：SystemCapability.FileManagement.File.FileIO **参数：** @@ -2131,6 +2416,10 @@ fchmod(fd: number, mode: number, callback: AsyncCallback<void>): void 基于文件描述符改变文件权限，使用callback异步回调。 +> **说明**： +> +> 从API version 9开始废弃。 + **系统能力**：SystemCapability.FileManagement.File.FileIO **参数：** @@ -2159,6 +2448,10 @@ fchmodSync(fd: number, mode: number): void 以同步方法基于文件描述符改变文件权限。 +> **说明**： +> +> 从API version 9开始废弃。 + **系统能力**：SystemCapability.FileManagement.File.FileIO **参数：** @@ -2184,6 +2477,10 @@ createStream(path: string, mode: string): Promise<Stream> 基于文件路径打开文件流，使用Promise异步回调。 +> **说明**： +> +> 从API version 9开始废弃，请使用[fs.createStream](js-apis-file-fs.md#fscreatestream)替代。 + **系统能力**：SystemCapability.FileManagement.File.FileIO **参数：** @@ -2217,6 +2514,10 @@ createStream(path: string, mode: string, callback: AsyncCallback<Stream>): 基于文件路径打开文件流，使用callback异步回调。 +> **说明**： +> +> 从API version 9开始废弃，请使用[fs.createStream](js-apis-file-fs.md#fscreatestream-1)替代。 + **系统能力**：SystemCapability.FileManagement.File.FileIO **参数：** @@ -2243,6 +2544,10 @@ createStreamSync(path: string, mode: string): Stream 以同步方法基于文件路径打开文件流。 +> **说明**： +> +> 从API version 9开始废弃，请使用[fs.createStreamSync](js-apis-file-fs.md#fscreatestreamsync)替代。 + **系统能力**：SystemCapability.FileManagement.File.FileIO **参数：** @@ -2272,6 +2577,10 @@ fdopenStream(fd: number, mode: string): Promise<Stream> 基于文件描述符打开文件流，使用Promise异步回调。 +> **说明**： +> +> 从API version 9开始废弃，请使用[fs.fdopenStream](js-apis-file-fs.md#fsfdopenstream)替代。 + **系统能力**：SystemCapability.FileManagement.File.FileIO **参数：** @@ -2306,6 +2615,10 @@ fdopenStream(fd: number, mode: string, callback: AsyncCallback<Stream>): v 基于文件描述符打开文件流，使用callback异步回调。 +> **说明**： +> +> 从API version 9开始废弃，请使用[fs.fdopenStream](js-apis-file-fs.md#fsfdopenstream-1)替代。 + **系统能力**：SystemCapability.FileManagement.File.FileIO **参数：** @@ -2333,6 +2646,10 @@ fdopenStreamSync(fd: number, mode: string): Stream 以同步方法基于文件描述符打开文件流。 +> **说明**： +> +> 从API version 9开始废弃，请使用[fs.fdopenStreamSync](js-apis-file-fs.md#fsfdopenstreamsync)替代。 + **系统能力**：SystemCapability.FileManagement.File.FileIO **参数：** @@ -2363,6 +2680,10 @@ fchown(fd: number, uid: number, gid: number): Promise<void> 基于文件描述符改变文件所有者，使用Promise异步回调。 +> **说明**： +> +> 从API version 9开始废弃。 + **系统能力**：SystemCapability.FileManagement.File.FileIO **参数：** @@ -2399,6 +2720,10 @@ fchown(fd: number, uid: number, gid: number, callback: AsyncCallback<void> 基于文件描述符改变文件所有者，使用callback异步回调。 +> **说明**： +> +> 从API version 9开始废弃。 + **系统能力**：SystemCapability.FileManagement.File.FileIO **参数：** @@ -2428,6 +2753,10 @@ fchownSync(fd: number, uid: number, gid: number): void 以同步方法基于文件描述符改变文件所有者。 +> **说明**： +> +> 从API version 9开始废弃。 + **系统能力**：SystemCapability.FileManagement.File.FileIO **参数：** @@ -2454,6 +2783,10 @@ lchown(path: string, uid: number, gid: number): Promise<void> 基于文件路径改变文件所有者，更改符号链接本身的所有者，而不是符号链接所指向的实际文件，使用Promise异步回调。 +> **说明**： +> +> 从API version 9开始废弃。 + **系统能力**：SystemCapability.FileManagement.File.FileIO **参数：** @@ -2489,6 +2822,10 @@ lchown(path: string, uid: number, gid: number, callback: AsyncCallback<void&g 基于文件路径改变文件所有者，更改符号链接本身的所有者，而不是更改符号链接所指向的实际文件，使用callback异步回调。 +> **说明**： +> +> 从API version 9开始废弃。 + **系统能力**：SystemCapability.FileManagement.File.FileIO **参数：** @@ -2517,6 +2854,10 @@ lchownSync(path: string, uid: number, gid: number): void 以同步方法基于文件路径改变文件所有者，更改符号链接本身的所有者，而不是更改符号链接所指向的实际文件。 +> **说明**： +> +> 从API version 9开始废弃。 + **系统能力**：SystemCapability.FileManagement.File.FileIO **参数：** @@ -2573,6 +2914,10 @@ createWatcher(filename: string, events: number, callback: AsyncCallback<numbe 仅用于read方法，获取文件的读取结果。 +> **说明**： +> +> 从API version 9开始废弃。 + **系统能力**：以下各项对应的系统能力均为SystemCapability.FileManagement.File.FileIO。 | 名称 | 类型 | 可读 | 可写 | 说明 | @@ -2586,6 +2931,10 @@ createWatcher(filename: string, events: number, callback: AsyncCallback<numbe 文件具体信息，在调用Stat的方法前，需要先通过[stat()](#fileiostat)方法（同步或异步）来构建一个Stat实例。 +> **说明**： +> +> 从API version 9开始废弃，请使用[fs.Stat](js-apis-file-fs.md#stat)替代。 + **系统能力**：以下各项对应的系统能力均为SystemCapability.FileManagement.File.FileIO。 ### 属性 @@ -2612,6 +2961,10 @@ isBlockDevice(): boolean 用于判断文件是否是块特殊文件。一个块特殊文件只能以块为粒度进行访问，且访问的时候带缓存。 +> **说明**： +> +> 从API version 9开始废弃，请使用[fs.Stat.isBlockDevice](js-apis-file-fs.md#isblockdevice)替代。 + **系统能力**：SystemCapability.FileManagement.File.FileIO **返回值：** @@ -2634,6 +2987,10 @@ isCharacterDevice(): boolean 用于判断文件是否是字符特殊文件。一个字符特殊设备可进行随机访问，且访问的时候不带缓存。 +> **说明**： +> +> 从API version 9开始废弃，请使用[fs.Stat.isCharacterDevice](js-apis-file-fs.md#ischaracterdevice)替代。 + **系统能力**：SystemCapability.FileManagement.File.FileIO **返回值：** @@ -2656,6 +3013,10 @@ isDirectory(): boolean 用于判断文件是否是目录。 +> **说明**： +> +> 从API version 9开始废弃，请使用[fs.Stat.isDirectory](js-apis-file-fs.md#isdirectory)替代。 + **系统能力**：SystemCapability.FileManagement.File.FileIO **返回值：** @@ -2678,6 +3039,10 @@ isFIFO(): boolean 用于判断文件是否是命名管道（有时也称为FIFO）。命名管道通常用于进程间通信。 +> **说明**： +> +> 从API version 9开始废弃，请使用[fs.Stat.isFIFO](js-apis-file-fs.md#isfifo)替代。 + **系统能力**：SystemCapability.FileManagement.File.FileIO **返回值：** @@ -2700,6 +3065,10 @@ isFile(): boolean 用于判断文件是否是普通文件。 +> **说明**： +> +> 从API version 9开始废弃，请使用[fs.Stat.isFile](js-apis-file-fs.md#isfile)替代。 + **系统能力**：SystemCapability.FileManagement.File.FileIO **返回值：** @@ -2722,6 +3091,10 @@ isSocket(): boolean 用于判断文件是否是套接字。 +> **说明**： +> +> 从API version 9开始废弃，请使用[fs.Stat.isSocket](js-apis-file-fs.md#issocket)替代。 + **系统能力**：SystemCapability.FileManagement.File.FileIO **返回值：** @@ -2744,6 +3117,10 @@ isSymbolicLink(): boolean 用于判断文件是否是符号链接。 +> **说明**： +> +> 从API version 9开始废弃，请使用[fs.Stat.isSymbolicLink](js-apis-file-fs.md#issymboliclink)替代。 + **系统能力**：SystemCapability.FileManagement.File.FileIO **返回值：** @@ -2817,6 +3194,9 @@ stop(callback: AsyncCallback<void>): void 文件流，在调用Stream的方法前，需要先通过createStream()方法（同步或异步）来构建一个Stream实例。 +> **说明**： +> +> 从API version 9开始废弃，请使用[fs.Stream](js-apis-file-fs.md#stream)替代。 ### close7+ @@ -2824,6 +3204,10 @@ close(): Promise<void> 关闭文件流，使用Promise异步回调。 +> **说明**： +> +> 从API version 9开始废弃，请使用[fs.Stream.close](js-apis-file-fs.md#close)替代。 + **系统能力**：SystemCapability.FileManagement.File.FileIO **返回值：** @@ -2851,6 +3235,10 @@ close(callback: AsyncCallback<void>): void 异步关闭文件流，使用callback异步回调。 +> **说明**： +> +> 从API version 9开始废弃，请使用[fs.Stream.close](js-apis-file-fs.md#close-1)替代。 + **系统能力**：SystemCapability.FileManagement.File.FileIO **参数：** @@ -2876,6 +3264,10 @@ closeSync(): void 同步关闭文件流。 +> **说明**： +> +> 从API version 9开始废弃，请使用[fs.Stream.closeSync](js-apis-file-fs.md#closesync)替代。 + **系统能力**：SystemCapability.FileManagement.File.FileIO **示例：** @@ -2893,6 +3285,10 @@ flush(): Promise<void> 刷新文件流，使用Promise异步回调。 +> **说明**： +> +> 从API version 9开始废弃，请使用[fs.Stream.flush](js-apis-file-fs.md#flush)替代。 + **系统能力**：SystemCapability.FileManagement.File.FileIO **返回值：** @@ -2920,6 +3316,10 @@ flush(callback: AsyncCallback<void>): void 异步刷新文件流，使用callback异步回调。 +> **说明**： +> +> 从API version 9开始废弃，请使用[fs.Stream.flush](js-apis-file-fs.md#flush-1)替代。 + **系统能力**：SystemCapability.FileManagement.File.FileIO **参数：** @@ -2945,6 +3345,10 @@ flushSync(): void 同步刷新文件流。 +> **说明**： +> +> 从API version 9开始废弃，请使用[fs.Stream.flushSync](js-apis-file-fs.md#flushsync)替代。 + **系统能力**：SystemCapability.FileManagement.File.FileIO **示例：** @@ -2962,6 +3366,10 @@ write(buffer: ArrayBuffer|string, options?: { offset?: number; length?: number; 将数据写入流文件，使用Promise异步回调。 +> **说明**： +> +> 从API version 9开始废弃，请使用[fs.Stream.write](js-apis-file-fs.md#write)替代。 + **系统能力**：SystemCapability.FileManagement.File.FileIO **参数：** @@ -2996,6 +3404,10 @@ write(buffer: ArrayBuffer|string, options: { offset?: number; length?: number; p 将数据写入流文件，使用callback异步回调。 +> **说明**： +> +> 从API version 9开始废弃，请使用[fs.Stream.write](js-apis-file-fs.md#write-1)替代。 + **系统能力**：SystemCapability.FileManagement.File.FileIO **参数：** @@ -3026,6 +3438,10 @@ writeSync(buffer: ArrayBuffer|string, options?: { offset?: number; length?: numb 以同步方法将数据写入流文件。 +> **说明**： +> +> 从API version 9开始废弃，请使用[fs.Stream.writeSync](js-apis-file-fs.md#writesync)替代。 + **系统能力**：SystemCapability.FileManagement.File.FileIO **参数：** @@ -3056,6 +3472,10 @@ read(buffer: ArrayBuffer, options?: { position?: number; offset?: number; length 从流文件读取数据，使用Promise异步回调。 +> **说明**： +> +> 从API version 9开始废弃，请使用[fs.Stream.read](js-apis-file-fs.md#read)替代。 + **系统能力**：SystemCapability.FileManagement.File.FileIO **参数：** @@ -3091,6 +3511,10 @@ read(buffer: ArrayBuffer, options: { position?: number; offset?: number; length? 从流文件读取数据，使用callback异步回调。 +> **说明**： +> +> 从API version 9开始废弃，请使用[fs.Stream.read](js-apis-file-fs.md#read-1)替代。 + **系统能力**：SystemCapability.FileManagement.File.FileIO **参数：** @@ -3121,6 +3545,10 @@ readSync(buffer: ArrayBuffer, options?: { position?: number; offset?: number; le 以同步方法从流文件读取数据。 +> **说明**： +> +> 从API version 9开始废弃，请使用[fs.Stream.readSync](js-apis-file-fs.md#readsync)替代。 + **系统能力**：SystemCapability.FileManagement.File.FileIO **参数：** @@ -3149,6 +3577,9 @@ readSync(buffer: ArrayBuffer, options?: { position?: number; offset?: number; le 管理目录，在调用Dir的方法前，需要先通过opendir方法（同步或异步）来构建一个Dir实例。 +> **说明**： +> +> 从API version 9开始废弃，请使用[fs.listFile](js-apis-file-fs.md#fslistfile)替代。 ### read @@ -3156,6 +3587,10 @@ read(): Promise<Dirent> 读取下一个目录项，使用Promise异步回调。 +> **说明**： +> +> 从API version 9开始废弃，请使用[fs.listFile](js-apis-file-fs.md#fslistfile)替代。 + **系统能力**：SystemCapability.FileManagement.File.FileIO **返回值：** @@ -3181,6 +3616,10 @@ read(callback: AsyncCallback<Dirent>): void 读取下一个目录项，使用callback异步回调。 +> **说明**： +> +> 从API version 9开始废弃，请使用[fs.listFile](js-apis-file-fs.md#fslistfile-1)替代。 + **系统能力**：SystemCapability.FileManagement.File.FileIO **参数：** @@ -3207,6 +3646,10 @@ readSync(): Dirent 同步读取下一个目录项。 +> **说明**： +> +> 从API version 9开始废弃，请使用[fs.listFileSync](js-apis-file-fs.md#fslistfilesync)替代。 + **系统能力**：SystemCapability.FileManagement.File.FileIO **返回值：** @@ -3228,6 +3671,10 @@ close(): Promise<void> 异步关闭目录，使用promise形式返回结果。目录被关闭后，Dir中持有的文件描述将被释放，后续将无法从Dir中读取目录项。 +> **说明**： +> +> 从API version 9开始废弃，请使用[fs.listFile](js-apis-file-fs.md#fslistfile)替代。 + **系统能力**：SystemCapability.FileManagement.File.FileIO **示例：** @@ -3239,12 +3686,16 @@ close(): Promise<void> ``` - ### close7+ +### close7+ close(callback: AsyncCallback<void>): void 异步关闭目录，使用callback形式返回结果。目录被关闭后，Dir中持有的文件描述将被释放，后续将无法从Dir中读取目录项。 +> **说明**： +> +> 从API version 9开始废弃，请使用[fs.listFile](js-apis-file-fs.md#fslistfile-1)替代。 + **系统能力**：SystemCapability.FileManagement.File.FileIO **示例：** @@ -3262,6 +3713,10 @@ closeSync(): void 用于关闭目录。目录被关闭后，Dir中持有的文件描述将被释放，后续将无法从Dir中读取目录项。 +> **说明**： +> +> 从API version 9开始废弃，请使用[fs.listFileSync](js-apis-file-fs.md#fslistfilesync)替代。 + **系统能力**：SystemCapability.FileManagement.File.FileIO **示例：** @@ -3275,6 +3730,10 @@ closeSync(): void 在调用Dirent的方法前，需要先通过[dir.read()](#read)方法（同步或异步）来构建一个Dirent实例。 +> **说明**： +> +> 从API version 9开始废弃，请使用[fs.listFile](js-apis-file-fs.md#fslistfile)替代。 + **系统能力**：以下各项对应的系统能力均为SystemCapability.FileManagement.File.FileIO。 ### 属性 @@ -3290,6 +3749,10 @@ isBlockDevice(): boolean 用于判断当前目录项是否是块特殊文件。一个块特殊文件只能以块为粒度进行访问，且访问的时候带缓存。 +> **说明**： +> +> 从API version 9开始废弃。 + **系统能力**：SystemCapability.FileManagement.File.FileIO **返回值：** @@ -3312,6 +3775,10 @@ isCharacterDevice(): boolean 用于判断当前目录项是否是字符特殊设备。一个字符特殊设备可进行随机访问，且访问的时候不带缓存。 +> **说明**： +> +> 从API version 9开始废弃。 + **系统能力**：SystemCapability.FileManagement.File.FileIO **返回值：** @@ -3334,6 +3801,10 @@ isDirectory(): boolean 用于判断当前目录项是否是目录。 +> **说明**： +> +> 从API version 9开始废弃。 + **系统能力**：SystemCapability.FileManagement.File.FileIO **返回值：** @@ -3356,6 +3827,10 @@ isFIFO(): boolean 用于判断当前目录项是否是命名管道（有时也称为FIFO）。命名管道通常用于进程间通信。 +> **说明**： +> +> 从API version 9开始废弃。 + **系统能力**：SystemCapability.FileManagement.File.FileIO **返回值：** @@ -3378,6 +3853,10 @@ isFile(): boolean 用于判断当前目录项是否是普通文件。 +> **说明**： +> +> 从API version 9开始废弃。 + **系统能力**：SystemCapability.FileManagement.File.FileIO **返回值：** @@ -3400,6 +3879,10 @@ isSocket(): boolean 用于判断当前目录项是否是套接字。 +> **说明**： +> +> 从API version 9开始废弃。 + **系统能力**：SystemCapability.FileManagement.File.FileIO **返回值：** @@ -3422,6 +3905,10 @@ isSymbolicLink(): boolean 用于判断当前目录项是否是符号链接。 +> **说明**： +> +> 从API version 9开始废弃。 + **系统能力**：SystemCapability.FileManagement.File.FileIO **返回值：** -- GitLab