diff --git a/en/application-dev/reference/apis/js-apis-file-fs.md b/en/application-dev/reference/apis/js-apis-file-fs.md
index 3c95006e9d1aa02c34f8e31ad91fc6a53b6cf1da..c8ed1ccd4af2aaf2713c98388b65c991e4c24c06 100644
--- a/en/application-dev/reference/apis/js-apis-file-fs.md
+++ b/en/application-dev/reference/apis/js-apis-file-fs.md
@@ -2,7 +2,8 @@
The **fs** module provides APIs for file operations, including basic file management, directory management, file information statistics, and data read and write using a stream.
-> **NOTE**
+> **NOTE**
+>
> The initial APIs of this module are supported since API version 9. Newly added APIs will be marked with a superscript to indicate their earliest API version.
## Modules to Import
@@ -11,10 +12,6 @@ The **fs** module provides APIs for file operations, including basic file manage
import fs from '@ohos.file.fs';
```
-## Error Code Description
-
-The APIs of this module supports processing of error codes. For details about the error codes, see [File Management Error Codes](../errorcodes/errorcode-filemanagement.md).
-
## Guidelines
Before using the APIs provided by this module to perform operations on a file or folder, obtain the application sandbox path of the file or folder as follows:
@@ -61,9 +58,13 @@ Obtains detailed file information. This API uses a promise to return the result.
**Return value**
- | Type | Description |
- | ---------------------------- | ---------- |
- | Promise<[Stat](#stat)> | Promise used to return the file information obtained.|
+| Type | Description |
+| ---------------------------- | ---------- |
+| Promise<[Stat](#stat)> | Promise used to return the file information obtained.|
+
+**Error codes**
+
+For details about error codes, see "Basic File I/O Error Codes" in [File Management Error Codes](../errorcodes/errorcode-filemanagement.md).
**Example**
@@ -91,6 +92,10 @@ Obtains detailed file information. This API uses an asynchronous callback to ret
| file | string\|number | Yes | Application sandbox path or FD of the file. |
| callback | AsyncCallback<[Stat](#stat)> | Yes | Callback invoked to return the file information obtained.|
+**Error codes**
+
+For details about error codes, see "Basic File I/O Error Codes" in [File Management Error Codes](../errorcodes/errorcode-filemanagement.md).
+
**Example**
```js
@@ -117,12 +122,15 @@ Obtains detailed file information synchronously.
| ------ | ------ | ---- | -------------------------- |
| file | string\|number | Yes | Application sandbox path or FD of the file.|
-
**Return value**
- | Type | Description |
- | ------------- | ---------- |
- | [Stat](#stat) | File information obtained.|
+| Type | Description |
+| ------------- | ---------- |
+| [Stat](#stat) | File information obtained.|
+
+**Error codes**
+
+For details about error codes, see "Basic File I/O Error Codes" in [File Management Error Codes](../errorcodes/errorcode-filemanagement.md).
**Example**
@@ -147,9 +155,13 @@ Checks whether a file exists. This API uses a promise to return the result.
**Return value**
- | Type | Description |
- | ------------------- | ---------------------------- |
- | Promise<boolean> | Promise used to return the result. The value **true** means the file exists; the value **false** means the opposite.|
+| Type | Description |
+| ------------------- | ---------------------------- |
+| Promise<boolean> | Promise used to return the result. The value **true** means the file exists; the value false means the opposite.|
+
+**Error codes**
+
+For details about error codes, see "Basic File I/O Error Codes" in [File Management Error Codes](../errorcodes/errorcode-filemanagement.md).
**Example**
@@ -164,7 +176,6 @@ Checks whether a file exists. This API uses a promise to return the result.
});
```
-
## fs.access
access(path: string, callback: AsyncCallback<boolean>): void
@@ -178,7 +189,11 @@ Checks whether a file exists. This API uses an asynchronous callback to return t
| Name | Type | Mandatory| Description |
| -------- | ------------------------- | ---- | ------------------------------------------------------------ |
| path | string | Yes | Application sandbox path of the file. |
-| callback | AsyncCallback<boolean> | Yes | Callback invoked to return the result. |
+| callback | AsyncCallback<boolean> | Yes | Callback invoked to return the result. The value **true** means the file exists; the value **false** means the opposite.|
+
+**Error codes**
+
+For details about error codes, see "Basic File I/O Error Codes" in [File Management Error Codes](../errorcodes/errorcode-filemanagement.md).
**Example**
@@ -211,9 +226,13 @@ Synchronously checks whether a file exists.
**Return value**
- | Type | Description |
- | ------------------- | ---------------------------- |
- | boolean | Returns **true** if the file exists; returns **false** otherwise.|
+| Type | Description |
+| ------------------- | ---------------------------- |
+| boolean | Returns **true** if the file exists; returns **false** otherwise.|
+
+**Error codes**
+
+For details about error codes, see "Basic File I/O Error Codes" in [File Management Error Codes](../errorcodes/errorcode-filemanagement.md).
**Example**
@@ -240,15 +259,19 @@ Closes a file. This API uses a promise to return the result.
**Parameters**
- | Name | Type | Mandatory | Description |
- | ---- | ------ | ---- | ------------ |
- | file | [File](#file)\|number | Yes | File object or FD of the file to close.|
+| Name | Type | Mandatory | Description |
+| ---- | ------ | ---- | ------------ |
+| file | [File](#file)\|number | Yes | File object or FD of the file to close.|
**Return value**
- | Type | Description |
- | ------------------- | ---------------------------- |
- | Promise<void> | Promise that returns no value.|
+| Type | Description |
+| ------------------- | ---------------------------- |
+| Promise<void> | Promise that returns no value.|
+
+**Error codes**
+
+For details about error codes, see "Basic File I/O Error Codes" in [File Management Error Codes](../errorcodes/errorcode-filemanagement.md).
**Example**
@@ -273,10 +296,14 @@ Closes a file. This API uses an asynchronous callback to return the result.
**Parameters**
- | Name | Type | Mandatory | Description |
- | -------- | ------------------------- | ---- | ------------ |
- | file | [File](#file)\|number | Yes | File object or FD of the file to close.|
- | callback | AsyncCallback<void> | Yes | Callback invoked when the file is closed asynchronously.|
+| Name | Type | Mandatory | Description |
+| -------- | ------------------------- | ---- | ------------ |
+| file | [File](#file)\|number | Yes | File object or FD of the file to close.|
+| callback | AsyncCallback<void> | Yes | Callback invoked when the file is closed asynchronously.|
+
+**Error codes**
+
+For details about error codes, see "Basic File I/O Error Codes" in [File Management Error Codes](../errorcodes/errorcode-filemanagement.md).
**Example**
@@ -302,9 +329,13 @@ Synchronously closes a file.
**Parameters**
- | Name | Type | Mandatory | Description |
- | ---- | ------ | ---- | ------------ |
- | file | [File](#file)\|number | Yes | File object or FD of the file to close.|
+| Name | Type | Mandatory | Description |
+| ---- | ------ | ---- | ------------ |
+| file | [File](#file)\|number | Yes | File object or FD of the file to close.|
+
+**Error codes**
+
+For details about error codes, see "Basic File I/O Error Codes" in [File Management Error Codes](../errorcodes/errorcode-filemanagement.md).
**Example**
@@ -324,17 +355,21 @@ Copies a file. This API uses a promise to return the result.
**Parameters**
- | Name | Type | Mandatory | Description |
- | ---- | -------------------------- | ---- | ---------------------------------------- |
- | src | string\|number | Yes | Path or FD of the file to copy. |
- | dest | string\|number | Yes | Destination path of the file or FD of the file created. |
- | mode | number | No | Whether to overwrite the file of the same name in the destination path. The default value is **0**, which is the only value supported.
**0**: overwrite the file of the same name.|
+| Name | Type | Mandatory | Description |
+| ---- | -------------------------- | ---- | ---------------------------------------- |
+| src | string\|number | Yes | Path or FD of the file to copy. |
+| dest | string\|number | Yes | Destination path of the file or FD of the file created. |
+| mode | number | No | Whether to overwrite the file of the same name in the destination path. The default value is **0**, which is the only value supported.
**0**: overwrite the file of the same name.|
**Return value**
- | Type | Description |
- | ------------------- | ---------------------------- |
- | Promise<void> | Promise that returns no value.|
+| Type | Description |
+| ------------------- | ---------------------------- |
+| Promise<void> | Promise that returns no value.|
+
+**Error codes**
+
+For details about error codes, see "Basic File I/O Error Codes" in [File Management Error Codes](../errorcodes/errorcode-filemanagement.md).
**Example**
@@ -358,12 +393,16 @@ Copies a file. This API uses an asynchronous callback to return the result.
**Parameters**
- | Name | Type | Mandatory | Description |
- | -------- | -------------------------- | ---- | ---------------------------------------- |
- | src | string\|number | Yes | Path or FD of the file to copy. |
- | dest | string\|number | Yes | Destination path of the file or FD of the file created. |
- | mode | number | No | Whether to overwrite the file of the same name in the destination path. The default value is **0**, which is the only value supported.
**0**: overwrite the file with the same name and truncate the part that is not overwritten.|
- | callback | AsyncCallback<void> | Yes | Callback invoked when the file is copied asynchronously. |
+| Name | Type | Mandatory | Description |
+| -------- | -------------------------- | ---- | ---------------------------------------- |
+| src | string\|number | Yes | Path or FD of the file to copy. |
+| dest | string\|number | Yes | Destination path of the file or FD of the file created. |
+| mode | number | No | Whether to overwrite the file of the same name in the destination path. The default value is **0**, which is the only value supported.
**0**: overwrite the file with the same name and truncate the part that is not overwritten.|
+| callback | AsyncCallback<void> | Yes | Callback invoked when the file is copied asynchronously. |
+
+**Error codes**
+
+For details about error codes, see "Basic File I/O Error Codes" in [File Management Error Codes](../errorcodes/errorcode-filemanagement.md).
**Example**
@@ -390,11 +429,15 @@ Synchronously copies a file.
**Parameters**
- | Name | Type | Mandatory | Description |
- | ---- | -------------------------- | ---- | ---------------------------------------- |
- | src | string\|number | Yes | Path or FD of the file to copy. |
- | dest | string\|number | Yes | Destination path of the file or FD of the file created. |
- | mode | number | No | Whether to overwrite the file of the same name in the destination path. The default value is **0**, which is the only value supported.
**0**: overwrite the file with the same name and truncate the part that is not overwritten.|
+| Name | Type | Mandatory | Description |
+| ---- | -------------------------- | ---- | ---------------------------------------- |
+| src | string\|number | Yes | Path or FD of the file to copy. |
+| dest | string\|number | Yes | Destination path of the file or FD of the file created. |
+| mode | number | No | Whether to overwrite the file of the same name in the destination path. The default value is **0**, which is the only value supported.
**0**: overwrite the file with the same name and truncate the part that is not overwritten.|
+
+**Error codes**
+
+For details about error codes, see "Basic File I/O Error Codes" in [File Management Error Codes](../errorcodes/errorcode-filemanagement.md).
**Example**
@@ -404,7 +447,6 @@ Synchronously copies a file.
fs.copyFileSync(srcPath, dstPath);
```
-
## fs.mkdir
mkdir(path: string): Promise<void>
@@ -421,9 +463,13 @@ Creates a directory. This API uses a promise to return the result.
**Return value**
- | Type | Description |
- | ------------------- | ---------------------------- |
- | Promise<void> | Promise that returns no value.|
+| Type | Description |
+| ------------------- | ---------------------------- |
+| Promise<void> | Promise that returns no value.|
+
+**Error codes**
+
+For details about error codes, see "Basic File I/O Error Codes" in [File Management Error Codes](../errorcodes/errorcode-filemanagement.md).
**Example**
@@ -436,7 +482,6 @@ Creates a directory. This API uses a promise to return the result.
});
```
-
## fs.mkdir
mkdir(path: string, callback: AsyncCallback<void>): void
@@ -452,6 +497,10 @@ Creates a directory. This API uses an asynchronous callback to return the result
| path | string | Yes | Application sandbox path of the directory. |
| callback | AsyncCallback<void> | Yes | Callback invoked when the directory is created asynchronously. |
+**Error codes**
+
+For details about error codes, see "Basic File I/O Error Codes" in [File Management Error Codes](../errorcodes/errorcode-filemanagement.md).
+
**Example**
```js
@@ -465,7 +514,6 @@ Creates a directory. This API uses an asynchronous callback to return the result
});
```
-
## fs.mkdirSync
mkdirSync(path: string): void
@@ -480,6 +528,10 @@ Synchronously creates a directory.
| ------ | ------ | ---- | ------------------------------------------------------------ |
| path | string | Yes | Application sandbox path of the directory. |
+**Error codes**
+
+For details about error codes, see "Basic File I/O Error Codes" in [File Management Error Codes](../errorcodes/errorcode-filemanagement.md).
+
**Example**
```js
@@ -487,7 +539,6 @@ Synchronously creates a directory.
fs.mkdirSync(dirPath);
```
-
## fs.open
open(path: string, mode?: number): Promise<File>
@@ -505,9 +556,13 @@ Opens a file. This API uses a promise to return the result. File uniform resourc
**Return value**
- | Type | Description |
- | --------------------- | ----------- |
- | Promise<[File](#file)> | Promise used to return the file object.|
+| Type | Description |
+| --------------------- | ----------- |
+| Promise<[File](#file)> | Promise used to return the file object.|
+
+**Error codes**
+
+For details about error codes, see "Basic File I/O Error Codes" in [File Management Error Codes](../errorcodes/errorcode-filemanagement.md).
**Example**
@@ -536,6 +591,10 @@ Opens a file. This API uses an asynchronous callback to return the result. File
| path | string | Yes | Application sandbox path or URI of the file. |
| mode | number | No | [Mode](#openmode) for opening the file. You must specify one of the following options. By default, the file is open in read-only mode.
- **OpenMode.READ_ONLY(0o0)**: Open the file in read-only mode.
- **OpenMode.WRITE_ONLY(0o1)**: Open the file in write-only mode.
- **OpenMode.READ_WRITE(0o2)**: Open the file in read/write mode.
You can also specify the following options, separated by a bitwise OR operator (|). By default, no additional options are given.
- **OpenMode.CREATE(0o100)**: If the file does not exist, create it.
- **OpenMode.TRUNC(0o1000)**: If the file exists and is open in write-only or read/write mode, truncate the file length to 0.
- **OpenMode.APPEND(0o2000)**: Open the file in append mode. New data will be added to the end of the file.
- **OpenMode.NONBLOCK(0o4000)**: If **path** points to a named pipe (also known as a FIFO), block special file, or character special file, perform non-blocking operations on the open file and in subsequent I/Os.
- **OpenMode.DIR(0o200000)**: If **path** does not point to a directory, throw an exception.
- **OpenMode.NOFOLLOW(0o400000)**: If **path** points to a symbolic link, throw an exception.
- **OpenMode.SYNC(0o4010000)**: Open the file in synchronous I/O mode.|
+**Error codes**
+
+For details about error codes, see "Basic File I/O Error Codes" in [File Management Error Codes](../errorcodes/errorcode-filemanagement.md).
+
**Example**
```js
@@ -566,9 +625,13 @@ Synchronously opens a file. File URIs are supported.
**Return value**
- | Type | Description |
- | ------ | ----------- |
- | [File](#file) | File object opened.|
+| Type | Description |
+| ------ | ----------- |
+| [File](#file) | File object opened.|
+
+**Error codes**
+
+For details about error codes, see "Basic File I/O Error Codes" in [File Management Error Codes](../errorcodes/errorcode-filemanagement.md).
**Example**
@@ -597,9 +660,13 @@ Reads data from a file. This API uses a promise to return the result.
**Return value**
- | Type | Description |
- | ---------------------------------- | ------ |
- | Promise<number> | Promise used to return the data read.|
+| Type | Description |
+| ---------------------------------- | ------ |
+| Promise<number> | Promise used to return the data read.|
+
+**Error codes**
+
+For details about error codes, see "Basic File I/O Error Codes" in [File Management Error Codes](../errorcodes/errorcode-filemanagement.md).
**Example**
@@ -626,12 +693,16 @@ Reads data from a file. This API uses an asynchronous callback to return the res
**Parameters**
- | Name | Type | Mandatory | Description |
- | -------- | ---------------------------------------- | ---- | ---------------------------------------- |
- | fd | number | Yes | FD of the file. |
- | buffer | ArrayBuffer | Yes | Buffer used to store the file data read. |
- | options | Object | No | The options are as follows:
- **offset** (number): position of the data to read in the file. This parameter is optional. By default, data is read from the current position.
- **length** (number): length of the data to read. This parameter is optional. The default value is the buffer length.|
- | callback | AsyncCallback<number> | Yes | Callback invoked when the data is read asynchronously. |
+| Name | Type | Mandatory | Description |
+| -------- | ---------------------------------------- | ---- | ---------------------------------------- |
+| fd | number | Yes | FD of the file. |
+| buffer | ArrayBuffer | Yes | Buffer used to store the file data read. |
+| options | Object | No | The options are as follows:
- **offset** (number): position of the data to read in the file. This parameter is optional. By default, data is read from the current position.
- **length** (number): length of the data to read. This parameter is optional. The default value is the buffer length.|
+| callback | AsyncCallback<number> | Yes | Callback invoked when the data is read asynchronously. |
+
+**Error codes**
+
+For details about error codes, see "Basic File I/O Error Codes" in [File Management Error Codes](../errorcodes/errorcode-filemanagement.md).
**Example**
@@ -650,7 +721,6 @@ Reads data from a file. This API uses an asynchronous callback to return the res
});
```
-
## fs.readSync
readSync(fd: number, buffer: ArrayBuffer, options?: { offset?: number; length?: number; }): number
@@ -661,17 +731,21 @@ Synchronously reads data from a file.
**Parameters**
- | Name | Type | Mandatory | Description |
- | ------- | ----------- | ---- | ---------------------------------------- |
- | fd | number | Yes | FD of the file. |
- | buffer | ArrayBuffer | Yes | Buffer used to store the file data read. |
- | options | Object | No | The options are as follows:
- **offset** (number): position of the data to read in the file. This parameter is optional. By default, data is read from the current position.
- **length** (number): length of the data to read. This parameter is optional. The default value is the buffer length.|
+| Name | Type | Mandatory | Description |
+| ------- | ----------- | ---- | ---------------------------------------- |
+| fd | number | Yes | FD of the file. |
+| buffer | ArrayBuffer | Yes | Buffer used to store the file data read. |
+| options | Object | No | The options are as follows:
- **offset** (number): position of the data to read in the file. This parameter is optional. By default, data is read from the current position.
- **length** (number): length of the data to read. This parameter is optional. The default value is the buffer length.|
**Return value**
- | Type | Description |
- | ------ | -------- |
- | number | Length of the data read.|
+| Type | Description |
+| ------ | -------- |
+| number | Length of the data read.|
+
+**Error codes**
+
+For details about error codes, see "Basic File I/O Error Codes" in [File Management Error Codes](../errorcodes/errorcode-filemanagement.md).
**Example**
@@ -683,7 +757,6 @@ Synchronously reads data from a file.
fs.closeSync(file);
```
-
## fs.rmdir
rmdir(path: string): Promise<void>
@@ -700,9 +773,13 @@ Deletes a directory. This API uses a promise to return the result.
**Return value**
- | Type | Description |
- | ------------------- | ---------------------------- |
- | Promise<void> | Promise that returns no value.|
+| Type | Description |
+| ------------------- | ---------------------------- |
+| Promise<void> | Promise that returns no value.|
+
+**Error codes**
+
+For details about error codes, see "Basic File I/O Error Codes" in [File Management Error Codes](../errorcodes/errorcode-filemanagement.md).
**Example**
@@ -715,7 +792,6 @@ Deletes a directory. This API uses a promise to return the result.
});
```
-
## fs.rmdir
rmdir(path: string, callback: AsyncCallback<void>): void
@@ -731,6 +807,10 @@ Deletes a directory. This API uses an asynchronous callback to return the result
| path | string | Yes | Application sandbox path of the directory.|
| callback | AsyncCallback<void> | Yes | Callback invoked when the directory is deleted asynchronously. |
+**Error codes**
+
+For details about error codes, see "Basic File I/O Error Codes" in [File Management Error Codes](../errorcodes/errorcode-filemanagement.md).
+
**Example**
```js
@@ -744,7 +824,6 @@ Deletes a directory. This API uses an asynchronous callback to return the result
});
```
-
## fs.rmdirSync
rmdirSync(path: string): void
@@ -759,6 +838,10 @@ Synchronously deletes a directory.
| ------ | ------ | ---- | -------------------------- |
| path | string | Yes | Application sandbox path of the directory.|
+**Error codes**
+
+For details about error codes, see "Basic File I/O Error Codes" in [File Management Error Codes](../errorcodes/errorcode-filemanagement.md).
+
**Example**
```js
@@ -766,7 +849,6 @@ Synchronously deletes a directory.
fs.rmdirSync(dirPath);
```
-
## fs.unlink
unlink(path: string): Promise<void>
@@ -783,9 +865,13 @@ Deletes a file. This API uses a promise to return the result.
**Return value**
- | Type | Description |
- | ------------------- | ---------------------------- |
- | Promise<void> | Promise that returns no value.|
+| Type | Description |
+| ------------------- | ---------------------------- |
+| Promise<void> | Promise that returns no value.|
+
+**Error codes**
+
+For details about error codes, see "Basic File I/O Error Codes" in [File Management Error Codes](../errorcodes/errorcode-filemanagement.md).
**Example**
@@ -798,7 +884,6 @@ Deletes a file. This API uses a promise to return the result.
});
```
-
## fs.unlink
unlink(path: string, callback: AsyncCallback<void>): void
@@ -814,6 +899,10 @@ Deletes a file. This API uses an asynchronous callback to return the result.
| path | string | Yes | Application sandbox path of the file.|
| callback | AsyncCallback<void> | Yes | Callback invoked when the file is deleted asynchronously. |
+**Error codes**
+
+For details about error codes, see "Basic File I/O Error Codes" in [File Management Error Codes](../errorcodes/errorcode-filemanagement.md).
+
**Example**
```js
@@ -827,7 +916,6 @@ Deletes a file. This API uses an asynchronous callback to return the result.
});
```
-
## fs.unlinkSync
unlinkSync(path: string): void
@@ -842,6 +930,10 @@ Synchronously deletes a file.
| ------ | ------ | ---- | -------------------------- |
| path | string | Yes | Application sandbox path of the file.|
+**Error codes**
+
+For details about error codes, see "Basic File I/O Error Codes" in [File Management Error Codes](../errorcodes/errorcode-filemanagement.md).
+
**Example**
```js
@@ -860,17 +952,21 @@ Writes data into a file. This API uses a promise to return the result.
**Parameters**
- | Name | Type | Mandatory | Description |
- | ------- | ------------------------------- | ---- | ---------------------------------------- |
- | fd | number | Yes | FD of the file. |
- | buffer | ArrayBuffer\|string | Yes | Data to write. It can be a string or data from a buffer. |
- | options | Object | No | The options are as follows:
- **offset** (number): start position to write the data in the file. This parameter is optional. By default, data is written from the current position.
- **length** (number): length of the data to write. This parameter is optional. The default value is the buffer length.
- **encoding** (string): format of the data to be encoded when the data is a string. The default value is **'utf-8'**, which is the only value supported.|
+| Name | Type | Mandatory | Description |
+| ------- | ------------------------------- | ---- | ---------------------------------------- |
+| fd | number | Yes | FD of the file. |
+| buffer | ArrayBuffer\|string | Yes | Data to write. It can be a string or data from a buffer. |
+| options | Object | No | The options are as follows:
- **offset** (number): start position to write the data in the file. This parameter is optional. By default, data is written from the current position.
- **length** (number): length of the data to write. This parameter is optional. The default value is the buffer length.
- **encoding** (string): format of the data to be encoded when the data is a string. The default value is **'utf-8'**, which is the only value supported.|
**Return value**
- | Type | Description |
- | --------------------- | -------- |
- | Promise<number> | Promise used to return the length of the data written.|
+| Type | Description |
+| --------------------- | -------- |
+| Promise<number> | Promise used to return the length of the data written.|
+
+**Error codes**
+
+For details about error codes, see "Basic File I/O Error Codes" in [File Management Error Codes](../errorcodes/errorcode-filemanagement.md).
**Example**
@@ -885,7 +981,6 @@ Writes data into a file. This API uses a promise to return the result.
});
```
-
## fs.write
write(fd: number, buffer: ArrayBuffer|string, options?: { offset?: number; length?: number; encoding?: string; }, callback: AsyncCallback<number>): void
@@ -896,12 +991,16 @@ Writes data into a file. This API uses an asynchronous callback to return the re
**Parameters**
- | Name | Type | Mandatory | Description |
- | -------- | ------------------------------- | ---- | ---------------------------------------- |
- | fd | number | Yes | FD of the file. |
- | buffer | ArrayBuffer\|string | Yes | Data to write. It can be a string or data from a buffer. |
- | options | Object | No | The options are as follows:
- **offset** (number): start position to write the data in the file. This parameter is optional. By default, data is written from the current position.
- **length** (number): length of the data to write. This parameter is optional. The default value is the buffer length.
- **encoding** (string): format of the data to be encoded when the data is a string. The default value is **'utf-8'**, which is the only value supported.|
- | callback | AsyncCallback<number> | Yes | Callback invoked when the data is written asynchronously. |
+| Name | Type | Mandatory | Description |
+| -------- | ------------------------------- | ---- | ---------------------------------------- |
+| fd | number | Yes | FD of the file. |
+| buffer | ArrayBuffer\|string | Yes | Data to write. It can be a string or data from a buffer. |
+| options | Object | No | The options are as follows:
- **offset** (number): start position to write the data in the file. This parameter is optional. By default, data is written from the current position.
- **length** (number): length of the data to write. This parameter is optional. The default value is the buffer length.
- **encoding** (string): format of the data to be encoded when the data is a string. The default value is **'utf-8'**, which is the only value supported.|
+| callback | AsyncCallback<number> | Yes | Callback invoked when the data is written asynchronously. |
+
+**Error codes**
+
+For details about error codes, see "Basic File I/O Error Codes" in [File Management Error Codes](../errorcodes/errorcode-filemanagement.md).
**Example**
@@ -918,7 +1017,6 @@ Writes data into a file. This API uses an asynchronous callback to return the re
});
```
-
## fs.writeSync
writeSync(fd: number, buffer: ArrayBuffer|string, options?: { offset?: number; length?: number; encoding?: string; }): number
@@ -929,17 +1027,21 @@ Synchronously writes data into a file.
**Parameters**
- | Name | Type | Mandatory | Description |
- | ------- | ------------------------------- | ---- | ---------------------------------------- |
- | fd | number | Yes | FD of the file. |
- | buffer | ArrayBuffer\|string | Yes | Data to write. It can be a string or data from a buffer. |
- | options | Object | No | The options are as follows:
- **offset** (number): start position to write the data in the file. This parameter is optional. By default, data is written from the current position.
- **length** (number): length of the data to write. This parameter is optional. The default value is the buffer length.
- **encoding** (string): format of the data to be encoded when the data is a string. The default value is **'utf-8'**, which is the only value supported.|
+| Name | Type | Mandatory | Description |
+| ------- | ------------------------------- | ---- | ---------------------------------------- |
+| fd | number | Yes | FD of the file. |
+| buffer | ArrayBuffer\|string | Yes | Data to write. It can be a string or data from a buffer. |
+| options | Object | No | The options are as follows:
- **offset** (number): start position to write the data in the file. This parameter is optional. By default, data is written from the current position.
- **length** (number): length of the data to write. This parameter is optional. The default value is the buffer length.
- **encoding** (string): format of the data to be encoded when the data is a string. The default value is **'utf-8'**, which is the only value supported.|
**Return value**
- | Type | Description |
- | ------ | -------- |
- | number | Length of the data written in the file.|
+| Type | Description |
+| ------ | -------- |
+| number | Length of the data written in the file.|
+
+**Error codes**
+
+For details about error codes, see "Basic File I/O Error Codes" in [File Management Error Codes](../errorcodes/errorcode-filemanagement.md).
**Example**
@@ -968,9 +1070,13 @@ Truncates a file. This API uses a promise to return the result.
**Return value**
- | Type | Description |
- | ------------------- | ---------------------------- |
- | Promise<void> | Promise that returns no value.|
+| Type | Description |
+| ------------------- | ---------------------------- |
+| Promise<void> | Promise that returns no value.|
+
+**Error codes**
+
+For details about error codes, see "Basic File I/O Error Codes" in [File Management Error Codes](../errorcodes/errorcode-filemanagement.md).
**Example**
@@ -984,7 +1090,6 @@ Truncates a file. This API uses a promise to return the result.
});
```
-
## fs.truncate
truncate(file: string|number, len?: number, callback: AsyncCallback<void>): void
@@ -1001,6 +1106,10 @@ Truncates a file. This API uses an asynchronous callback to return the result.
| len | number | No | File length, in bytes, after truncation. The default value is **0**.|
| callback | AsyncCallback<void> | Yes | Callback that returns no value. |
+**Error codes**
+
+For details about error codes, see "Basic File I/O Error Codes" in [File Management Error Codes](../errorcodes/errorcode-filemanagement.md).
+
**Example**
```js
@@ -1015,7 +1124,6 @@ Truncates a file. This API uses an asynchronous callback to return the result.
});
```
-
## fs.truncateSync
truncateSync(file: string|number, len?: number): void
@@ -1031,6 +1139,10 @@ Synchronously truncates a file.
| file | string\|number | Yes | Application sandbox path or FD of the file. |
| len | number | No | File length, in bytes, after truncation. The default value is **0**.|
+**Error codes**
+
+For details about error codes, see "Basic File I/O Error Codes" in [File Management Error Codes](../errorcodes/errorcode-filemanagement.md).
+
**Example**
```js
@@ -1039,7 +1151,6 @@ Synchronously truncates a file.
fs.truncateSync(filePath, len);
```
-
## fs.readText
readText(filePath: string, options?: { offset?: number; length?: number; encoding?: string; }): Promise<string>
@@ -1057,9 +1168,13 @@ Reads the text content of a file. This API uses a promise to return the result.
**Return value**
- | Type | Description |
- | --------------------- | ---------- |
- | Promise<string> | Promise used to return the content read.|
+| Type | Description |
+| --------------------- | ---------- |
+| Promise<string> | Promise used to return the content read.|
+
+**Error codes**
+
+For details about error codes, see "Basic File I/O Error Codes" in [File Management Error Codes](../errorcodes/errorcode-filemanagement.md).
**Example**
@@ -1072,7 +1187,6 @@ Reads the text content of a file. This API uses a promise to return the result.
});
```
-
## fs.readText
readText(filePath: string, options?: { offset?: number; length?: number; encoding?: string; }, callback: AsyncCallback<string>): void
@@ -1089,6 +1203,10 @@ Reads the text content of a file. This API uses an asynchronous callback to retu
| options | Object | No | The options are as follows:
- **offset** (number): position of the data to read in the file. This parameter is optional. By default, data is read from the current position.
- **length** (number): length of the data to read. This parameter is optional. The default value is the file length.
- **encoding** (string): format of the string to be encoded. The default value is **'utf-8'**, which is the only value supported.|
| callback | AsyncCallback<string> | Yes | Callback invoked to return the content read. |
+**Error codes**
+
+For details about error codes, see "Basic File I/O Error Codes" in [File Management Error Codes](../errorcodes/errorcode-filemanagement.md).
+
**Example**
```js
@@ -1102,7 +1220,6 @@ Reads the text content of a file. This API uses an asynchronous callback to retu
});
```
-
## fs.readTextSync
readTextSync(filePath: string, options?: { offset?: number; length?: number; encoding?: string; }): string
@@ -1120,9 +1237,13 @@ Synchronously reads the text of a file.
**Return value**
- | Type | Description |
- | ------ | -------------------- |
- | string | Promise used to return the content of the file read.|
+| Type | Description |
+| ------ | -------------------- |
+| string | Promise used to return the content of the file read.|
+
+**Error codes**
+
+For details about error codes, see "Basic File I/O Error Codes" in [File Management Error Codes](../errorcodes/errorcode-filemanagement.md).
**Example**
@@ -1148,9 +1269,13 @@ Obtains information about a symbolic link. This API uses a promise to return the
**Return value**
- | Type | Description |
- | ---------------------------- | ---------- |
- | Promise<[Stat](#stat)> | Promise used to return the symbolic link information obtained. For details, see **stat**.|
+| Type | Description |
+| ---------------------------- | ---------- |
+| Promise<[Stat](#stat)> | Promise used to return the symbolic link information obtained. For details, see **stat**.|
+
+**Error codes**
+
+For details about error codes, see "Basic File I/O Error Codes" in [File Management Error Codes](../errorcodes/errorcode-filemanagement.md).
**Example**
@@ -1163,7 +1288,6 @@ Obtains information about a symbolic link. This API uses a promise to return the
});
```
-
## fs.lstat
lstat(path: string, callback: AsyncCallback<Stat>): void
@@ -1179,6 +1303,10 @@ Obtains information about a symbolic link. This API uses an asynchronous callbac
| path | string | Yes | Application sandbox path of the file.|
| callback | AsyncCallback<[Stat](#stat)> | Yes | Callback invoked to return the symbolic link information obtained. |
+**Error codes**
+
+For details about error codes, see "Basic File I/O Error Codes" in [File Management Error Codes](../errorcodes/errorcode-filemanagement.md).
+
**Example**
```js
@@ -1208,9 +1336,13 @@ Obtains information about a symbolic link synchronously.
**Return value**
- | Type | Description |
- | ------------- | ---------- |
- | [Stat](#stat) | File information obtained.|
+| Type | Description |
+| ------------- | ---------- |
+| [Stat](#stat) | File information obtained.|
+
+**Error codes**
+
+For details about error codes, see "Basic File I/O Error Codes" in [File Management Error Codes](../errorcodes/errorcode-filemanagement.md).
**Example**
@@ -1236,9 +1368,13 @@ Renames a file or folder. This API uses a promise to return the result.
**Return value**
- | Type | Description |
- | ------------------- | ---------------------------- |
- | Promise<void> | Promise that returns no value.|
+| Type | Description |
+| ------------------- | ---------------------------- |
+| Promise<void> | Promise that returns no value.|
+
+**Error codes**
+
+For details about error codes, see "Basic File I/O Error Codes" in [File Management Error Codes](../errorcodes/errorcode-filemanagement.md).
**Example**
@@ -1268,6 +1404,10 @@ Renames a file or folder. This API uses an asynchronous callback to return the r
| newPath | string | Yes | Application sandbox path of the renamed file or folder. |
| callback | AsyncCallback<void> | Yes | Callback invoked when the file or folder is asynchronously renamed. |
+**Error codes**
+
+For details about error codes, see "Basic File I/O Error Codes" in [File Management Error Codes](../errorcodes/errorcode-filemanagement.md).
+
**Example**
```js
@@ -1297,6 +1437,10 @@ Renames a file or folder synchronously.
| oldPath | string | Yes | Application sandbox path of the file or folder to rename.|
| newPath | string | Yes | Application sandbox path of the renamed file or folder. |
+**Error codes**
+
+For details about error codes, see "Basic File I/O Error Codes" in [File Management Error Codes](../errorcodes/errorcode-filemanagement.md).
+
**Example**
```js
@@ -1305,7 +1449,6 @@ Renames a file or folder synchronously.
fs.renameSync(srcFile, dstFile);
```
-
## fs.fsync
fsync(fd: number): Promise<void>
@@ -1316,15 +1459,19 @@ Flushes data of a file to disk. This API uses a promise to return the result.
**Parameters**
- | Name | Type | Mandatory | Description |
- | ---- | ------ | ---- | ------------ |
- | fd | number | Yes | FD of the file.|
+| Name | Type | Mandatory | Description |
+| ---- | ------ | ---- | ------------ |
+| fd | number | Yes | FD of the file.|
**Return value**
- | Type | Description |
- | ------------------- | ---------------------------- |
- | Promise<void> | Promise that returns no value.|
+| Type | Description |
+| ------------------- | ---------------------------- |
+| Promise<void> | Promise that returns no value.|
+
+**Error codes**
+
+For details about error codes, see "Basic File I/O Error Codes" in [File Management Error Codes](../errorcodes/errorcode-filemanagement.md).
**Example**
@@ -1338,7 +1485,6 @@ Flushes data of a file to disk. This API uses a promise to return the result.
});
```
-
## fs.fsync
fsync(fd: number, callback: AsyncCallback<void>): void
@@ -1349,10 +1495,14 @@ Flushes data of a file to disk. This API uses an asynchronous callback to return
**Parameters**
- | Name | Type | Mandatory | Description |
- | -------- | ------------------------- | ---- | --------------- |
- | fd | number | Yes | FD of the file. |
- | Callback | AsyncCallback<void> | Yes | Callback invoked when the file data is synchronized in asynchronous mode.|
+| Name | Type | Mandatory | Description |
+| -------- | ------------------------- | ---- | --------------- |
+| fd | number | Yes | FD of the file. |
+| Callback | AsyncCallback<void> | Yes | Callback invoked when the file data is synchronized in asynchronous mode.|
+
+**Error codes**
+
+For details about error codes, see "Basic File I/O Error Codes" in [File Management Error Codes](../errorcodes/errorcode-filemanagement.md).
**Example**
@@ -1380,9 +1530,13 @@ Flushes data of a file to disk synchronously.
**Parameters**
- | Name | Type | Mandatory | Description |
- | ---- | ------ | ---- | ------------ |
- | fd | number | Yes | FD of the file.|
+| Name | Type | Mandatory | Description |
+| ---- | ------ | ---- | ------------ |
+| fd | number | Yes | FD of the file.|
+
+**Error codes**
+
+For details about error codes, see "Basic File I/O Error Codes" in [File Management Error Codes](../errorcodes/errorcode-filemanagement.md).
**Example**
@@ -1393,7 +1547,6 @@ Flushes data of a file to disk synchronously.
fs.closeSync(file);
```
-
## fs.fdatasync
fdatasync(fd: number): Promise<void>
@@ -1404,15 +1557,19 @@ Flushes data of a file to disk. This API uses a promise to return the result. **
**Parameters**
- | Name | Type | Mandatory | Description |
- | ---- | ------ | ---- | ------------ |
- | fd | number | Yes | FD of the file.|
+| Name | Type | Mandatory | Description |
+| ---- | ------ | ---- | ------------ |
+| fd | number | Yes | FD of the file.|
**Return value**
- | Type | Description |
- | ------------------- | ---------------------------- |
- | Promise<void> | Promise that returns no value.|
+| Type | Description |
+| ------------------- | ---------------------------- |
+| Promise<void> | Promise that returns no value.|
+
+**Error codes**
+
+For details about error codes, see "Basic File I/O Error Codes" in [File Management Error Codes](../errorcodes/errorcode-filemanagement.md).
**Example**
@@ -1427,7 +1584,6 @@ Flushes data of a file to disk. This API uses a promise to return the result. **
});
```
-
## fs.fdatasync
fdatasync(fd: number, callback: AsyncCallback<void>): void
@@ -1438,10 +1594,14 @@ Flushes data of a file to disk. This API uses an asynchronous callback to return
**Parameters**
- | Name | Type | Mandatory | Description |
- | -------- | ------------------------------- | ---- | ----------------- |
- | fd | number | Yes | FD of the file. |
- | callback | AsyncCallback<void> | Yes | Callback invoked when the file data is synchronized in asynchronous mode.|
+| Name | Type | Mandatory | Description |
+| -------- | ------------------------------- | ---- | ----------------- |
+| fd | number | Yes | FD of the file. |
+| callback | AsyncCallback<void> | Yes | Callback invoked when the file data is synchronized in asynchronous mode.|
+
+**Error codes**
+
+For details about error codes, see "Basic File I/O Error Codes" in [File Management Error Codes](../errorcodes/errorcode-filemanagement.md).
**Example**
@@ -1468,9 +1628,13 @@ Synchronizes data in a file synchronously.
**Parameters**
- | Name | Type | Mandatory | Description |
- | ---- | ------ | ---- | ------------ |
- | fd | number | Yes | FD of the file.|
+| Name | Type | Mandatory | Description |
+| ---- | ------ | ---- | ------------ |
+| fd | number | Yes | FD of the file.|
+
+**Error codes**
+
+For details about error codes, see "Basic File I/O Error Codes" in [File Management Error Codes](../errorcodes/errorcode-filemanagement.md).
**Example**
@@ -1481,7 +1645,6 @@ Synchronizes data in a file synchronously.
fs.closeSync(file);
```
-
## fs.symlink
symlink(target: string, srcPath: string): Promise<void>
@@ -1499,9 +1662,13 @@ Creates a symbolic link based on a file path. This API uses a promise to return
**Return value**
- | Type | Description |
- | ------------------- | ---------------------------- |
- | Promise<void> | Promise that returns no value.|
+| Type | Description |
+| ------------------- | ---------------------------- |
+| Promise<void> | Promise that returns no value.|
+
+**Error codes**
+
+For details about error codes, see "Basic File I/O Error Codes" in [File Management Error Codes](../errorcodes/errorcode-filemanagement.md).
**Example**
@@ -1531,6 +1698,10 @@ Creates a symbolic link based on a file path. This API uses an asynchronous call
| srcPath | string | Yes | Application sandbox path of the symbolic link. |
| callback | AsyncCallback<void> | Yes | Callback invoked when the symbolic link is created asynchronously.|
+**Error codes**
+
+For details about error codes, see "Basic File I/O Error Codes" in [File Management Error Codes](../errorcodes/errorcode-filemanagement.md).
+
**Example**
```js
@@ -1560,6 +1731,10 @@ Synchronously creates a symbolic link based on a file path.
| target | string | Yes | Application sandbox path of the source file. |
| srcPath | string | Yes | Application sandbox path of the symbolic link.|
+**Error codes**
+
+For details about error codes, see "Basic File I/O Error Codes" in [File Management Error Codes](../errorcodes/errorcode-filemanagement.md).
+
**Example**
```js
@@ -1573,7 +1748,7 @@ listFile(path: string, options?: {
recursion?: boolean;
listNum?: number;
filter?: Filter;
-}): Promise;
+}): Promise
Lists all files in a directory. This API uses a promise to return the result.
This API supports recursive listing of all files (including files in subdirectories) and file filtering.
@@ -1581,24 +1756,28 @@ Lists all files in a directory. This API uses a promise to return the result.
): void;
+}, callback: AsyncCallback): void
Lists all files in a directory. This API uses an asynchronous callback to return the result.
This API supports recursive listing of all files (including files in subdirectories) and file filtering.
**Parameters**
- | Name | Type | Mandatory | Description |
- | ------ | ------ | ---- | --------------------------- |
- | path | string | Yes | Application sandbox path of the folder.|
- | options | Object | No | File filtering options. The files are not filtered by default.|
- | callback | AsyncCallback<string[]> | Yes | Callback invoked to return the file names listed. |
+| Name | Type | Mandatory | Description |
+| ------ | ------ | ---- | --------------------------- |
+| path | string | Yes | Application sandbox path of the folder.|
+| options | Object | No | File filtering options. The files are not filtered by default.|
+| callback | AsyncCallback<string[]> | Yes | Callback invoked to return the file names listed. |
**options parameters**
- | Name | Type | Mandatory | Description |
- | ------ | ------ | ---- | --------------------------- |
- | recursion | boolean | No | Whether to list all files in subdirectories recursively. The default value is **false**.|
- | listNum | number | No | Number of file names to list. The default value **0** means to list all files.|
- | filter | [Filter](#filter) | No | File filtering options. Currently, only the match by file name extension, fuzzy search by file name, and filter by file size or latest modification time are supported.|
+| Name | Type | Mandatory | Description |
+| ------ | ------ | ---- | --------------------------- |
+| recursion | boolean | No | Whether to list all files in subdirectories recursively. The default value is **false**.|
+| listNum | number | No | Number of file names to list. The default value **0** means to list all files.|
+| filter | [Filter](#filter) | No | File filtering options. Currently, only the match by file name extension, fuzzy search by file name, and filter by file size or latest modification time are supported.|
+
+**Error codes**
+
+For details about error codes, see "Basic File I/O Error Codes" in [File Management Error Codes](../errorcodes/errorcode-filemanagement.md).
**Example**
@@ -1679,30 +1862,34 @@ listFileSync(path: string, options?: {
recursion?: boolean;
listNum?: number;
filter?: Filter;
-}): string[];
+}): string[]
Lists all files in a directory synchronously. This API supports recursive listing of all files (including files in subdirectories) and file filtering.
**Parameters**
- | Name | Type | Mandatory | Description |
- | ------ | ------ | ---- | --------------------------- |
- | path | string | Yes | Application sandbox path of the folder.|
- | options | Object | No | File filtering options. The files are not filtered by default.|
+| Name | Type | Mandatory | Description |
+| ------ | ------ | ---- | --------------------------- |
+| path | string | Yes | Application sandbox path of the folder.|
+| options | Object | No | File filtering options. The files are not filtered by default.|
**options parameters**
- | Name | Type | Mandatory | Description |
- | ------ | ------ | ---- | --------------------------- |
- | recursion | boolean | No | Whether to list all files in subdirectories recursively. The default value is **false**.|
- | listNum | number | No | Number of file names to list. The default value **0** means to list all files.|
- | filter | [Filter](#filter) | No | File filtering options. Currently, only the match by file name extension, fuzzy search by file name, and filter by file size or latest modification time are supported.|
+| Name | Type | Mandatory | Description |
+| ------ | ------ | ---- | --------------------------- |
+| recursion | boolean | No | Whether to list all files in subdirectories recursively. The default value is **false**.|
+| listNum | number | No | Number of file names to list. The default value **0** means to list all files.|
+| filter | [Filter](#filter) | No | File filtering options. Currently, only the match by file name extension, fuzzy search by file name, and filter by file size or latest modification time are supported.|
**Return value**
- | Type | Description |
- | --------------------- | ---------- |
- | string[] | File names listed.|
+| Type | Description |
+| --------------------- | ---------- |
+| string[] | File names listed.|
+
+**Error codes**
+
+For details about error codes, see "Basic File I/O Error Codes" in [File Management Error Codes](../errorcodes/errorcode-filemanagement.md).
**Example**
@@ -1723,9 +1910,10 @@ Lists all files in a directory synchronously. This API supports recursive listin
console.info("filename: %s", filenames[i]);
}
```
+
## fs.moveFile
-moveFile(src: string, dest: string, mode?: number): Promise\;
+moveFile(src: string, dest: string, mode?: number): Promise\
Moves a file. This API uses a promise to return the result.
@@ -1733,11 +1921,21 @@ Moves a file. This API uses a promise to return the result.
**Parameters**
- | Name | Type | Mandatory | Description |
- | ------ | ------ | ---- | --------------------------- |
- | src | string | Yes | Application sandbox path of the source file.|
- | dest | string | Yes | Application sandbox path of the destination file.|
- | mode | number | No | Whether to overwrite the file of the same name in the destination directory. The value **0** means to overwrite the file of the same name in the destination directory. The value **1** means to throw an exception if a file of the same name exists in the destination directory. The default value is **0**.|
+| Name | Type | Mandatory | Description |
+| ------ | ------ | ---- | --------------------------- |
+| src | string | Yes | Application sandbox path of the source file.|
+| dest | string | Yes | Application sandbox path of the destination file.|
+| mode | number | No | Whether to overwrite the file of the same name in the destination directory. The value **0** means to overwrite the file of the same name in the destination directory. The value **1** means to throw an exception if a file of the same name exists in the destination directory. The default value is **0**.|
+
+**Return value**
+
+| Type | Description |
+| ------------------- | ---------------------------- |
+| Promise<void> | Promise that returns no value.|
+
+**Error codes**
+
+For details about error codes, see "Basic File I/O Error Codes" in [File Management Error Codes](../errorcodes/errorcode-filemanagement.md).
**Example**
@@ -1753,7 +1951,7 @@ Moves a file. This API uses a promise to return the result.
## fs.moveFile
-moveFile(src: string, dest: string, mode?: number, callback: AsyncCallback\): void;
+moveFile(src: string, dest: string, mode?: number, callback: AsyncCallback\): void
Moves a file. This API uses an asynchronous callback to return the result.
@@ -1761,12 +1959,16 @@ Moves a file. This API uses an asynchronous callback to return the result.
**Parameters**
- | Name | Type | Mandatory | Description |
- | ------ | ------ | ---- | --------------------------- |
- | src | string | Yes | Application sandbox path of the source file.|
- | dest | string | Yes | Application sandbox path of the destination file.|
- | mode | number | No | Whether to overwrite the file of the same name in the destination directory. The value **0** means to overwrite the file of the same name in the destination directory. The value **1** means to throw an exception if a file of the same name exists in the destination directory. The default value is **0**.|
- | callback | AsyncCallback<void> | Yes | Callback invoked when the file is moved. |
+| Name | Type | Mandatory | Description |
+| ------ | ------ | ---- | --------------------------- |
+| src | string | Yes | Application sandbox path of the source file.|
+| dest | string | Yes | Application sandbox path of the destination file.|
+| mode | number | No | Whether to overwrite the file of the same name in the destination directory. The value **0** means to overwrite the file of the same name in the destination directory. The value **1** means to throw an exception if a file of the same name exists in the destination directory. The default value is **0**.|
+| callback | AsyncCallback<void> | Yes | Callback invoked when the file is moved. |
+
+**Error codes**
+
+For details about error codes, see "Basic File I/O Error Codes" in [File Management Error Codes](../errorcodes/errorcode-filemanagement.md).
**Example**
@@ -1784,7 +1986,7 @@ Moves a file. This API uses an asynchronous callback to return the result.
## fs.moveFileSync
-moveFile(src: string, dest: string, mode?: number): void;
+moveFile(src: string, dest: string, mode?: number): void
Moves a file synchronously.
@@ -1792,11 +1994,15 @@ Moves a file synchronously.
**Parameters**
- | Name | Type | Mandatory | Description |
- | ------ | ------ | ---- | --------------------------- |
- | src | string | Yes | Application sandbox path of the source file.|
- | dest | string | Yes | Application sandbox path of the destination file.|
- | mode | number | No | Whether to overwrite the file of the same name in the destination directory. The value **0** means to overwrite the file of the same name in the destination directory. The value **1** means to throw an exception if a file of the same name exists in the destination directory. The default value is **0**.|
+| Name | Type | Mandatory | Description |
+| ------ | ------ | ---- | --------------------------- |
+| src | string | Yes | Application sandbox path of the source file.|
+| dest | string | Yes | Application sandbox path of the destination file.|
+| mode | number | No | Whether to overwrite the file of the same name in the destination directory. The value **0** means to overwrite the file of the same name in the destination directory. The value **1** means to throw an exception if a file of the same name exists in the destination directory. The default value is **0**.|
+
+**Error codes**
+
+For details about error codes, see "Basic File I/O Error Codes" in [File Management Error Codes](../errorcodes/errorcode-filemanagement.md).
**Example**
@@ -1817,15 +2023,19 @@ Creates a temporary directory. This API uses a promise to return the result.
**Parameters**
- | Name | Type | Mandatory | Description |
- | ------ | ------ | ---- | --------------------------- |
- | prefix | string | Yes | A randomly generated string used to replace "XXXXXX" in a directory.|
+| Name | Type | Mandatory | Description |
+| ------ | ------ | ---- | --------------------------- |
+| prefix | string | Yes | A randomly generated string used to replace "XXXXXX" in a directory.|
**Return value**
- | Type | Description |
- | --------------------- | ---------- |
- | Promise<string> | Promise used to return the unique directory generated.|
+| Type | Description |
+| --------------------- | ---------- |
+| Promise<string> | Promise used to return the unique directory generated.|
+
+**Error codes**
+
+For details about error codes, see "Basic File I/O Error Codes" in [File Management Error Codes](../errorcodes/errorcode-filemanagement.md).
**Example**
@@ -1837,7 +2047,6 @@ Creates a temporary directory. This API uses a promise to return the result.
});
```
-
## fs.mkdtemp
mkdtemp(prefix: string, callback: AsyncCallback<string>): void
@@ -1848,10 +2057,14 @@ Creates a temporary directory. This API uses an asynchronous callback to return
**Parameters**
- | Name | Type | Mandatory | Description |
- | -------- | --------------------------- | ---- | --------------------------- |
- | prefix | string | Yes | A randomly generated string used to replace "XXXXXX" in a directory.|
- | callback | AsyncCallback<string> | Yes | Callback invoked when a temporary directory is created asynchronously. |
+| Name | Type | Mandatory | Description |
+| -------- | --------------------------- | ---- | --------------------------- |
+| prefix | string | Yes | A randomly generated string used to replace "XXXXXX" in a directory.|
+| callback | AsyncCallback<string> | Yes | Callback invoked when a temporary directory is created asynchronously. |
+
+**Error codes**
+
+For details about error codes, see "Basic File I/O Error Codes" in [File Management Error Codes](../errorcodes/errorcode-filemanagement.md).
**Example**
@@ -1875,21 +2088,25 @@ Synchronously creates a temporary directory.
**Parameters**
- | Name | Type | Mandatory | Description |
- | ------ | ------ | ---- | --------------------------- |
- | prefix | string | Yes | A randomly generated string used to replace "XXXXXX" in a directory.|
+| Name | Type | Mandatory | Description |
+| ------ | ------ | ---- | --------------------------- |
+| prefix | string | Yes | A randomly generated string used to replace "XXXXXX" in a directory.|
**Return value**
- | Type | Description |
- | ------ | ---------- |
- | string | Unique path generated.|
+| Type | Description |
+| ------ | ---------- |
+| string | Unique path generated.|
+
+**Error codes**
+
+For details about error codes, see "Basic File I/O Error Codes" in [File Management Error Codes](../errorcodes/errorcode-filemanagement.md).
**Example**
```js
let res = fs.mkdtempSync(pathDir + "/XXXXXX");
- ```
+ ```
## fs.createStream
@@ -1908,9 +2125,13 @@ Creates a stream based on the file path. This API uses a promise to return the r
**Return value**
- | Type | Description |
- | --------------------------------- | --------- |
- | Promise<[Stream](#stream)> | Promise used to return the result.|
+| Type | Description |
+| --------------------------------- | --------- |
+| Promise<[Stream](#stream)> | Promise used to return the result.|
+
+**Error codes**
+
+For details about error codes, see "Basic File I/O Error Codes" in [File Management Error Codes](../errorcodes/errorcode-filemanagement.md).
**Example**
@@ -1940,6 +2161,10 @@ Creates a stream based on the file path. This API uses an asynchronous callback
| mode | string | Yes | - **r**: Open a file for reading. The file must exist.
- **r+**: Open a file for both reading and writing. The file must exist.
- **w**: Open a file for writing. If the file exists, clear its content. If the file does not exist, create a file.
- **w+**: Open a file for both reading and writing. If the file exists, clear its content. If the file does not exist, create a file.
- **a**: Open a file in append mode for writing at the end of the file. If the file does not exist, create a file. If the file exists, write data to the end of the file (the original content of the file is reserved).
- **a+**: Open a file in append mode for reading or updating at the end of the file. If the file does not exist, create a file. If the file exists, write data to the end of the file (the original content of the file is reserved).|
| callback | AsyncCallback<[Stream](#stream)> | Yes | Callback invoked when the stream is created asynchronously. |
+**Error codes**
+
+For details about error codes, see "Basic File I/O Error Codes" in [File Management Error Codes](../errorcodes/errorcode-filemanagement.md).
+
**Example**
```js
@@ -1970,9 +2195,13 @@ Synchronously creates a stream based on the file path.
**Return value**
- | Type | Description |
- | ------------------ | --------- |
- | [Stream](#stream) | Stream opened.|
+| Type | Description |
+| ------------------ | --------- |
+| [Stream](#stream) | Stream opened.|
+
+**Error codes**
+
+For details about error codes, see "Basic File I/O Error Codes" in [File Management Error Codes](../errorcodes/errorcode-filemanagement.md).
**Example**
@@ -1992,16 +2221,20 @@ Opens a stream based on the file descriptor. This API uses a promise to return t
**Parameters**
- | Name | Type | Mandatory | Description |
- | ---- | ------ | ---- | ---------------------------------------- |
- | fd | number | Yes | FD of the file. |
- | mode | string | Yes | - **r**: Open a file for reading. The file must exist.
- **r+**: Open a file for both reading and writing. The file must exist.
- **w**: Open a file for writing. If the file exists, clear its content. If the file does not exist, create a file.
- **w+**: Open a file for both reading and writing. If the file exists, clear its content. If the file does not exist, create a file.
- **a**: Open a file in append mode for writing at the end of the file. If the file does not exist, create a file. If the file exists, write data to the end of the file (the original content of the file is reserved).
- **a+**: Open a file in append mode for reading or updating at the end of the file. If the file does not exist, create a file. If the file exists, write data to the end of the file (the original content of the file is reserved).|
+| Name | Type | Mandatory | Description |
+| ---- | ------ | ---- | ---------------------------------------- |
+| fd | number | Yes | FD of the file. |
+| mode | string | Yes | - **r**: Open a file for reading. The file must exist.
- **r+**: Open a file for both reading and writing. The file must exist.
- **w**: Open a file for writing. If the file exists, clear its content. If the file does not exist, create a file.
- **w+**: Open a file for both reading and writing. If the file exists, clear its content. If the file does not exist, create a file.
- **a**: Open a file in append mode for writing at the end of the file. If the file does not exist, create a file. If the file exists, write data to the end of the file (the original content of the file is reserved).
- **a+**: Open a file in append mode for reading or updating at the end of the file. If the file does not exist, create a file. If the file exists, write data to the end of the file (the original content of the file is reserved).|
**Return value**
- | Type | Description |
- | --------------------------------- | --------- |
- | Promise<[Stream](#stream)> | Promise used to return the result.|
+| Type | Description |
+| --------------------------------- | --------- |
+| Promise<[Stream](#stream)> | Promise used to return the result.|
+
+**Error codes**
+
+For details about error codes, see "Basic File I/O Error Codes" in [File Management Error Codes](../errorcodes/errorcode-filemanagement.md).
**Example**
@@ -2016,7 +2249,6 @@ Opens a stream based on the file descriptor. This API uses a promise to return t
});
```
-
## fs.fdopenStream
fdopenStream(fd: number, mode: string, callback: AsyncCallback<Stream>): void
@@ -2027,11 +2259,15 @@ Opens a stream based on the file descriptor. This API uses an asynchronous callb
**Parameters**
- | Name | Type | Mandatory | Description |
- | -------- | ---------------------------------------- | ---- | ---------------------------------------- |
- | fd | number | Yes | FD of the file. |
- | mode | string | Yes | - **r**: Open a file for reading. The file must exist.
- **r+**: Open a file for both reading and writing. The file must exist.
- **w**: Open a file for writing. If the file exists, clear its content. If the file does not exist, create a file.
- **w+**: Open a file for both reading and writing. If the file exists, clear its content. If the file does not exist, create a file.
- **a**: Open a file in append mode for writing at the end of the file. If the file does not exist, create a file. If the file exists, write data to the end of the file (the original content of the file is reserved).
- **a+**: Open a file in append mode for reading or updating at the end of the file. If the file does not exist, create a file. If the file exists, write data to the end of the file (the original content of the file is reserved).|
- | callback | AsyncCallback<[Stream](#stream)> | Yes | Callback invoked when the stream is open asynchronously. |
+| Name | Type | Mandatory | Description |
+| -------- | ---------------------------------------- | ---- | ---------------------------------------- |
+| fd | number | Yes | FD of the file. |
+| mode | string | Yes | - **r**: Open a file for reading. The file must exist.
- **r+**: Open a file for both reading and writing. The file must exist.
- **w**: Open a file for writing. If the file exists, clear its content. If the file does not exist, create a file.
- **w+**: Open a file for both reading and writing. If the file exists, clear its content. If the file does not exist, create a file.
- **a**: Open a file in append mode for writing at the end of the file. If the file does not exist, create a file. If the file exists, write data to the end of the file (the original content of the file is reserved).
- **a+**: Open a file in append mode for reading or updating at the end of the file. If the file does not exist, create a file. If the file exists, write data to the end of the file (the original content of the file is reserved).|
+| callback | AsyncCallback<[Stream](#stream)> | Yes | Callback invoked when the stream is open asynchronously. |
+
+**Error codes**
+
+For details about error codes, see "Basic File I/O Error Codes" in [File Management Error Codes](../errorcodes/errorcode-filemanagement.md).
**Example**
@@ -2058,16 +2294,20 @@ Synchronously opens a stream based on the file descriptor.
**Parameters**
- | Name | Type | Mandatory | Description |
- | ---- | ------ | ---- | ---------------------------------------- |
- | fd | number | Yes | FD of the file. |
- | mode | string | Yes | - **r**: Open a file for reading. The file must exist.
- **r+**: Open a file for both reading and writing. The file must exist.
- **w**: Open a file for writing. If the file exists, clear its content. If the file does not exist, create a file.
- **w+**: Open a file for both reading and writing. If the file exists, clear its content. If the file does not exist, create a file.
- **a**: Open a file in append mode for writing at the end of the file. If the file does not exist, create a file. If the file exists, write data to the end of the file (the original content of the file is reserved).
- **a+**: Open a file in append mode for reading or updating at the end of the file. If the file does not exist, create a file. If the file exists, write data to the end of the file (the original content of the file is reserved).|
+| Name | Type | Mandatory | Description |
+| ---- | ------ | ---- | ---------------------------------------- |
+| fd | number | Yes | FD of the file. |
+| mode | string | Yes | - **r**: Open a file for reading. The file must exist.
- **r+**: Open a file for both reading and writing. The file must exist.
- **w**: Open a file for writing. If the file exists, clear its content. If the file does not exist, create a file.
- **w+**: Open a file for both reading and writing. If the file exists, clear its content. If the file does not exist, create a file.
- **a**: Open a file in append mode for writing at the end of the file. If the file does not exist, create a file. If the file exists, write data to the end of the file (the original content of the file is reserved).
- **a+**: Open a file in append mode for reading or updating at the end of the file. If the file does not exist, create a file. If the file exists, write data to the end of the file (the original content of the file is reserved).|
**Return value**
- | Type | Description |
- | ------------------ | --------- |
- | [Stream](#stream) | Stream opened.|
+| Type | Description |
+| ------------------ | --------- |
+| [Stream](#stream) | Stream opened.|
+
+**Error codes**
+
+For details about error codes, see "Basic File I/O Error Codes" in [File Management Error Codes](../errorcodes/errorcode-filemanagement.md).
**Example**
@@ -2087,7 +2327,7 @@ Represents detailed file information. Before calling any API of the **Stat()** c
### Attributes
| Name | Type | Readable | Writable | Description |
-| ------ | ------ | ---- | ---- | ---------------------------------------- |
+| ------ | ------ | ---- | ---- | ---------------------------------------- |
| ino | number | Yes | No | File ID. Different files on the same device have different **ino**s.| |
| mode | number | Yes | No | File permissions. The meaning of each bit is as follows:
- **0o400**: The owner has the read permission on a regular file or a directory entry.
- **0o200**: The owner has the permission to write a regular file or create and delete a directory entry.
- **0o100**: The owner has the permission to execute a regular file or search for the specified path in a directory.
- **0o040**: The user group has the read permission on a regular file or a directory entry.
- **0o020**: The user group has the permission to write a regular file or create and delete a directory entry.
- **0o010**: The user group has the permission to execute a regular file or search for the specified path in a directory.
- **0o004**: Other users have the permission to read a regular file or read a directory entry.
- **0o002**: Other users have the permission to write a regular file or create and delete a directory entry.
- **0o001**: Other users have the permission to execute a regular file or search for the specified path in a directory.|
| uid | number | Yes | No | ID of the file owner.|
@@ -2097,7 +2337,6 @@ Represents detailed file information. Before calling any API of the **Stat()** c
| mtime | number | Yes | No | Time of the last modification to the file. The value is the number of seconds elapsed since 00:00:00 on January 1, 1970. |
| ctime | number | Yes | No | Time of the last status change of the file. The value is the number of seconds elapsed since 00:00:00 on January 1, 1970. |
-
### isBlockDevice
isBlockDevice(): boolean
@@ -2108,9 +2347,13 @@ Checks whether this file is a block special file. A block special file supports
**Return value**
- | Type | Description |
- | ------- | ---------------- |
- | boolean | Whether the file is a block special file.|
+| Type | Description |
+| ------- | ---------------- |
+| boolean | Whether the file is a block special file.|
+
+**Error codes**
+
+For details about error codes, see "Basic File I/O Error Codes" in [File Management Error Codes](../errorcodes/errorcode-filemanagement.md).
**Example**
@@ -2129,9 +2372,13 @@ Checks whether this file is a character special file. A character special file s
**Return value**
- | Type | Description |
- | ------- | ----------------- |
- | boolean | Whether the file is a character special file.|
+| Type | Description |
+| ------- | ----------------- |
+| boolean | Whether the file is a character special file.|
+
+**Error codes**
+
+For details about error codes, see "Basic File I/O Error Codes" in [File Management Error Codes](../errorcodes/errorcode-filemanagement.md).
**Example**
@@ -2140,7 +2387,6 @@ Checks whether this file is a character special file. A character special file s
let isCharacterDevice = fs.statSync(filePath).isCharacterDevice();
```
-
### isDirectory
isDirectory(): boolean
@@ -2151,9 +2397,13 @@ Checks whether this file is a directory.
**Return value**
- | Type | Description |
- | ------- | ------------- |
- | boolean | Whether the file is a directory.|
+| Type | Description |
+| ------- | ------------- |
+| boolean | Whether the file is a directory.|
+
+**Error codes**
+
+For details about error codes, see "Basic File I/O Error Codes" in [File Management Error Codes](../errorcodes/errorcode-filemanagement.md).
**Example**
@@ -2162,7 +2412,6 @@ Checks whether this file is a directory.
let isDirectory = fs.statSync(dirPath).isDirectory();
```
-
### isFIFO
isFIFO(): boolean
@@ -2173,9 +2422,13 @@ Checks whether this file is a named pipe (or FIFO). Named pipes are used for int
**Return value**
- | Type | Description |
- | ------- | --------------------- |
- | boolean | Whether the file is a FIFO.|
+| Type | Description |
+| ------- | --------------------- |
+| boolean | Whether the file is a FIFO.|
+
+**Error codes**
+
+For details about error codes, see "Basic File I/O Error Codes" in [File Management Error Codes](../errorcodes/errorcode-filemanagement.md).
**Example**
@@ -2184,7 +2437,6 @@ Checks whether this file is a named pipe (or FIFO). Named pipes are used for int
let isFIFO = fs.statSync(filePath).isFIFO();
```
-
### isFile
isFile(): boolean
@@ -2195,9 +2447,13 @@ Checks whether this file is a regular file.
**Return value**
- | Type | Description |
- | ------- | --------------- |
- | boolean | Whether the file is a regular file.|
+| Type | Description |
+| ------- | --------------- |
+| boolean | Whether the file is a regular file.|
+
+**Error codes**
+
+For details about error codes, see "Basic File I/O Error Codes" in [File Management Error Codes](../errorcodes/errorcode-filemanagement.md).
**Example**
@@ -2206,7 +2462,6 @@ Checks whether this file is a regular file.
let isFile = fs.statSync(filePath).isFile();
```
-
### isSocket
isSocket(): boolean
@@ -2217,9 +2472,13 @@ Checks whether this file is a socket.
**Return value**
- | Type | Description |
- | ------- | -------------- |
- | boolean | Whether the file is a socket.|
+| Type | Description |
+| ------- | -------------- |
+| boolean | Whether the file is a socket.|
+
+**Error codes**
+
+For details about error codes, see "Basic File I/O Error Codes" in [File Management Error Codes](../errorcodes/errorcode-filemanagement.md).
**Example**
@@ -2228,7 +2487,6 @@ Checks whether this file is a socket.
let isSocket = fs.statSync(filePath).isSocket();
```
-
### isSymbolicLink
isSymbolicLink(): boolean
@@ -2239,9 +2497,13 @@ Checks whether this file is a symbolic link.
**Return value**
- | Type | Description |
- | ------- | --------------- |
- | boolean | Whether the file is a symbolic link.|
+| Type | Description |
+| ------- | --------------- |
+| boolean | Whether the file is a symbolic link.|
+
+**Error codes**
+
+For details about error codes, see "Basic File I/O Error Codes" in [File Management Error Codes](../errorcodes/errorcode-filemanagement.md).
**Example**
@@ -2254,7 +2516,6 @@ Checks whether this file is a symbolic link.
Provides a stream for file operations. Before calling any API of the **Stream** class, use **createStream()** to create a **Stream** instance synchronously or asynchronously.
-
### close
close(): Promise<void>
@@ -2265,9 +2526,13 @@ Closes the stream. This API uses a promise to return the result.
**Return value**
- | Type | Description |
- | ------------------- | ------------- |
- | Promise<void> | Promise used to return the stream close result.|
+| Type | Description |
+| ------------------- | ------------- |
+| Promise<void> | Promise used to return the stream close result.|
+
+**Error codes**
+
+For details about error codes, see "Basic File I/O Error Codes" in [File Management Error Codes](../errorcodes/errorcode-filemanagement.md).
**Example**
@@ -2281,7 +2546,6 @@ Closes the stream. This API uses a promise to return the result.
});
```
-
### close
close(callback: AsyncCallback<void>): void
@@ -2292,9 +2556,13 @@ Closes the stream. This API uses an asynchronous callback to return the result.
**Parameters**
- | Name | Type | Mandatory | Description |
- | -------- | ------------------------- | ---- | ------------- |
- | callback | AsyncCallback<void> | Yes | Callback invoked when the stream is closed asynchronously.|
+| Name | Type | Mandatory | Description |
+| -------- | ------------------------- | ---- | ------------- |
+| callback | AsyncCallback<void> | Yes | Callback invoked when the stream is closed asynchronously.|
+
+**Error codes**
+
+For details about error codes, see "Basic File I/O Error Codes" in [File Management Error Codes](../errorcodes/errorcode-filemanagement.md).
**Example**
@@ -2318,6 +2586,10 @@ Synchronously closes the stream.
**System capability**: SystemCapability.FileManagement.File.FileIO
+**Error codes**
+
+For details about error codes, see "Basic File I/O Error Codes" in [File Management Error Codes](../errorcodes/errorcode-filemanagement.md).
+
**Example**
```js
@@ -2336,9 +2608,13 @@ Flushes the stream. This API uses a promise to return the result.
**Return value**
- | Type | Description |
- | ------------------- | ------------- |
- | Promise<void> | Promise used to return the stream flushing result.|
+| Type | Description |
+| ------------------- | ------------- |
+| Promise<void> | Promise used to return the stream flushing result.|
+
+**Error codes**
+
+For details about error codes, see "Basic File I/O Error Codes" in [File Management Error Codes](../errorcodes/errorcode-filemanagement.md).
**Example**
@@ -2352,7 +2628,6 @@ Flushes the stream. This API uses a promise to return the result.
});
```
-
### flush
flush(callback: AsyncCallback<void>): void
@@ -2363,9 +2638,13 @@ Flushes the stream. This API uses an asynchronous callback to return the result.
**Parameters**
- | Name | Type | Mandatory | Description |
- | -------- | ------------------------- | ---- | -------------- |
- | callback | AsyncCallback<void> | Yes | Callback invoked when the stream is asynchronously flushed.|
+| Name | Type | Mandatory | Description |
+| -------- | ------------------------- | ---- | -------------- |
+| callback | AsyncCallback<void> | Yes | Callback invoked when the stream is asynchronously flushed.|
+
+**Error codes**
+
+For details about error codes, see "Basic File I/O Error Codes" in [File Management Error Codes](../errorcodes/errorcode-filemanagement.md).
**Example**
@@ -2389,6 +2668,10 @@ Synchronously flushes the stream.
**System capability**: SystemCapability.FileManagement.File.FileIO
+**Error codes**
+
+For details about error codes, see "Basic File I/O Error Codes" in [File Management Error Codes](../errorcodes/errorcode-filemanagement.md).
+
**Example**
```js
@@ -2407,16 +2690,20 @@ Writes data into the stream. This API uses a promise to return the result.
**Parameters**
- | Name | Type | Mandatory | Description |
- | ------- | ------------------------------- | ---- | ---------------------------------------- |
- | buffer | ArrayBuffer\|string | Yes | Data to write. It can be a string or data from a buffer. |
- | options | Object | No | The options are as follows:
- **length** (number): length of the data to write. The default value is the buffer length.
- **offset** (number): start position to write the data in the file. This parameter is optional. By default, data is written from the current position.
- **encoding** (string): format of the data to be encoded when the data is a string. The default value is **'utf-8'**, which is the only value supported.|
+| Name | Type | Mandatory | Description |
+| ------- | ------------------------------- | ---- | ---------------------------------------- |
+| buffer | ArrayBuffer\|string | Yes | Data to write. It can be a string or data from a buffer. |
+| options | Object | No | The options are as follows:
- **length** (number): length of the data to write. The default value is the buffer length.
- **offset** (number): start position to write the data in the file. This parameter is optional. By default, data is written from the current position.
- **encoding** (string): format of the data to be encoded when the data is a string. The default value is **'utf-8'**, which is the only value supported.|
**Return value**
- | Type | Description |
- | --------------------- | -------- |
- | Promise<number> | Promise used to return the length of the data written.|
+| Type | Description |
+| --------------------- | -------- |
+| Promise<number> | Promise used to return the length of the data written.|
+
+**Error codes**
+
+For details about error codes, see "Basic File I/O Error Codes" in [File Management Error Codes](../errorcodes/errorcode-filemanagement.md).
**Example**
@@ -2430,7 +2717,6 @@ Writes data into the stream. This API uses a promise to return the result.
});
```
-
### write
write(buffer: ArrayBuffer|string, options?: { offset?: number; length?: number; encoding?: string; }, callback: AsyncCallback<number>): void
@@ -2441,11 +2727,15 @@ Writes data into the stream. This API uses an asynchronous callback to return th
**Parameters**
- | Name | Type | Mandatory| Description |
- | -------- | ------------------------------- | ---- | ------------------------------------------------------------ |
- | buffer | ArrayBuffer\|string | Yes | Data to write. It can be a string or data from a buffer. |
- | options | Object | No | The options are as follows:
- **length** (number): length of the data to write. This parameter is optional. The default value is the buffer length.
- **offset** (number): start position to write the data in the file. This parameter is optional. By default, data is written from the current position.
- **encoding** (string): format of the data to be encoded when the data is a string. The default value is **'utf-8'**, which is the only value supported.|
- | callback | AsyncCallback<number> | Yes | Callback invoked when the data is written asynchronously. |
+| Name | Type | Mandatory| Description |
+| -------- | ------------------------------- | ---- | ------------------------------------------------------------ |
+| buffer | ArrayBuffer\|string | Yes | Data to write. It can be a string or data from a buffer. |
+| options | Object | No | The options are as follows:
- **length** (number): length of the data to write. This parameter is optional. The default value is the buffer length.
- **offset** (number): start position to write the data in the file. This parameter is optional. By default, data is written from the current position.
- **encoding** (string): format of the data to be encoded when the data is a string. The default value is **'utf-8'**, which is the only value supported.|
+| callback | AsyncCallback<number> | Yes | Callback invoked when the data is written asynchronously. |
+
+**Error codes**
+
+For details about error codes, see "Basic File I/O Error Codes" in [File Management Error Codes](../errorcodes/errorcode-filemanagement.md).
**Example**
@@ -2473,16 +2763,20 @@ Synchronously writes data into the stream.
**Parameters**
- | Name | Type | Mandatory | Description |
- | ------- | ------------------------------- | ---- | ---------------------------------------- |
- | buffer | ArrayBuffer\|string | Yes | Data to write. It can be a string or data from a buffer. |
- | options | Object | No | The options are as follows:
- **length** (number): length of the data to write. This parameter is optional. The default value is the buffer length.
- **offset** (number): start position to write the data in the file. This parameter is optional. By default, data is written from the current position.
- **encoding** (string): format of the data to be encoded when the data is a string. The default value is **'utf-8'**, which is the only value supported.|
+| Name | Type | Mandatory | Description |
+| ------- | ------------------------------- | ---- | ---------------------------------------- |
+| buffer | ArrayBuffer\|string | Yes | Data to write. It can be a string or data from a buffer. |
+| options | Object | No | The options are as follows:
- **length** (number): length of the data to write. This parameter is optional. The default value is the buffer length.
- **offset** (number): start position to write the data in the file. This parameter is optional. By default, data is written from the current position.
- **encoding** (string): format of the data to be encoded when the data is a string. The default value is **'utf-8'**, which is the only value supported.|
**Return value**
- | Type | Description |
- | ------ | -------- |
- | number | Length of the data written in the file.|
+| Type | Description |
+| ------ | -------- |
+| number | Length of the data written in the file.|
+
+**Error codes**
+
+For details about error codes, see "Basic File I/O Error Codes" in [File Management Error Codes](../errorcodes/errorcode-filemanagement.md).
**Example**
@@ -2502,16 +2796,20 @@ Reads data from the stream. This API uses a promise to return the result.
**Parameters**
- | Name | Type | Mandatory | Description |
- | ------- | ----------- | ---- | ---------------------------------------- |
- | buffer | ArrayBuffer | Yes | Buffer used to store the file read. |
- | options | Object | No | The options are as follows:
- **length** (number): length of the data to read. This parameter is optional. The default value is the buffer length.
- **offset** (number): position of the data to read in the file. By default, data is read from the current position.|
+| Name | Type | Mandatory | Description |
+| ------- | ----------- | ---- | ---------------------------------------- |
+| buffer | ArrayBuffer | Yes | Buffer used to store the file read. |
+| options | Object | No | The options are as follows:
- **length** (number): length of the data to read. This parameter is optional. The default value is the buffer length.
- **offset** (number): position of the data to read in the file. By default, data is read from the current position.|
**Return value**
- | Type | Description |
- | ---------------------------------- | ------ |
- | Promise<number> | Promise used to return the data read.|
+| Type | Description |
+| ---------------------------------- | ------ |
+| Promise<number> | Promise used to return the data read.|
+
+**Error codes**
+
+For details about error codes, see "Basic File I/O Error Codes" in [File Management Error Codes](../errorcodes/errorcode-filemanagement.md).
**Example**
@@ -2527,7 +2825,6 @@ Reads data from the stream. This API uses a promise to return the result.
});
```
-
### read
read(buffer: ArrayBuffer, options?: { position?: number; offset?: number; length?: number; }, callback: AsyncCallback<number>): void
@@ -2538,11 +2835,15 @@ Reads data from the stream. This API uses an asynchronous callback to return the
**Parameters**
- | Name | Type | Mandatory | Description |
- | -------- | ---------------------------------------- | ---- | ---------------------------------------- |
- | buffer | ArrayBuffer | Yes | Buffer used to store the file read. |
- | options | Object | No | The options are as follows:
- **length** (number): length of the data to read. This parameter is optional. The default value is the buffer length.
- **offset** (number): position of the data to read in the file. This parameter is optional. By default, data is read from the current position.|
- | callback | AsyncCallback<number> | Yes | Callback invoked when data is read asynchronously from the stream. |
+| Name | Type | Mandatory | Description |
+| -------- | ---------------------------------------- | ---- | ---------------------------------------- |
+| buffer | ArrayBuffer | Yes | Buffer used to store the file read. |
+| options | Object | No | The options are as follows:
- **length** (number): length of the data to read. This parameter is optional. The default value is the buffer length.
- **offset** (number): position of the data to read in the file. This parameter is optional. By default, data is read from the current position.|
+| callback | AsyncCallback<number> | Yes | Callback invoked when data is read asynchronously from the stream. |
+
+**Error codes**
+
+For details about error codes, see "Basic File I/O Error Codes" in [File Management Error Codes](../errorcodes/errorcode-filemanagement.md).
**Example**
@@ -2570,16 +2871,20 @@ Synchronously reads data from the stream.
**Parameters**
- | Name | Type | Mandatory | Description |
- | ------- | ----------- | ---- | ---------------------------------------- |
- | buffer | ArrayBuffer | Yes | Buffer used to store the file read. |
- | options | Object | No | The options are as follows:
- **length** (number): length of the data to read. This parameter is optional. The default value is the buffer length.
- **offset** (number): position of the data to read in the file. By default, data is read from the current position.
|
+| Name | Type | Mandatory | Description |
+| ------- | ----------- | ---- | ---------------------------------------- |
+| buffer | ArrayBuffer | Yes | Buffer used to store the file read. |
+| options | Object | No | The options are as follows:
- **length** (number): length of the data to read. This parameter is optional. The default value is the buffer length.
- **offset** (number): position of the data to read in the file. By default, data is read from the current position.
|
**Return value**
- | Type | Description |
- | ------ | -------- |
- | number | Length of the data read.|
+| Type | Description |
+| ------ | -------- |
+| number | Length of the data read.|
+
+**Error codes**
+
+For details about error codes, see "Basic File I/O Error Codes" in [File Management Error Codes](../errorcodes/errorcode-filemanagement.md).
**Example**
@@ -2603,7 +2908,7 @@ Represents a **File** object opened by **open()**.
### lock
-lock(exclusive?: boolean): Promise\;
+lock(exclusive?: boolean): Promise\
Applies an exclusive lock or a shared lock on this file in blocking mode. This API uses a promise to return the result.
@@ -2611,15 +2916,19 @@ Applies an exclusive lock or a shared lock on this file in blocking mode. This A
**Parameters**
- | Name | Type | Mandatory | Description |
- | ------- | ----------- | ---- | ---------------------------------------- |
- | exclusive | boolean | No | Lock to apply. The value **true** means an exclusive lock, and the value **false** (default) means a shared lock. |
+| Name | Type | Mandatory | Description |
+| ------- | ----------- | ---- | ---------------------------------------- |
+| exclusive | boolean | No | Lock to apply. The value **true** means an exclusive lock, and the value **false** (default) means a shared lock. |
**Return value**
- | Type | Description |
- | ---------------------------------- | ------ |
- | Promise<void> | Promise that returns no value.|
+| Type | Description |
+| ---------------------------------- | ------ |
+| Promise<void> | Promise that returns no value.|
+
+**Error codes**
+
+For details about error codes, see "Basic File I/O Error Codes" in [File Management Error Codes](../errorcodes/errorcode-filemanagement.md).
**Example**
@@ -2634,7 +2943,7 @@ Applies an exclusive lock or a shared lock on this file in blocking mode. This A
### lock
-lock(exclusive?: boolean, callback: AsyncCallback\): void;
+lock(exclusive?: boolean, callback: AsyncCallback\): void
Applies an exclusive lock or a shared lock on this file in blocking mode. This API uses a promise to return the result.
@@ -2642,10 +2951,14 @@ Applies an exclusive lock or a shared lock on this file in blocking mode. This A
**Parameters**
- | Name | Type | Mandatory | Description |
- | ------- | ----------- | ---- | ---------------------------------------- |
- | exclusive | boolean | No | Lock to apply. The value **true** means an exclusive lock, and the value **false** (default) means a shared lock. |
- | callback | AsyncCallback<void> | Yes | Callback invoked when the file is locked. |
+| Name | Type | Mandatory | Description |
+| ------- | ----------- | ---- | ---------------------------------------- |
+| exclusive | boolean | No | Lock to apply. The value **true** means an exclusive lock, and the value **false** (default) means a shared lock. |
+| callback | AsyncCallback<void> | Yes | Callback invoked when the file is locked. |
+
+**Error codes**
+
+For details about error codes, see "Basic File I/O Error Codes" in [File Management Error Codes](../errorcodes/errorcode-filemanagement.md).
**Example**
@@ -2662,7 +2975,7 @@ Applies an exclusive lock or a shared lock on this file in blocking mode. This A
### tryLock
-tryLock(exclusive?: boolean): void;
+tryLock(exclusive?: boolean): void
Applies an exclusive lock or a shared lock on this file in non-blocking mode.
@@ -2670,9 +2983,13 @@ Applies an exclusive lock or a shared lock on this file in non-blocking mode.
**Parameters**
- | Name | Type | Mandatory | Description |
- | ------- | ----------- | ---- | ---------------------------------------- |
- | exclusive | boolean | No | Lock to apply. The value **true** means an exclusive lock, and the value **false** (default) means a shared lock. |
+| Name | Type | Mandatory | Description |
+| ------- | ----------- | ---- | ---------------------------------------- |
+| exclusive | boolean | No | Lock to apply. The value **true** means an exclusive lock, and the value **false** (default) means a shared lock. |
+
+**Error codes**
+
+For details about error codes, see "Basic File I/O Error Codes" in [File Management Error Codes](../errorcodes/errorcode-filemanagement.md).
**Example**
@@ -2684,12 +3001,16 @@ Applies an exclusive lock or a shared lock on this file in non-blocking mode.
### unlock
-unlock(): void;
+unlock(): void
Unlocks this file synchronously.
**System capability**: SystemCapability.FileManagement.File.FileIO
+**Error codes**
+
+For details about error codes, see "Basic File I/O Error Codes" in [File Management Error Codes](../errorcodes/errorcode-filemanagement.md).
+
**Example**
```js