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 7f55fb64daecf5c341a39f0e3a79f76df2372c61..a0378e8d89c9468a8e52e6d67c4d89586033ac95 100644 --- a/en/application-dev/reference/apis/js-apis-file-fs.md +++ b/en/application-dev/reference/apis/js-apis-file-fs.md @@ -251,7 +251,7 @@ For details about the error codes, see [Basic File IO Error Codes](../errorcodes ## fs.close -close(file: File|number): Promise<void> +close(file: number|File): Promise<void> Closes a file. This API uses a promise to return the result. @@ -261,7 +261,7 @@ Closes a file. This API uses a promise to return the result. | Name | Type | Mandatory | Description | | ---- | ------ | ---- | ------------ | - | file | [File](#file)\|number | Yes | File object or FD of the file to close.| + | file | number\|[File](#file) | Yes | File object or FD of the file to close.| **Return value** @@ -288,7 +288,7 @@ For details about the error codes, see [Basic File IO Error Codes](../errorcodes ## fs.close -close(file: File|number, callback: AsyncCallback<void>): void +close(file: number|File, callback: AsyncCallback<void>): void Closes a file. This API uses an asynchronous callback to return the result. @@ -298,7 +298,7 @@ Closes a file. This API uses an asynchronous callback to return the result. | Name | Type | Mandatory | Description | | -------- | ------------------------- | ---- | ------------ | - | file | [File](#file)\|number | Yes | File object or FD of the file to close.| + | file | number\|[File](#file) | Yes | File object or FD of the file to close.| | callback | AsyncCallback<void> | Yes | Callback invoked immediately after the file is closed.| **Error codes** @@ -321,7 +321,7 @@ For details about the error codes, see [Basic File IO Error Codes](../errorcodes ## fs.closeSync -closeSync(file: File|number): void +closeSync(file: number|File): void Synchronously closes a file. @@ -331,7 +331,7 @@ Synchronously closes a file. | Name | Type | Mandatory | Description | | ---- | ------ | ---- | ------------ | - | file | [File](#file)\|number | Yes | File object or FD of the file to close.| + | file | number\|[File](#file) | Yes | File object or FD of the file to close.| **Error codes** @@ -543,7 +543,7 @@ For details about the error codes, see [Basic File IO Error Codes](../errorcodes open(path: string, mode?: number): Promise<File> -Opens a file. This API uses a promise to return the result. File uniform resource identifiers (URIs) are supported. +Opens a file. This API uses a promise to return the result. File uniform resource identifiers (URIs) are supported. **System capability**: SystemCapability.FileManagement.File.FileIO @@ -580,7 +580,7 @@ For details about the error codes, see [Basic File IO Error Codes](../errorcodes open(path: string, mode?: number, callback: AsyncCallback<File>): void -Opens a file. This API uses an asynchronous callback to return the result. File URIs are supported. +Opens a file. This API uses an asynchronous callback to return the result. File URIs are supported. **System capability**: SystemCapability.FileManagement.File.FileIO @@ -612,7 +612,7 @@ For details about the error codes, see [Basic File IO Error Codes](../errorcodes openSync(path: string, mode?: number): File -Synchronously opens a file. File URIs are supported. +Synchronously opens a file. File URIs are supported. **System capability**: SystemCapability.FileManagement.File.FileIO @@ -1239,7 +1239,7 @@ Synchronously reads the text of a file. | Type | Description | | ------ | -------------------- | - | string | Promise used to return the content of the file read.| + | string | Returns the content of the file read.| **Error codes** @@ -1811,6 +1811,8 @@ listFile(path: string, options?: { 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. +**System capability**: SystemCapability.FileManagement.File.FileIO + **Parameters** | Name | Type | Mandatory | Description | @@ -1866,6 +1868,8 @@ listFileSync(path: string, options?: { Lists all files in a directory synchronously. This API supports recursive listing of all files (including files in subdirectories) and file filtering. +**System capability**: SystemCapability.FileManagement.File.FileIO + **Parameters** | Name | Type | Mandatory | Description | @@ -1986,7 +1990,7 @@ For details about the error codes, see [Basic File IO Error Codes](../errorcodes ## fs.moveFileSync -moveFile(src: string, dest: string, mode?: number): void +moveFileSync(src: string, dest: string, mode?: number): void Moves a file synchronously. @@ -2933,7 +2937,7 @@ For details about the error codes, see [Basic File IO Error Codes](../errorcodes **Example** ```js - let file = fs.openSync(path, fs.OpenMode.READ_WRITE | fs.OpenMode.CREATE); + let file = fs.openSync(pathDir + "/test.txt", fs.OpenMode.READ_WRITE | fs.OpenMode.CREATE); file.lock(true).then(() => { console.log("lock file successful"); }).catch((err) => { @@ -2963,7 +2967,7 @@ For details about the error codes, see [Basic File IO Error Codes](../errorcodes **Example** ```js - let file = fs.openSync(path, fs.OpenMode.READ_WRITE | fs.OpenMode.CREATE); + let file = fs.openSync(pathDir + "/test.txt", fs.OpenMode.READ_WRITE | fs.OpenMode.CREATE); file.lock(true, (err) => { if (err) { console.info("lock file failed with error message: " + err.message + ", error code: " + err.code); @@ -2994,7 +2998,7 @@ For details about the error codes, see [Basic File IO Error Codes](../errorcodes **Example** ```js - let file = fs.openSync(path, fs.OpenMode.READ_WRITE | fs.OpenMode.CREATE); + let file = fs.openSync(pathDir + "/test.txt", fs.OpenMode.READ_WRITE | fs.OpenMode.CREATE); file.tryLock(true); console.log("lock file successful"); ``` @@ -3014,7 +3018,7 @@ For details about the error codes, see [Basic File IO Error Codes](../errorcodes **Example** ```js - let file = fs.openSync(path, fs.OpenMode.READ_WRITE | fs.OpenMode.CREATE); + let file = fs.openSync(pathDir + "/test.txt", fs.OpenMode.READ_WRITE | fs.OpenMode.CREATE); file.tryLock(true); file.unlock(); console.log("unlock file successful");