diff --git a/api/@ohos.file.fs.d.ets b/api/@ohos.file.fs.d.ets index e5e897722413bb2aa0637b546ecfce051b660cf0..747a1d4100d2a2c168e7546d26f029ac09e1583d 100644 --- a/api/@ohos.file.fs.d.ets +++ b/api/@ohos.file.fs.d.ets @@ -455,6 +455,7 @@ function copy(srcUri: string, destUri: string, options: CopyOptions, callback: A * @throws { BusinessError } 13900042 - Unknown error * @throws { BusinessError } 13900044 - Network is unreachable * @syscap SystemCapability.FileManagement.File.FileIO + * @crossplatform * @since 20 */ function copyDir(src: string, dest: string, mode?: number): Promise; @@ -483,6 +484,7 @@ function copyDir(src: string, dest: string, mode?: number): Promise; * @throws { BusinessError } 13900038 - Value too large for defined data type * @throws { BusinessError } 13900042 - Unknown error * @syscap SystemCapability.FileManagement.File.FileIO + * @crossplatform * @since 20 */ function copyDir(src: string, dest: string, callback: AsyncCallback): void; @@ -495,6 +497,7 @@ function copyDir(src: string, dest: string, callback: AsyncCallback): void * @param { AsyncCallback> } callback - Return the callback function. * @throws { BusinessError } 13900015 - File exists * @syscap SystemCapability.FileManagement.File.FileIO + * @crossplatform * @since 20 */ function copyDir(src: string, dest: string, callback: AsyncCallback>): void; @@ -524,6 +527,7 @@ function copyDir(src: string, dest: string, callback: AsyncCallback): void; @@ -537,6 +541,7 @@ function copyDir(src: string, dest: string, mode: number, callback: AsyncCallbac * @param { AsyncCallback> } callback - Return the callback function. * @throws { BusinessError } 13900015 - File exists * @syscap SystemCapability.FileManagement.File.FileIO + * @crossplatform * @since 20 */ function copyDir(src: string, dest: string, mode: number, callback: AsyncCallback>): void; @@ -567,6 +572,7 @@ function copyDir(src: string, dest: string, mode: number, callback: AsyncCallbac * @throws { BusinessError } 13900042 - Unknown error * @throws { BusinessError } 13900044 - Network is unreachable * @syscap SystemCapability.FileManagement.File.FileIO + * @crossplatform * @since 20 */ function copyDirSync(src: string, dest: string, mode?: number): void; @@ -734,6 +740,8 @@ function copyFileSync(src: string | number, dest: string | number, mode?: number * @throws { BusinessError } 13900042 - Unknown error * @throws { BusinessError } 13900044 - Network is unreachable * @syscap SystemCapability.FileManagement.File.FileIO + * @crossplatform + * @atomicservice * @since 20 */ function createStream(path: string, mode: string): Promise; @@ -771,6 +779,8 @@ function createStream(path: string, mode: string): Promise; * @throws { BusinessError } 13900041 - Quota exceeded * @throws { BusinessError } 13900042 - Unknown error * @syscap SystemCapability.FileManagement.File.FileIO + * @crossplatform + * @atomicservice * @since 20 */ function createStream(path: string, mode: string, callback: AsyncCallback): void; @@ -809,6 +819,8 @@ function createStream(path: string, mode: string, callback: AsyncCallback): void; @@ -922,6 +936,7 @@ function createRandomAccessFile(file: string | File, callback: AsyncCallback): void; @@ -961,6 +976,7 @@ function createRandomAccessFile(file: string | File, mode: number, callback: Asy * @throws { BusinessError } 13900042 - Unknown error * @throws { BusinessError } 13900044 - Network is unreachable * @syscap SystemCapability.FileManagement.File.FileIO + * @crossplatform * @since 20 */ function createRandomAccessFileSync(file: string | File, mode?: number, @@ -989,6 +1005,7 @@ function createRandomAccessFileSync(file: string | File, mode?: number, * @throws { BusinessError } 13900042 - Unknown error * @throws { BusinessError } 13900044 - Network is unreachable * @syscap SystemCapability.FileManagement.File.FileIO + * @crossplatform * @since 20 */ function createReadStream(path: string, options?: ReadStreamOptions): ReadStream; @@ -1018,6 +1035,7 @@ function createReadStream(path: string, options?: ReadStreamOptions): ReadStream * @throws { BusinessError } 13900041 - Quota exceeded * @throws { BusinessError } 13900042 - Unknown error * @syscap SystemCapability.FileManagement.File.FileIO + * @crossplatform * @since 20 */ function createWriteStream(path: string, options?: WriteStreamOptions): WriteStream; @@ -1043,6 +1061,7 @@ function createWriteStream(path: string, options?: WriteStreamOptions): WriteStr * @throws { BusinessError } 13900030 - File name too long * @throws { BusinessError } 13900042 - Unknown error * @syscap SystemCapability.FileManagement.File.FileIO + * @crossplatform * @since 20 */ function createWatcher(path: string, events: number, listener: WatchEventListener): Watcher; @@ -1151,6 +1170,8 @@ function fdatasyncSync(fd: number): void; * @throws { BusinessError } 13900041 - Quota exceeded * @throws { BusinessError } 13900042 - Unknown error * @syscap SystemCapability.FileManagement.File.FileIO + * @crossplatform + * @atomicservice * @since 20 */ function fdopenStream(fd: number, mode: string): Promise; @@ -1189,6 +1210,8 @@ function fdopenStream(fd: number, mode: string): Promise; * @throws { BusinessError } 13900041 - Quota exceeded * @throws { BusinessError } 13900042 - Unknown error * @syscap SystemCapability.FileManagement.File.FileIO + * @crossplatform + * @atomicservice * @since 20 */ function fdopenStream(fd: number, mode: string, callback: AsyncCallback): void; @@ -1227,6 +1250,8 @@ function fdopenStream(fd: number, mode: string, callback: AsyncCallback) * @throws { BusinessError } 13900041 - Quota exceeded * @throws { BusinessError } 13900042 - Unknown error * @syscap SystemCapability.FileManagement.File.FileIO + * @crossplatform + * @atomicservice * @since 20 */ function fdopenStreamSync(fd: number, mode: string): Stream; @@ -1402,6 +1427,7 @@ function lseek(fd: number, offset: number, whence?: WhenceType): number; * @throws { BusinessError } 13900038 - Value too large for defined data type * @throws { BusinessError } 13900042 - Unknown error * @syscap SystemCapability.FileManagement.File.FileIO + * @crossplatform * @since 20 */ function lstat(path: string): Promise; @@ -1422,6 +1448,7 @@ function lstat(path: string): Promise; * @throws { BusinessError } 13900038 - Value too large for defined data type * @throws { BusinessError } 13900042 - Unknown error * @syscap SystemCapability.FileManagement.File.FileIO + * @crossplatform * @since 20 */ function lstat(path: string, callback: AsyncCallback): void; @@ -1442,6 +1469,7 @@ function lstat(path: string, callback: AsyncCallback): void; * @throws { BusinessError } 13900038 - Value too large for defined data type * @throws { BusinessError } 13900042 - Unknown error * @syscap SystemCapability.FileManagement.File.FileIO + * @crossplatform * @since 20 */ function lstatSync(path: string): Stat; @@ -1495,6 +1523,7 @@ function mkdir(path: string): Promise; * @throws { BusinessError } 13900041 - Quota exceeded * @throws { BusinessError } 13900042 - Unknown error * @syscap SystemCapability.FileManagement.File.FileIO + * @crossplatform * @atomicservice * @since 20 */ @@ -1549,6 +1578,7 @@ function mkdir(path: string, callback: AsyncCallback): void; * @throws { BusinessError } 13900041 - Quota exceeded * @throws { BusinessError } 13900042 - Unknown error * @syscap SystemCapability.FileManagement.File.FileIO + * @crossplatform * @atomicservice * @since 20 */ @@ -1601,6 +1631,7 @@ function mkdirSync(path: string): void; * @throws { BusinessError } 13900041 - Quota exceeded * @throws { BusinessError } 13900042 - Unknown error * @syscap SystemCapability.FileManagement.File.FileIO + * @crossplatform * @atomicservice * @since 20 */ @@ -1711,6 +1742,7 @@ function mkdtempSync(prefix: string): string; * @throws { BusinessError } 13900041 - Quota exceeded * @throws { BusinessError } 13900042 - Unknown error * @syscap SystemCapability.FileManagement.File.FileIO + * @crossplatform * @since 20 */ function moveDir(src: string, dest: string, mode?: number): Promise; @@ -1740,6 +1772,7 @@ function moveDir(src: string, dest: string, mode?: number): Promise; * @throws { BusinessError } 13900041 - Quota exceeded * @throws { BusinessError } 13900042 - Unknown error * @syscap SystemCapability.FileManagement.File.FileIO + * @crossplatform * @since 20 */ function moveDir(src: string, dest: string, callback: AsyncCallback): void; @@ -1752,6 +1785,7 @@ function moveDir(src: string, dest: string, callback: AsyncCallback): void * @param { AsyncCallback> } callback - Return the callback function. * @throws { BusinessError } 13900015 - File exists * @syscap SystemCapability.FileManagement.File.FileIO + * @crossplatform * @since 20 */ function moveDir(src: string, dest: string, callback: AsyncCallback>): void; @@ -1782,6 +1816,7 @@ function moveDir(src: string, dest: string, callback: AsyncCallback): void; @@ -1795,6 +1830,7 @@ function moveDir(src: string, dest: string, mode: number, callback: AsyncCallbac * @param { AsyncCallback> } callback - Return the callback function. * @throws { BusinessError } 13900015 - File exists * @syscap SystemCapability.FileManagement.File.FileIO + * @crossplatform * @since 20 */ function moveDir(src: string, dest: string, mode: number, callback: AsyncCallback>): void; @@ -1825,6 +1861,7 @@ function moveDir(src: string, dest: string, mode: number, callback: AsyncCallbac * @throws { BusinessError } 13900041 - Quota exceeded * @throws { BusinessError } 13900042 - Unknown error * @syscap SystemCapability.FileManagement.File.FileIO + * @crossplatform * @since 20 */ function moveDirSync(src: string, dest: string, mode?: number): void; @@ -2238,6 +2275,7 @@ function readSync( * @throws { BusinessError } 13900042 - Unknown error * @throws { BusinessError } 13900044 - Network is unreachable * @syscap SystemCapability.FileManagement.File.FileIO + * @crossplatform * @since 20 */ function readLines(filePath: string, options?: Options): Promise; @@ -2260,6 +2298,7 @@ function readLines(filePath: string, options?: Options): Promise * @throws { BusinessError } 13900041 - Quota exceeded * @throws { BusinessError } 13900042 - Unknown error * @syscap SystemCapability.FileManagement.File.FileIO + * @crossplatform * @since 20 */ function readLines(filePath: string, callback: AsyncCallback): void; @@ -2283,6 +2322,7 @@ function readLines(filePath: string, callback: AsyncCallback): v * @throws { BusinessError } 13900041 - Quota exceeded * @throws { BusinessError } 13900042 - Unknown error * @syscap SystemCapability.FileManagement.File.FileIO + * @crossplatform * @since 20 */ function readLines(filePath: string, options: Options, callback: AsyncCallback): void; @@ -2307,6 +2347,7 @@ function readLines(filePath: string, options: Options, callback: AsyncCallback; * @throws { BusinessError } 13900041 - Quota exceeded * @throws { BusinessError } 13900042 - Unknown error * @syscap SystemCapability.FileManagement.File.FileIO + * @crossplatform * @since 20 */ function setxattr(path: string, key: string, value: string): Promise; @@ -3141,6 +3183,7 @@ function setxattr(path: string, key: string, value: string): Promise; * @throws { BusinessError } 13900041 - Quota exceeded * @throws { BusinessError } 13900042 - Unknown error * @syscap SystemCapability.FileManagement.File.FileIO + * @crossplatform * @since 20 */ @@ -3162,6 +3205,7 @@ function setxattrSync(path: string, key: string, value: string): void; * @throws { BusinessError } 13900038 - Value too large for defined data type * @throws { BusinessError } 13900042 - Unknown error * @syscap SystemCapability.FileManagement.File.FileIO + * @crossplatform * @since 20 */ function getxattr(path: string, key: string): Promise; @@ -3182,6 +3226,7 @@ function getxattr(path: string, key: string): Promise; * @throws { BusinessError } 13900038 - Value too large for defined data type * @throws { BusinessError } 13900042 - Unknown error * @syscap SystemCapability.FileManagement.File.FileIO + * @crossplatform * @since 20 */ function getxattrSync(path: string, key: string): string; @@ -3308,6 +3353,7 @@ interface File { * @throws { BusinessError } 13900042 - Unknown error * @throws { BusinessError } 14300002 - Invalid URI * @syscap SystemCapability.FileManagement.File.FileIO + * @crossplatform * @since 20 */ readonly path: string; @@ -3320,6 +3366,7 @@ interface File { * @throws { BusinessError } 13900005 - I/O error * @throws { BusinessError } 13900042 - Unknown error * @syscap SystemCapability.FileManagement.File.FileIO + * @crossplatform * @since 20 */ readonly name: string; @@ -3332,6 +3379,7 @@ interface File { * @throws { BusinessError } 13900042 - Unknown error * @throws { BusinessError } 14300002 - Invalid URI * @syscap SystemCapability.FileManagement.File.FileIO + * @crossplatform * @since 20 */ getParent(): string; @@ -3418,6 +3466,7 @@ interface File { * * @interface RandomAccessFile * @syscap SystemCapability.FileManagement.File.FileIO + * @crossplatform * @since 20 */ interface RandomAccessFile { @@ -3428,6 +3477,7 @@ interface RandomAccessFile { * @type { number } * @readonly * @syscap SystemCapability.FileManagement.File.FileIO + * @crossplatform * @since 20 */ readonly fd: number; @@ -3438,6 +3488,7 @@ interface RandomAccessFile { * @type { number } * @readonly * @syscap SystemCapability.FileManagement.File.FileIO + * @crossplatform * @since 20 */ readonly filePointer: number; @@ -3452,6 +3503,7 @@ interface RandomAccessFile { * @throws { BusinessError } 13900020 - Invalid argument * @throws { BusinessError } 13900042 - Unknown error * @syscap SystemCapability.FileManagement.File.FileIO + * @crossplatform * @since 20 */ setFilePointer(filePointer: number): void; @@ -3466,6 +3518,7 @@ interface RandomAccessFile { * @throws { BusinessError } 13900041 - Quota exceeded * @throws { BusinessError } 13900042 - Unknown error * @syscap SystemCapability.FileManagement.File.FileIO + * @crossplatform * @since 20 */ close(): void; @@ -3489,6 +3542,7 @@ interface RandomAccessFile { * @throws { BusinessError } 13900041 - Quota exceeded * @throws { BusinessError } 13900042 - Unknown error * @syscap SystemCapability.FileManagement.File.FileIO + * @crossplatform * @since 20 */ write( @@ -3514,6 +3568,7 @@ interface RandomAccessFile { * @throws { BusinessError } 13900041 - Quota exceeded * @throws { BusinessError } 13900042 - Unknown error * @syscap SystemCapability.FileManagement.File.FileIO + * @crossplatform * @since 20 */ write(buffer: ArrayBuffer | string, callback: AsyncCallback): void; @@ -3537,6 +3592,7 @@ interface RandomAccessFile { * @throws { BusinessError } 13900041 - Quota exceeded * @throws { BusinessError } 13900042 - Unknown error * @syscap SystemCapability.FileManagement.File.FileIO + * @crossplatform * @since 20 */ write( @@ -3564,6 +3620,7 @@ interface RandomAccessFile { * @throws { BusinessError } 13900041 - Quota exceeded * @throws { BusinessError } 13900042 - Unknown error * @syscap SystemCapability.FileManagement.File.FileIO + * @crossplatform * @since 20 */ writeSync( @@ -3588,6 +3645,7 @@ interface RandomAccessFile { * @throws { BusinessError } 13900042 - Unknown error * @throws { BusinessError } 13900044 - Network is unreachable * @syscap SystemCapability.FileManagement.File.FileIO + * @crossplatform * @since 20 */ read( @@ -3610,6 +3668,7 @@ interface RandomAccessFile { * @throws { BusinessError } 13900034 - Operation would block * @throws { BusinessError } 13900042 - Unknown error * @syscap SystemCapability.FileManagement.File.FileIO + * @crossplatform * @since 20 */ read(buffer: ArrayBuffer, callback: AsyncCallback): void; @@ -3630,6 +3689,7 @@ interface RandomAccessFile { * @throws { BusinessError } 13900034 - Operation would block * @throws { BusinessError } 13900042 - Unknown error * @syscap SystemCapability.FileManagement.File.FileIO + * @crossplatform * @since 20 */ read( @@ -3655,6 +3715,7 @@ interface RandomAccessFile { * @throws { BusinessError } 13900042 - Unknown error * @throws { BusinessError } 13900044 - Network is unreachable * @syscap SystemCapability.FileManagement.File.FileIO + * @crossplatform * @since 20 */ readSync( @@ -3698,6 +3759,7 @@ interface RandomAccessFile { * * @extends stream.Readable * @syscap SystemCapability.FileManagement.File.FileIO + * @crossplatform * @since 20 */ class ReadStream extends stream.Readable { @@ -3705,6 +3767,7 @@ class ReadStream extends stream.Readable { * The ReadStream constructor. * * @syscap SystemCapability.FileManagement.File.FileIO + * @crossplatform * @since 20 */ constructor(); @@ -3716,6 +3779,7 @@ class ReadStream extends stream.Readable { * @readonly * @throws { BusinessError } 13900042 - Unknown error * @syscap SystemCapability.FileManagement.File.FileIO + * @crossplatform * @since 20 */ readonly bytesRead: number; @@ -3727,6 +3791,7 @@ class ReadStream extends stream.Readable { * @readonly * @throws { BusinessError } 13900042 - Unknown error * @syscap SystemCapability.FileManagement.File.FileIO + * @crossplatform * @since 20 */ readonly path: string; @@ -3742,6 +3807,7 @@ class ReadStream extends stream.Readable { * @throws { BusinessError } 13900026 - Illegal seek * @throws { BusinessError } 13900042 - Unknown error * @syscap SystemCapability.FileManagement.File.FileIO + * @crossplatform * @since 20 */ seek(offset: number, whence?: WhenceType): number; @@ -3756,6 +3822,7 @@ class ReadStream extends stream.Readable { * @throws { BusinessError } 13900041 - Quota exceeded * @throws { BusinessError } 13900042 - Unknown error * @syscap SystemCapability.FileManagement.File.FileIO + * @crossplatform * @since 20 */ close(): void; @@ -3766,6 +3833,7 @@ class ReadStream extends stream.Readable { * * @extends stream.Writable * @syscap SystemCapability.FileManagement.File.FileIO + * @crossplatform * @since 20 */ class WriteStream extends stream.Writable { @@ -3773,6 +3841,7 @@ class WriteStream extends stream.Writable { * The WriteStream constructor. * * @syscap SystemCapability.FileManagement.File.FileIO + * @crossplatform * @since 20 */ constructor(); @@ -3784,6 +3853,7 @@ class WriteStream extends stream.Writable { * @readonly * @throws { BusinessError } 13900042 - Unknown error * @syscap SystemCapability.FileManagement.File.FileIO + * @crossplatform * @since 20 */ readonly bytesWritten: number; @@ -3795,6 +3865,7 @@ class WriteStream extends stream.Writable { * @readonly * @throws { BusinessError } 13900042 - Unknown error * @syscap SystemCapability.FileManagement.File.FileIO + * @crossplatform * @since 20 */ readonly path: string; @@ -3810,6 +3881,7 @@ class WriteStream extends stream.Writable { * @throws { BusinessError } 13900026 - Illegal seek * @throws { BusinessError } 13900042 - Unknown error * @syscap SystemCapability.FileManagement.File.FileIO + * @crossplatform * @since 20 */ seek(offset: number, whence?: WhenceType): number; @@ -3824,6 +3896,7 @@ class WriteStream extends stream.Writable { * @throws { BusinessError } 13900041 - Quota exceeded * @throws { BusinessError } 13900042 - Unknown error * @syscap SystemCapability.FileManagement.File.FileIO + * @crossplatform * @since 20 */ close(): void; @@ -3832,6 +3905,7 @@ class WriteStream extends stream.Writable { /** * The AtomicFile class provides methods for performing atomic operations on files. * @syscap SystemCapability.FileManagement.File.FileIO + * @crossplatform * @since 20 */ export class AtomicFile { @@ -3840,6 +3914,7 @@ export class AtomicFile { * @param { string } path file path. * @throws { BusinessError } 401 Parameter error.Possible causes:1.Mandatory parameters are left unspecified; 2.Incorrect parameter types. * @syscap SystemCapability.FileManagement.File.FileIO + * @crossplatform * @since 20 */ constructor(path: string); @@ -3852,6 +3927,7 @@ export class AtomicFile { * @throws { BusinessError } 13900012 Permission denied * @throws { BusinessError } 13900042 Internal error * @syscap SystemCapability.FileManagement.File.FileIO + * @crossplatform * @since 20 */ getBaseFile(): File; @@ -3864,6 +3940,7 @@ export class AtomicFile { * @throws { BusinessError } 13900012 Permission denied * @throws { BusinessError } 13900042 Internal error * @syscap SystemCapability.FileManagement.File.FileIO + * @crossplatform * @since 20 */ openRead(): ReadStream; @@ -3874,6 +3951,7 @@ export class AtomicFile { * @throws { BusinessError } 13900005 I/O error * @throws { BusinessError } 13900042 Internal error * @syscap SystemCapability.FileManagement.File.FileIO + * @crossplatform * @since 20 */ readFully(): ArrayBuffer; @@ -3887,6 +3965,7 @@ export class AtomicFile { * @throws { BusinessError } 13900027 Read-only file system * @throws { BusinessError } 13900042 Internal error * @syscap SystemCapability.FileManagement.File.FileIO + * @crossplatform * @since 20 */ startWrite(): WriteStream; @@ -3895,6 +3974,7 @@ export class AtomicFile { * If the file is written successfully, the file is closed. * @throws { BusinessError } 13900042 Internal error * @syscap SystemCapability.FileManagement.File.FileIO + * @crossplatform * @since 20 */ finishWrite(): void; @@ -3903,6 +3983,7 @@ export class AtomicFile { * If writing to the file fails, the file is rolled back. * @throws { BusinessError } 13900042 Internal error * @syscap SystemCapability.FileManagement.File.FileIO + * @crossplatform * @since 20 */ failWrite(): void; @@ -3915,6 +3996,7 @@ export class AtomicFile { * @throws { BusinessError } 13900027 Read-only file system * @throws { BusinessError } 13900042 Internal error * @syscap SystemCapability.FileManagement.File.FileIO + * @crossplatform * @since 20 */ delete(): void; @@ -4157,6 +4239,8 @@ interface Stat { * * @interface Stream * @syscap SystemCapability.FileManagement.File.FileIO + * @crossplatform + * @atomicservice * @since 20 */ interface Stream { @@ -4171,6 +4255,8 @@ interface Stream { * @throws { BusinessError } 13900041 - Quota exceeded * @throws { BusinessError } 13900042 - Unknown error * @syscap SystemCapability.FileManagement.File.FileIO + * @crossplatform + * @atomicservice * @since 20 */ close(): Promise; @@ -4186,6 +4272,8 @@ interface Stream { * @throws { BusinessError } 13900041 - Quota exceeded * @throws { BusinessError } 13900042 - Unknown error * @syscap SystemCapability.FileManagement.File.FileIO + * @crossplatform + * @atomicservice * @since 20 */ close(callback: AsyncCallback): void; @@ -4200,6 +4288,8 @@ interface Stream { * @throws { BusinessError } 13900041 - Quota exceeded * @throws { BusinessError } 13900042 - Unknown error * @syscap SystemCapability.FileManagement.File.FileIO + * @crossplatform + * @atomicservice * @since 20 */ closeSync(): void; @@ -4221,6 +4311,8 @@ interface Stream { * @throws { BusinessError } 13900041 - Quota exceeded * @throws { BusinessError } 13900042 - Unknown error * @syscap SystemCapability.FileManagement.File.FileIO + * @crossplatform + * @atomicservice * @since 20 */ flush(): Promise; @@ -4242,6 +4334,8 @@ interface Stream { * @throws { BusinessError } 13900041 - Quota exceeded * @throws { BusinessError } 13900042 - Unknown error * @syscap SystemCapability.FileManagement.File.FileIO + * @crossplatform + * @atomicservice * @since 20 */ flush(callback: AsyncCallback): void; @@ -4262,6 +4356,8 @@ interface Stream { * @throws { BusinessError } 13900041 - Quota exceeded * @throws { BusinessError } 13900042 - Unknown error * @syscap SystemCapability.FileManagement.File.FileIO + * @crossplatform + * @atomicservice * @since 20 */ flushSync(): void; @@ -4285,6 +4381,8 @@ interface Stream { * @throws { BusinessError } 13900041 - Quota exceeded * @throws { BusinessError } 13900042 - Unknown error * @syscap SystemCapability.FileManagement.File.FileIO + * @crossplatform + * @atomicservice * @since 20 */ write( @@ -4310,6 +4408,8 @@ interface Stream { * @throws { BusinessError } 13900041 - Quota exceeded * @throws { BusinessError } 13900042 - Unknown error * @syscap SystemCapability.FileManagement.File.FileIO + * @crossplatform + * @atomicservice * @since 20 */ write(buffer: ArrayBuffer | string, callback: AsyncCallback): void; @@ -4333,6 +4433,8 @@ interface Stream { * @throws { BusinessError } 13900041 - Quota exceeded * @throws { BusinessError } 13900042 - Unknown error * @syscap SystemCapability.FileManagement.File.FileIO + * @crossplatform + * @atomicservice * @since 20 */ write( @@ -4360,6 +4462,8 @@ interface Stream { * @throws { BusinessError } 13900041 - Quota exceeded * @throws { BusinessError } 13900042 - Unknown error * @syscap SystemCapability.FileManagement.File.FileIO + * @crossplatform + * @atomicservice * @since 20 */ writeSync( @@ -4384,6 +4488,8 @@ interface Stream { * @throws { BusinessError } 13900042 - Unknown error * @throws { BusinessError } 13900044 - Network is unreachable * @syscap SystemCapability.FileManagement.File.FileIO + * @crossplatform + * @atomicservice * @since 20 */ read( @@ -4406,6 +4512,8 @@ interface Stream { * @throws { BusinessError } 13900034 - Operation would block * @throws { BusinessError } 13900042 - Unknown error * @syscap SystemCapability.FileManagement.File.FileIO + * @crossplatform + * @atomicservice * @since 20 */ read(buffer: ArrayBuffer, callback: AsyncCallback): void; @@ -4426,6 +4534,8 @@ interface Stream { * @throws { BusinessError } 13900034 - Operation would block * @throws { BusinessError } 13900042 - Unknown error * @syscap SystemCapability.FileManagement.File.FileIO + * @crossplatform + * @atomicservice * @since 20 */ read( @@ -4451,6 +4561,8 @@ interface Stream { * @throws { BusinessError } 13900042 - Unknown error * @throws { BusinessError } 13900044 - Network is unreachable * @syscap SystemCapability.FileManagement.File.FileIO + * @crossplatform + * @atomicservice * @since 20 */ readSync( @@ -4464,6 +4576,7 @@ interface Stream { * * @interface Watcher * @syscap SystemCapability.FileManagement.File.FileIO + * @crossplatform * @since 20 */ interface Watcher { @@ -4484,6 +4597,7 @@ interface Watcher { * @throws { BusinessError } 13900030 - File name too long * @throws { BusinessError } 13900042 - Unknown error * @syscap SystemCapability.FileManagement.File.FileIO + * @crossplatform * @since 20 */ start(): void; @@ -4505,6 +4619,7 @@ interface Watcher { * @throws { BusinessError } 13900030 - File name too long * @throws { BusinessError } 13900042 - Unknown error * @syscap SystemCapability.FileManagement.File.FileIO + * @crossplatform * @since 20 */ stop(): void; @@ -4515,6 +4630,7 @@ interface Watcher { * * @enum { number } whence type * @syscap SystemCapability.FileManagement.File.FileIO + * @crossplatform * @since 20 */ enum WhenceType { @@ -4522,6 +4638,7 @@ enum WhenceType { * Starting position of the file offset. * * @syscap SystemCapability.FileManagement.File.FileIO + * @crossplatform * @since 20 */ SEEK_SET = 0, @@ -4530,6 +4647,7 @@ enum WhenceType { * Current position of the file offset. * * @syscap SystemCapability.FileManagement.File.FileIO + * @crossplatform * @since 20 */ SEEK_CUR = 1, @@ -4538,6 +4656,7 @@ enum WhenceType { * Ending position of the file offset. * * @syscap SystemCapability.FileManagement.File.FileIO + * @crossplatform * @since 20 */ SEEK_END = 2, @@ -4573,6 +4692,7 @@ enum LocationType { * * @enum { number } access mode type * @syscap SystemCapability.FileManagement.File.FileIO + * @crossplatform * @atomicservice * @since 20 */ @@ -4581,6 +4701,7 @@ enum AccessModeType { * Check if the file exists. * * @syscap SystemCapability.FileManagement.File.FileIO + * @crossplatform * @atomicservice * @since 20 */ @@ -4590,6 +4711,7 @@ enum AccessModeType { * Check if the file has write permission. * * @syscap SystemCapability.FileManagement.File.FileIO + * @crossplatform * @atomicservice * @since 20 */ @@ -4599,6 +4721,7 @@ enum AccessModeType { * Check if the file has read permission. * * @syscap SystemCapability.FileManagement.File.FileIO + * @crossplatform * @atomicservice * @since 20 */ @@ -4608,6 +4731,7 @@ enum AccessModeType { * Check if the file has read and write permission. * * @syscap SystemCapability.FileManagement.File.FileIO + * @crossplatform * @atomicservice * @since 20 */ @@ -4636,6 +4760,7 @@ enum AccessFlagType { * * @interface ReaderIterator * @syscap SystemCapability.FileManagement.File.FileIO + * @crossplatform * @since 20 */ interface ReaderIterator { @@ -4647,6 +4772,7 @@ interface ReaderIterator { * @throws { BusinessError } 13900037 - No data available * @throws { BusinessError } 13900042 - Unknown error * @syscap SystemCapability.FileManagement.File.FileIO + * @crossplatform * @since 20 */ next(): ReaderIteratorResult; @@ -4660,6 +4786,7 @@ interface ReaderIterator { * @typedef { function } WatchEventListener * @param { WatchEvent } event - Event type for the callback to invoke. * @syscap SystemCapability.FileManagement.File.FileIO + * @crossplatform * @since 20 */ export type WatchEventListener = (event: WatchEvent) => void; @@ -4669,6 +4796,7 @@ export type WatchEventListener = (event: WatchEvent) => void; * * @interface WatchEvent * @syscap SystemCapability.FileManagement.File.FileIO + * @crossplatform * @since 20 */ export interface WatchEvent { @@ -4678,6 +4806,7 @@ export interface WatchEvent { * @type { string } * @readonly * @syscap SystemCapability.FileManagement.File.FileIO + * @crossplatform * @since 20 */ readonly fileName: string; @@ -4688,6 +4817,7 @@ export interface WatchEvent { * @type { number } * @readonly * @syscap SystemCapability.FileManagement.File.FileIO + * @crossplatform * @since 20 */ readonly event: number; @@ -4698,6 +4828,7 @@ export interface WatchEvent { * @type { number } * @readonly * @syscap SystemCapability.FileManagement.File.FileIO + * @crossplatform * @since 20 */ readonly cookie: number; @@ -4708,6 +4839,7 @@ export interface WatchEvent { * * @interface ReaderIteratorResult * @syscap SystemCapability.FileManagement.File.FileIO + * @crossplatform * @since 20 */ export interface ReaderIteratorResult { @@ -4716,6 +4848,7 @@ export interface ReaderIteratorResult { * * @type { boolean } * @syscap SystemCapability.FileManagement.File.FileIO + * @crossplatform * @since 20 */ done: boolean; @@ -4725,6 +4858,7 @@ export interface ReaderIteratorResult { * * @type { string } * @syscap SystemCapability.FileManagement.File.FileIO + * @crossplatform * @since 20 */ value: string; @@ -4813,6 +4947,7 @@ export interface Filter { * * @interface ConflictFiles * @syscap SystemCapability.FileManagement.File.FileIO + * @crossplatform * @since 20 */ export interface ConflictFiles { @@ -4822,6 +4957,7 @@ export interface ConflictFiles { * * @type { string } * @syscap SystemCapability.FileManagement.File.FileIO + * @crossplatform * @since 20 */ srcFile: string; @@ -4831,6 +4967,7 @@ export interface ConflictFiles { * * @type { string } * @syscap SystemCapability.FileManagement.File.FileIO + * @crossplatform * @since 20 */ destFile: string; @@ -4841,6 +4978,7 @@ export interface ConflictFiles { * * @interface Options * @syscap SystemCapability.FileManagement.File.FileIO + * @crossplatform * @since 20 */ export interface Options { @@ -4849,6 +4987,7 @@ export interface Options { * * @type { ?string } * @syscap SystemCapability.FileManagement.File.FileIO + * @crossplatform * @since 20 */ encoding?: string; @@ -4859,6 +4998,7 @@ export interface Options { * * @interface ReadOptions * @syscap SystemCapability.FileManagement.File.FileIO + * @crossplatform * @atomicservice * @since 20 */ @@ -4868,6 +5008,7 @@ export interface ReadOptions { * * @type { ?number } * @syscap SystemCapability.FileManagement.File.FileIO + * @crossplatform * @atomicservice * @since 20 */ @@ -4877,6 +5018,7 @@ export interface ReadOptions { * * @type { ?number } * @syscap SystemCapability.FileManagement.File.FileIO + * @crossplatform * @atomicservice * @since 20 */ @@ -4889,6 +5031,7 @@ export interface ReadOptions { * @extends ReadOptions * @interface ReadTextOptions * @syscap SystemCapability.FileManagement.File.FileIO + * @crossplatform * @atomicservice * @since 20 */ @@ -4898,6 +5041,7 @@ export interface ReadTextOptions extends ReadOptions { * * @type { ?string } * @syscap SystemCapability.FileManagement.File.FileIO + * @crossplatform * @atomicservice * @since 20 */ @@ -4910,6 +5054,7 @@ export interface ReadTextOptions extends ReadOptions { * @extends Options * @interface WriteOptions * @syscap SystemCapability.FileManagement.File.FileIO + * @crossplatform * @atomicservice * @since 20 */ @@ -4919,6 +5064,7 @@ export interface WriteOptions extends Options { * * @type { ?number } * @syscap SystemCapability.FileManagement.File.FileIO + * @crossplatform * @atomicservice * @since 20 */ @@ -4928,6 +5074,7 @@ export interface WriteOptions extends Options { * * @type { ?number } * @syscap SystemCapability.FileManagement.File.FileIO + * @crossplatform * @atomicservice * @since 20 */ @@ -4979,6 +5126,7 @@ export interface ListFileOptions { * * @interface RandomAccessFileOptions * @syscap SystemCapability.FileManagement.File.FileIO + * @crossplatform * @since 20 */ export interface RandomAccessFileOptions { @@ -4987,6 +5135,7 @@ export interface RandomAccessFileOptions { * * @type { ?number } * @syscap SystemCapability.FileManagement.File.FileIO + * @crossplatform * @since 20 */ start?: number; @@ -4996,6 +5145,7 @@ export interface RandomAccessFileOptions { * * @type { ?number } * @syscap SystemCapability.FileManagement.File.FileIO + * @crossplatform * @since 20 */ end?: number; @@ -5006,6 +5156,7 @@ export interface RandomAccessFileOptions { * * @interface ReadStreamOptions * @syscap SystemCapability.FileManagement.File.FileIO + * @crossplatform * @since 20 */ export interface ReadStreamOptions { @@ -5014,6 +5165,7 @@ export interface ReadStreamOptions { * * @type { ?number } * @syscap SystemCapability.FileManagement.File.FileIO + * @crossplatform * @since 20 */ start?: number; @@ -5023,6 +5175,7 @@ export interface ReadStreamOptions { * * @type { ?number } * @syscap SystemCapability.FileManagement.File.FileIO + * @crossplatform * @since 20 */ end?: number; @@ -5033,6 +5186,7 @@ export interface ReadStreamOptions { * * @interface WriteStreamOptions * @syscap SystemCapability.FileManagement.File.FileIO + * @crossplatform * @since 20 */ export interface WriteStreamOptions { @@ -5041,6 +5195,7 @@ export interface WriteStreamOptions { * * @type { ?number } * @syscap SystemCapability.FileManagement.File.FileIO + * @crossplatform * @since 20 */ mode?: number; @@ -5049,6 +5204,7 @@ export interface WriteStreamOptions { * * @type { ?number } * @syscap SystemCapability.FileManagement.File.FileIO + * @crossplatform * @since 20 */ start?: number; diff --git a/api/@ohos.file.securityLabel.d.ts b/api/@ohos.file.securityLabel.d.ts index 1050c3b3240f692cb49c0268eb2f8613400aaf65..f675714f290243f5a5c0523564e77f1fb7106385 100644 --- a/api/@ohos.file.securityLabel.d.ts +++ b/api/@ohos.file.securityLabel.d.ts @@ -1,5 +1,5 @@ /* - * Copyright (C) 2022-2023 Huawei Device Co., Ltd. + * Copyright (C) 2022-2025 Huawei Device Co., Ltd. * Licensed under the Apache License, Version 2.0 (the "License"); * you may not use this file except in compliance with the License. * You may obtain a copy of the License at diff --git a/api/@ohos.file.statvfs.d.ts b/api/@ohos.file.statvfs.d.ts index 9dd4b53226e8f0100d6688e4659aa44f62ccc81c..ceadd105343efd2fb43134452e9bc7305e2e82d6 100644 --- a/api/@ohos.file.statvfs.d.ts +++ b/api/@ohos.file.statvfs.d.ts @@ -1,5 +1,5 @@ /* - * Copyright (C) 2022-2023 Huawei Device Co., Ltd. + * Copyright (C) 2022-2025 Huawei Device Co., Ltd. * Licensed under the Apache License, Version 2.0 (the "License"); * you may not use this file except in compliance with the License. * You may obtain a copy of the License at @@ -25,7 +25,15 @@ import type { AsyncCallback } from './@ohos.base'; * * @namespace statfs * @syscap SystemCapability.FileManagement.File.FileIO - * @since arkts {'1.1':'9', '1.2':'20'} + * @since 9 + */ +/** + * Provides filesystem statistics APIs + * + * @namespace statfs + * @syscap SystemCapability.FileManagement.File.FileIO + * @crossplatform + * @since 20 * @arkts 1.1&1.2 */ declare namespace statfs { @@ -48,7 +56,29 @@ declare namespace statfs { * @throws { BusinessError } 13900038 - Value too large for defined data type * @throws { BusinessError } 13900042 - Unknown error * @syscap SystemCapability.FileManagement.File.FileIO - * @since arkts {'1.1':'9', '1.2':'20'} + * @since 9 + */ + /** + * Get the number of free bytes on the specified path. + * + * @param { string } path - path + * @returns { Promise } return Promise + * @throws { BusinessError } 13900002 - No such file or directory + * @throws { BusinessError } 13900004 - Interrupted system call + * @throws { BusinessError } 13900005 - I/O error + * @throws { BusinessError } 13900008 - Bad file descriptor + * @throws { BusinessError } 13900011 - Out of memory + * @throws { BusinessError } 13900012 - Permission denied + * @throws { BusinessError } 13900013 - Bad address + * @throws { BusinessError } 13900018 - Not a directory + * @throws { BusinessError } 13900030 - File name too long + * @throws { BusinessError } 13900031 - Function not implemented + * @throws { BusinessError } 13900033 - Too many symbolic links encountered + * @throws { BusinessError } 13900038 - Value too large for defined data type + * @throws { BusinessError } 13900042 - Unknown error + * @syscap SystemCapability.FileManagement.File.FileIO + * @crossplatform + * @since 20 * @arkts 1.1&1.2 */ function getFreeSize(path: string): Promise; @@ -72,7 +102,29 @@ declare namespace statfs { * @throws { BusinessError } 13900038 - Value too large for defined data type * @throws { BusinessError } 13900042 - Unknown error * @syscap SystemCapability.FileManagement.File.FileIO - * @since arkts {'1.1':'9', '1.2':'20'} + * @since 9 + */ + /** + * Get the number of free bytes on the specified path. + * + * @param { string } path - path + * @param { AsyncCallback } [callback] - callback + * @throws { BusinessError } 13900002 - No such file or directory + * @throws { BusinessError } 13900004 - Interrupted system call + * @throws { BusinessError } 13900005 - I/O error + * @throws { BusinessError } 13900008 - Bad file descriptor + * @throws { BusinessError } 13900011 - Out of memory + * @throws { BusinessError } 13900012 - Permission denied + * @throws { BusinessError } 13900013 - Bad address + * @throws { BusinessError } 13900018 - Not a directory + * @throws { BusinessError } 13900030 - File name too long + * @throws { BusinessError } 13900031 - Function not implemented + * @throws { BusinessError } 13900033 - Too many symbolic links encountered + * @throws { BusinessError } 13900038 - Value too large for defined data type + * @throws { BusinessError } 13900042 - Unknown error + * @syscap SystemCapability.FileManagement.File.FileIO + * @crossplatform + * @since 20 * @arkts 1.1&1.2 */ function getFreeSize(path: string, callback: AsyncCallback): void; @@ -96,7 +148,29 @@ declare namespace statfs { * @throws { BusinessError } 13900038 - Value too large for defined data type * @throws { BusinessError } 13900042 - Unknown error * @syscap SystemCapability.FileManagement.File.FileIO - * @since arkts {'1.1':'10', '1.2':'20'} + * @since 10 + */ + /** + * Get the number of free bytes on the specified path with sync interface. + * + * @param { string } path - path + * @returns { number } return the number of free bytes on the specified path + * @throws { BusinessError } 13900002 - No such file or directory + * @throws { BusinessError } 13900004 - Interrupted system call + * @throws { BusinessError } 13900005 - I/O error + * @throws { BusinessError } 13900008 - Bad file descriptor + * @throws { BusinessError } 13900011 - Out of memory + * @throws { BusinessError } 13900012 - Permission denied + * @throws { BusinessError } 13900013 - Bad address + * @throws { BusinessError } 13900018 - Not a directory + * @throws { BusinessError } 13900030 - File name too long + * @throws { BusinessError } 13900031 - Function not implemented + * @throws { BusinessError } 13900033 - Too many symbolic links encountered + * @throws { BusinessError } 13900038 - Value too large for defined data type + * @throws { BusinessError } 13900042 - Unknown error + * @syscap SystemCapability.FileManagement.File.FileIO + * @crossplatform + * @since 20 * @arkts 1.1&1.2 */ function getFreeSizeSync(path: string): number; @@ -120,7 +194,29 @@ declare namespace statfs { * @throws { BusinessError } 13900038 - Value too large for defined data type * @throws { BusinessError } 13900042 - Unknown error * @syscap SystemCapability.FileManagement.File.FileIO - * @since arkts {'1.1':'9', '1.2':'20'} + * @since 9 + */ + /** + * Get the number of total bytes on the specified path. + * + * @param { string } path - path + * @returns { Promise } return Promise + * @throws { BusinessError } 13900002 - No such file or directory + * @throws { BusinessError } 13900004 - Interrupted system call + * @throws { BusinessError } 13900005 - I/O error + * @throws { BusinessError } 13900008 - Bad file descriptor + * @throws { BusinessError } 13900011 - Out of memory + * @throws { BusinessError } 13900012 - Permission denied + * @throws { BusinessError } 13900013 - Bad address + * @throws { BusinessError } 13900018 - Not a directory + * @throws { BusinessError } 13900030 - File name too long + * @throws { BusinessError } 13900031 - Function not implemented + * @throws { BusinessError } 13900033 - Too many symbolic links encountered + * @throws { BusinessError } 13900038 - Value too large for defined data type + * @throws { BusinessError } 13900042 - Unknown error + * @syscap SystemCapability.FileManagement.File.FileIO + * @crossplatform + * @since 20 * @arkts 1.1&1.2 */ function getTotalSize(path: string): Promise; @@ -144,7 +240,29 @@ declare namespace statfs { * @throws { BusinessError } 13900038 - Value too large for defined data type * @throws { BusinessError } 13900042 - Unknown error * @syscap SystemCapability.FileManagement.File.FileIO - * @since arkts {'1.1':'9', '1.2':'20'} + * @since 9 + */ + /** + * Get the number of total bytes on the specified path. + * + * @param { string } path - path + * @param { AsyncCallback } [callback] - callback + * @throws { BusinessError } 13900002 - No such file or directory + * @throws { BusinessError } 13900004 - Interrupted system call + * @throws { BusinessError } 13900005 - I/O error + * @throws { BusinessError } 13900008 - Bad file descriptor + * @throws { BusinessError } 13900011 - Out of memory + * @throws { BusinessError } 13900012 - Permission denied + * @throws { BusinessError } 13900013 - Bad address + * @throws { BusinessError } 13900018 - Not a directory + * @throws { BusinessError } 13900030 - File name too long + * @throws { BusinessError } 13900031 - Function not implemented + * @throws { BusinessError } 13900033 - Too many symbolic links encountered + * @throws { BusinessError } 13900038 - Value too large for defined data type + * @throws { BusinessError } 13900042 - Unknown error + * @syscap SystemCapability.FileManagement.File.FileIO + * @crossplatform + * @since 20 * @arkts 1.1&1.2 */ function getTotalSize(path: string, callback: AsyncCallback): void; @@ -168,7 +286,29 @@ declare namespace statfs { * @throws { BusinessError } 13900038 - Value too large for defined data type * @throws { BusinessError } 13900042 - Unknown error * @syscap SystemCapability.FileManagement.File.FileIO - * @since arkts {'1.1':'10', '1.2':'20'} + * @since 10 + */ + /** + * Get the number of total bytes on the specified path with sync interface. + * + * @param { string } path - path + * @returns { number } return the number of total bytes + * @throws { BusinessError } 13900002 - No such file or directory + * @throws { BusinessError } 13900004 - Interrupted system call + * @throws { BusinessError } 13900005 - I/O error + * @throws { BusinessError } 13900008 - Bad file descriptor + * @throws { BusinessError } 13900011 - Out of memory + * @throws { BusinessError } 13900012 - Permission denied + * @throws { BusinessError } 13900013 - Bad address + * @throws { BusinessError } 13900018 - Not a directory + * @throws { BusinessError } 13900030 - File name too long + * @throws { BusinessError } 13900031 - Function not implemented + * @throws { BusinessError } 13900033 - Too many symbolic links encountered + * @throws { BusinessError } 13900038 - Value too large for defined data type + * @throws { BusinessError } 13900042 - Unknown error + * @syscap SystemCapability.FileManagement.File.FileIO + * @crossplatform + * @since 20 * @arkts 1.1&1.2 */ function getTotalSizeSync(path: string): number;