1/* 2 * Copyright (c) 2021-2023 Huawei Device Co., Ltd. 3 * Licensed under the Apache License, Version 2.0 (the "License"); 4 * you may not use this file except in compliance with the License. 5 * You may obtain a copy of the License at 6 * 7 * http://www.apache.org/licenses/LICENSE-2.0 8 * 9 * Unless required by applicable law or agreed to in writing, software 10 * distributed under the License is distributed on an "AS IS" BASIS, 11 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 12 * See the License for the specific language governing permissions and 13 * limitations under the License. 14 */ 15 16/** 17 * @file 18 */ 19 20import { AsyncCallback } from './@ohos.base'; 21 22export default fileIO; 23 24/** 25 * fileio 26 * 27 * @namespace fileIO 28 * @syscap SystemCapability.FileManagement.File.FileIO 29 * @since 6 30 */ 31declare namespace fileIO { 32 export { access }; 33 export { accessSync }; 34 export { chmod }; 35 export { chmodSync }; 36 export { chown }; 37 export { chownSync }; 38 export { close }; 39 export { closeSync }; 40 export { copyFile }; 41 export { copyFileSync }; 42 export { createStream }; 43 export { createStreamSync }; 44 export { createWatcher }; 45 export { fchmod }; 46 export { fchmodSync }; 47 export { fchown }; 48 export { fchownSync }; 49 export { fdatasync }; 50 export { fdatasyncSync }; 51 export { fdopenStream }; 52 export { fdopenStreamSync }; 53 export { fstat }; 54 export { fstatSync }; 55 export { fsync }; 56 export { fsyncSync }; 57 export { ftruncate }; 58 export { ftruncateSync }; 59 export { hash }; 60 export { lchown }; 61 export { lchownSync }; 62 export { lstat }; 63 export { lstatSync }; 64 export { mkdir }; 65 export { mkdirSync }; 66 export { mkdtemp }; 67 export { mkdtempSync }; 68 export { open }; 69 export { openSync }; 70 export { opendir }; 71 export { opendirSync }; 72 export { read }; 73 export { readSync }; 74 export { readText }; 75 export { readTextSync }; 76 export { rename }; 77 export { renameSync }; 78 export { rmdir }; 79 export { rmdirSync }; 80 export { stat }; 81 export { statSync }; 82 export { symlink }; 83 export { symlinkSync }; 84 export { truncate }; 85 export { truncateSync }; 86 export { unlink }; 87 export { unlinkSync }; 88 export { write }; 89 export { writeSync }; 90 export { Dir }; 91 export { Dirent }; 92 export { ReadOut }; 93 export { Stat }; 94 export { Stream }; 95 export { Watcher }; 96} 97 98/** 99 * access. 100 * 101 * @param { string } path - path. 102 * @param { number } [mode = 0] - mode. 103 * @returns { Promise<void> } return Promise 104 * @throws { TypedError } Parameter check failed 105 * @syscap SystemCapability.FileManagement.File.FileIO 106 * @since 6 107 * @deprecated since 9 108 * @useinstead ohos.file.fs.access 109 */ 110declare function access(path: string, mode?: number): Promise<void>; 111 112/** 113 * access. 114 * 115 * @param { string } path - path. 116 * @param { AsyncCallback<void> } [callback] - callback. 117 * @throws { TypedError } Parameter check failed 118 * @syscap SystemCapability.FileManagement.File.FileIO 119 * @since 6 120 * @deprecated since 9 121 * @useinstead ohos.file.fs.access 122 */ 123declare function access(path: string, callback: AsyncCallback<void>): void; 124 125/** 126 * access. 127 * 128 * @param { string } path - path. 129 * @param { number } [mode = 0] - mode. 130 * @param { AsyncCallback<void> } [callback] - callback. 131 * @throws { TypedError } Parameter check failed 132 * @syscap SystemCapability.FileManagement.File.FileIO 133 * @since 6 134 * @deprecated since 9 135 * @useinstead ohos.file.fs.access 136 */ 137declare function access(path: string, mode: number, callback: AsyncCallback<void>): void; 138/** 139 * accessSync. 140 * 141 * @param { string } path - path. 142 * @param { number } [mode = 0] - mode. 143 * @throws { TypedError | Error } access fail 144 * @syscap SystemCapability.FileManagement.File.FileIO 145 * @since 6 146 * @deprecated since 9 147 * @useinstead ohos.file.fs.accessSync 148 */ 149declare function accessSync(path: string, mode?: number): void; 150/** 151 * close. 152 * 153 * @param { number } fd - fd. 154 * @returns { Promise<void> } return Promise 155 * @throws { TypedError } Parameter check failed 156 * @syscap SystemCapability.FileManagement.File.FileIO 157 * @since 7 158 * @deprecated since 9 159 * @useinstead ohos.file.fs.close 160 */ 161declare function close(fd: number): Promise<void>; 162 163/** 164 * close. 165 * 166 * @param { number } fd - fd. 167 * @param { AsyncCallback<void> } [callback] - callback. 168 * @throws { TypedError } Parameter check failed 169 * @syscap SystemCapability.FileManagement.File.FileIO 170 * @since 7 171 * @deprecated since 9 172 * @useinstead ohos.file.fs.close 173 */ 174declare function close(fd: number, callback: AsyncCallback<void>): void; 175/** 176 * closeSync. 177 * 178 * @param { number } fd - fd. 179 * @throws { TypedError | Error } close fail 180 * @syscap SystemCapability.FileManagement.File.FileIO 181 * @since 6 182 * @deprecated since 9 183 * @useinstead ohos.file.fs.closeSync 184 */ 185declare function closeSync(fd: number): void; 186/** 187 * copyFile. 188 * 189 * @param { string | number } src - src. 190 * @param { string | number } dest - dest. 191 * @param { number } [mode = 0] - mode. 192 * @returns { Promise<void> } return Promise 193 * @throws { TypedError } Parameter check failed 194 * @syscap SystemCapability.FileManagement.File.FileIO 195 * @since 6 196 * @deprecated since 9 197 * @useinstead ohos.file.fs.copyFile 198 */ 199declare function copyFile(src: string | number, dest: string | number, mode?: number): Promise<void>; 200 201/** 202 * copyFile. 203 * 204 * @param { string | number } src - src. 205 * @param { string | number } dest - dest. 206 * @param { AsyncCallback<void> } [callback] - callback. 207 * @throws { TypedError } Parameter check failed 208 * @syscap SystemCapability.FileManagement.File.FileIO 209 * @since 6 210 * @deprecated since 9 211 * @useinstead ohos.file.fs.copyFile 212 */ 213declare function copyFile(src: string | number, dest: string | number, callback: AsyncCallback<void>): void; 214 215/** 216 * copyFile. 217 * 218 * @param { string | number } src - src. 219 * @param { string | number } dest - dest. 220 * @param { number } [mode = 0] - mode. 221 * @param { AsyncCallback<void> } [callback] - callback. 222 * @throws { TypedError } Parameter check failed 223 * @syscap SystemCapability.FileManagement.File.FileIO 224 * @since 6 225 * @deprecated since 9 226 * @useinstead ohos.file.fs.copyFile 227 */ 228declare function copyFile( 229 src: string | number, 230 dest: string | number, 231 mode: number, 232 callback: AsyncCallback<void> 233): void; 234/** 235 * copyFileSync. 236 * 237 * @param { string | number } src - src. 238 * @param { string | number } dest - dest. 239 * @param { number } [mode = 0] - mode. 240 * @throws { TypedError | Error } copyFile fail 241 * @syscap SystemCapability.FileManagement.File.FileIO 242 * @since 6 243 * @deprecated since 9 244 * @useinstead ohos.file.fs.copyFileSync 245 */ 246declare function copyFileSync(src: string | number, dest: string | number, mode?: number): void; 247/** 248 * createStream. 249 * 250 * @param { string } path - path. 251 * @param { string } mode - mode. 252 * @returns { Promise<Stream> } return Promise 253 * @throws { TypedError } Parameter check failed 254 * @syscap SystemCapability.FileManagement.File.FileIO 255 * @since 7 256 * @deprecated since 9 257 * @useinstead ohos.file.fs.createStream 258 */ 259declare function createStream(path: string, mode: string): Promise<Stream>; 260 261/** 262 * createStream. 263 * 264 * @param { string } path - path. 265 * @param { string } mode - mode. 266 * @param { AsyncCallback<Stream> } [callback] - callback. 267 * @throws { TypedError } Parameter check failed 268 * @syscap SystemCapability.FileManagement.File.FileIO 269 * @since 7 270 * @deprecated since 9 271 * @useinstead ohos.file.fs.createStream 272 */ 273declare function createStream(path: string, mode: string, callback: AsyncCallback<Stream>): void; 274/** 275 * createStreamSync. 276 * 277 * @param { string } path - path. 278 * @param { string } mode - mode. 279 * @returns { Stream } createStream success 280 * @throws { TypedError } Parameter check failed 281 * @syscap SystemCapability.FileManagement.File.FileIO 282 * @since 7 283 * @deprecated since 9 284 * @useinstead ohos.file.fs.createStreamSync 285 */ 286declare function createStreamSync(path: string, mode: string): Stream; 287/** 288 * chown. 289 * 290 * @param { string } path - path. 291 * @param { number } uid - mode. 292 * @param { number } gid - mode. 293 * @returns { Promise<void> } return Promise 294 * @throws { TypedError } Parameter check failed 295 * @syscap SystemCapability.FileManagement.File.FileIO 296 * @since 7 297 * @deprecated since 9 298 */ 299declare function chown(path: string, uid: number, gid: number): Promise<void>; 300 301/** 302 * chown. 303 * 304 * @param { string } path - path. 305 * @param { number } uid - mode. 306 * @param { number } gid - mode. 307 * @param { AsyncCallback<void> } [callback] - callback. 308 * @throws { TypedError } Parameter check failed 309 * @syscap SystemCapability.FileManagement.File.FileIO 310 * @since 7 311 * @deprecated since 9 312 */ 313declare function chown(path: string, uid: number, gid: number, callback: AsyncCallback<void>): void; 314/** 315 * chownSync. 316 * 317 * @param { string } path - path. 318 * @param { number } uid - mode. 319 * @param { number } gid - mode. 320 * @throws { TypedError | Error } chown fail 321 * @syscap SystemCapability.FileManagement.File.FileIO 322 * @since 7 323 * @deprecated since 9 324 */ 325declare function chownSync(path: string, uid: number, gid: number): void; 326/** 327 * chmod. 328 * 329 * @param { string } path - path. 330 * @param { number } mode - mode. 331 * @returns { Promise<void> } return Promise 332 * @throws { TypedError } Parameter check failed 333 * @syscap SystemCapability.FileManagement.File.FileIO 334 * @since 7 335 * @deprecated since 9 336 */ 337declare function chmod(path: string, mode: number): Promise<void>; 338 339/** 340 * chmod. 341 * 342 * @param { string } path - path. 343 * @param { number } mode - mode. 344 * @param { AsyncCallback<void> } [callback] - callback. 345 * @throws { TypedError } Parameter check failed 346 * @syscap SystemCapability.FileManagement.File.FileIO 347 * @since 7 348 * @deprecated since 9 349 */ 350declare function chmod(path: string, mode: number, callback: AsyncCallback<void>): void; 351/** 352 * chmodSync. 353 * 354 * @param { string } path - path. 355 * @param { number } mode - mode. 356 * @throws { TypedError | Error } chmod fail 357 * @syscap SystemCapability.FileManagement.File.FileIO 358 * @since 7 359 * @deprecated since 9 360 */ 361declare function chmodSync(path: string, mode: number): void; 362/** 363 * ftruncate. 364 * 365 * @param { number } fd - fd. 366 * @param { number } [len = 0] - len. 367 * @returns { Promise<void> } return Promise 368 * @throws { TypedError } Parameter check failed 369 * @syscap SystemCapability.FileManagement.File.FileIO 370 * @since 7 371 * @deprecated since 9 372 * @useinstead ohos.file.fs.truncate 373 */ 374declare function ftruncate(fd: number, len?: number): Promise<void>; 375 376/** 377 * ftruncate. 378 * 379 * @param { number } fd - fd. 380 * @param { AsyncCallback<void> } [callback] - callback. 381 * @throws { TypedError } Parameter check failed 382 * @syscap SystemCapability.FileManagement.File.FileIO 383 * @since 7 384 * @deprecated since 9 385 * @useinstead ohos.file.fs.truncate 386 */ 387declare function ftruncate(fd: number, callback: AsyncCallback<void>): void; 388 389/** 390 * ftruncate. 391 * 392 * @param { number } fd - fd. 393 * @param { number } [len = 0] - len. 394 * @param { AsyncCallback<void> } [callback] - callback. 395 * @throws { TypedError } Parameter check failed 396 * @syscap SystemCapability.FileManagement.File.FileIO 397 * @since 7 398 * @deprecated since 9 399 * @useinstead ohos.file.fs.truncate 400 */ 401declare function ftruncate(fd: number, len: number, callback: AsyncCallback<void>): void; 402/** 403 * ftruncateSync. 404 * 405 * @param { number } fd - fd. 406 * @param { number } [len = 0] - len. 407 * @throws { TypedError | Error } ftruncate fail 408 * @syscap SystemCapability.FileManagement.File.FileIO 409 * @since 7 410 * @deprecated since 9 411 * @useinstead ohos.file.fs.truncateSync 412 */ 413declare function ftruncateSync(fd: number, len?: number): void; 414/** 415 * fsync. 416 * 417 * @param { number } fd - fd. 418 * @returns { Promise<void> } return Promise 419 * @throws { TypedError } Parameter check failed 420 * @syscap SystemCapability.FileManagement.File.FileIO 421 * @since 7 422 * @deprecated since 9 423 * @useinstead ohos.file.fs.fsync 424 */ 425declare function fsync(fd: number): Promise<void>; 426 427/** 428 * fsync. 429 * 430 * @param { number } fd - fd. 431 * @param { AsyncCallback<void> } [callback] - callback. 432 * @throws { TypedError } Parameter check failed 433 * @syscap SystemCapability.FileManagement.File.FileIO 434 * @since 7 435 * @deprecated since 9 436 * @useinstead ohos.file.fs.fsync 437 */ 438declare function fsync(fd: number, callback: AsyncCallback<void>): void; 439/** 440 * fsyncSync. 441 * 442 * @param { number } fd - fd. 443 * @throws { TypedError | Error } fsync fail 444 * @syscap SystemCapability.FileManagement.File.FileIO 445 * @since 7 446 * @deprecated since 9 447 * @useinstead ohos.file.fs.fsyncSync 448 */ 449declare function fsyncSync(fd: number): void; 450/** 451 * fstat. 452 * 453 * @param { number } fd - fd. 454 * @returns { Promise<Stat> } return Promise 455 * @throws { TypedError } fstat fail 456 * @syscap SystemCapability.FileManagement.File.FileIO 457 * @since 7 458 * @deprecated since 9 459 * @useinstead ohos.file.fs.stat 460 */ 461declare function fstat(fd: number): Promise<Stat>; 462 463/** 464 * fstat. 465 * 466 * @param { number } fd - fd. 467 * @param { AsyncCallback<Stat> } callback 468 * @throws { TypedError } fstat fail 469 * @syscap SystemCapability.FileManagement.File.FileIO 470 * @since 7 471 * @deprecated since 9 472 * @useinstead ohos.file.fs.stat 473 */ 474declare function fstat(fd: number, callback: AsyncCallback<Stat>): void; 475/** 476 * fstatSync. 477 * 478 * @param { number } fd - fd. 479 * @returns { Stat } stat success 480 * @throws { TypedError | Error } fstat fail 481 * @syscap SystemCapability.FileManagement.File.FileIO 482 * @since 7 483 * @deprecated since 9 484 * @useinstead ohos.file.fs.statSync 485 */ 486declare function fstatSync(fd: number): Stat; 487/** 488 * fdatasync. 489 * 490 * @param { number } fd - fd. 491 * @returns { Promise<void> } return Promise 492 * @throws { TypedError } Parameter check failed 493 * @syscap SystemCapability.FileManagement.File.FileIO 494 * @since 7 495 * @deprecated since 9 496 * @useinstead ohos.file.fs.fdatasync 497 */ 498declare function fdatasync(fd: number): Promise<void>; 499 500/** 501 * fdatasync. 502 * 503 * @param { number } fd - fd. 504 * @param { AsyncCallback<void> } [callback] - callback. 505 * @throws { TypedError } Parameter check failed 506 * @syscap SystemCapability.FileManagement.File.FileIO 507 * @since 7 508 * @deprecated since 9 509 * @useinstead ohos.file.fs.fdatasync 510 */ 511declare function fdatasync(fd: number, callback: AsyncCallback<void>): void; 512/** 513 * fdatasyncSync. 514 * 515 * @param { number } fd - fd. 516 * @throws { TypedError | Error } fdatasync fail 517 * @syscap SystemCapability.FileManagement.File.FileIO 518 * @since 7 519 * @deprecated since 9 520 * @useinstead ohos.file.fs.fdatasyncSync 521 */ 522declare function fdatasyncSync(fd: number): void; 523/** 524 * fchown. 525 * 526 * @param { number } fd - fd. 527 * @param { number } uid - uid. 528 * @param { number } gid - gid. 529 * @returns { Promise<void> } return Promise 530 * @throws { TypedError } Parameter check failed 531 * @syscap SystemCapability.FileManagement.File.FileIO 532 * @since 7 533 * @deprecated since 9 534 */ 535declare function fchown(fd: number, uid: number, gid: number): Promise<void>; 536 537/** 538 * fchown. 539 * 540 * @param { number } fd - fd. 541 * @param { number } uid - uid. 542 * @param { number } gid - gid. 543 * @param { AsyncCallback<void> } [callback] - callback. 544 * @throws { TypedError } Parameter check failed 545 * @syscap SystemCapability.FileManagement.File.FileIO 546 * @since 7 547 * @deprecated since 9 548 */ 549declare function fchown(fd: number, uid: number, gid: number, callback: AsyncCallback<void>): void; 550/** 551 * fchownSync. 552 * 553 * @param { number } fd - fd. 554 * @param { number } uid - uid. 555 * @param { number } gid - gid. 556 * @throws { TypedError | Error } fchown fail 557 * @syscap SystemCapability.FileManagement.File.FileIO 558 * @since 7 559 * @deprecated since 9 560 */ 561declare function fchownSync(fd: number, uid: number, gid: number): void; 562/** 563 * fchmod. 564 * 565 * @param { number } fd - fd. 566 * @param { number } mode - mode. 567 * @returns { Promise<void> } return Promise 568 * @throws { TypedError } Parameter check failed 569 * @syscap SystemCapability.FileManagement.File.FileIO 570 * @since 7 571 * @deprecated since 9 572 */ 573declare function fchmod(fd: number, mode: number): Promise<void>; 574 575/** 576 * fchmod. 577 * 578 * @param { number } fd - fd. 579 * @param { number } mode - mode. 580 * @param { AsyncCallback<void> } [callback] - callback. 581 * @throws { TypedError } Parameter check failed 582 * @syscap SystemCapability.FileManagement.File.FileIO 583 * @since 7 584 * @deprecated since 9 585 */ 586declare function fchmod(fd: number, mode: number, callback: AsyncCallback<void>): void; 587/** 588 * fchmodSync. 589 * 590 * @param { number } fd - fd. 591 * @param { number } mode - mode. 592 * @throws { TypedError | Error } fchmod fail 593 * @syscap SystemCapability.FileManagement.File.FileIO 594 * @since 7 595 * @deprecated since 9 596 */ 597declare function fchmodSync(fd: number, mode: number): void; 598/** 599 * fdopenStream. 600 * 601 * @param { number } fd - fd. 602 * @param { string } mode - mode. 603 * @returns { Promise<Stream> } return Promise 604 * @throws { TypedError } Parameter check failed 605 * @syscap SystemCapability.FileManagement.File.FileIO 606 * @since 7 607 * @deprecated since 9 608 * @useinstead ohos.file.fs.fdopenStream 609 */ 610declare function fdopenStream(fd: number, mode: string): Promise<Stream>; 611 612/** 613 * fdopenStream. 614 * 615 * @param { number } fd - fd. 616 * @param { string } mode - mode. 617 * @param { AsyncCallback<Stream> } [callback] - callback. 618 * @throws { TypedError } Parameter check failed 619 * @syscap SystemCapability.FileManagement.File.FileIO 620 * @since 7 621 * @deprecated since 9 622 * @useinstead ohos.file.fs.fdopenStream 623 */ 624declare function fdopenStream(fd: number, mode: string, callback: AsyncCallback<Stream>): void; 625/** 626 * fdopenStreamSync. 627 * 628 * @param { number } fd - fd. 629 * @param { string } mode - mode. 630 * @returns { Stream } open stream from fd 631 * @throws { TypedError | Error } open fail 632 * @syscap SystemCapability.FileManagement.File.FileIO 633 * @since 7 634 * @deprecated since 9 635 * @useinstead ohos.file.fs.fdopenStreamSync 636 */ 637declare function fdopenStreamSync(fd: number, mode: string): Stream; 638/** 639 * hash. 640 * 641 * @param { string } path - path. 642 * @param { string } algorithm - algorithm md5 sha1 sha256. 643 * @returns { Promise<string> } return Promise 644 * @throws { TypedError } Parameter check failed 645 * @syscap SystemCapability.FileManagement.File.FileIO 646 * @since 6 647 * @deprecated since 9 648 * @useinstead ohos.file.hash.hash 649 */ 650declare function hash(path: string, algorithm: string): Promise<string>; 651 652/** 653 * hash. 654 * 655 * @param { string } path - path. 656 * @param { string } algorithm - algorithm md5 sha1 sha256. 657 * @param { AsyncCallback<string> } [callback] - callback. 658 * @throws { TypedError } Parameter check failed 659 * @syscap SystemCapability.FileManagement.File.FileIO 660 * @since 6 661 * @deprecated since 9 662 * @useinstead ohos.file.hash.hash 663 */ 664declare function hash(path: string, algorithm: string, callback: AsyncCallback<string>): void; 665/** 666 * lchown. 667 * 668 * @param { string } path - path. 669 * @param { number } uid - uid. 670 * @param { number } gid - gid. 671 * @returns { Promise<void> } return Promise 672 * @throws { TypedError } Parameter check failed 673 * @syscap SystemCapability.FileManagement.File.FileIO 674 * @since 7 675 * @deprecated since 9 676 */ 677declare function lchown(path: string, uid: number, gid: number): Promise<void>; 678 679/** 680 * lchown. 681 * 682 * @param { string } path - path. 683 * @param { number } uid - uid. 684 * @param { number } gid - gid. 685 * @param { AsyncCallback<void> } [callback] - callback. 686 * @throws { TypedError } Parameter check failed 687 * @syscap SystemCapability.FileManagement.File.FileIO 688 * @since 7 689 * @deprecated since 9 690 */ 691declare function lchown(path: string, uid: number, gid: number, callback: AsyncCallback<void>): void; 692/** 693 * lchownSync. 694 * 695 * @param { string } path - path. 696 * @param { number } uid - uid. 697 * @param { number } gid - gid. 698 * @throws { TypedError | Error } lchown fail 699 * @syscap SystemCapability.FileManagement.File.FileIO 700 * @since 7 701 * @deprecated since 9 702 */ 703declare function lchownSync(path: string, uid: number, gid: number): void; 704/** 705 * lstat. 706 * 707 * @param { string } path - path. 708 * @returns { Promise<Stat> } return Promise 709 * @throws { TypedError } Parameter check failed 710 * @syscap SystemCapability.FileManagement.File.FileIO 711 * @since 7 712 * @deprecated since 9 713 * @useinstead ohos.file.fs.lstat 714 */ 715declare function lstat(path: string): Promise<Stat>; 716 717/** 718 * lstat. 719 * 720 * @param { string } path - path. 721 * @param { AsyncCallback<Stat> } [callback] - callback. 722 * @throws { TypedError } Parameter check failed 723 * @syscap SystemCapability.FileManagement.File.FileIO 724 * @since 7 725 * @deprecated since 9 726 * @useinstead ohos.file.fs.lstat 727 */ 728declare function lstat(path: string, callback: AsyncCallback<Stat>): void; 729/** 730 * lstatSync. 731 * 732 * @param { string } path - path. 733 * @returns { Stat } lstat success 734 * @throws { TypedError | Error } lstat fail 735 * @syscap SystemCapability.FileManagement.File.FileIO 736 * @since 7 737 * @deprecated since 9 738 * @useinstead ohos.file.fs.lstatSync 739 */ 740declare function lstatSync(path: string): Stat; 741/** 742 * mkdir. 743 * 744 * @param { string } path - path. 745 * @param { number } [mode = 0o770] - path. 746 * @returns { Promise<void> } return Promise 747 * @throws { TypedError } Parameter check failed 748 * @syscap SystemCapability.FileManagement.File.FileIO 749 * @since 6 750 * @deprecated since 9 751 * @useinstead ohos.file.fs.mkdir 752 */ 753declare function mkdir(path: string, mode?: number): Promise<void>; 754 755/** 756 * mkdir. 757 * 758 * @param { string } path - path. 759 * @param { AsyncCallback<void> } [callback] - callback. 760 * @throws { TypedError } Parameter check failed 761 * @syscap SystemCapability.FileManagement.File.FileIO 762 * @since 6 763 * @deprecated since 9 764 * @useinstead ohos.file.fs.mkdir 765 */ 766declare function mkdir(path: string, callback: AsyncCallback<void>): void; 767 768/** 769 * mkdir. 770 * 771 * @param { string } path - path. 772 * @param { number } [mode = 0o770] - path. 773 * @param { AsyncCallback<void> } [callback] - callback. 774 * @throws { TypedError } Parameter check failed 775 * @syscap SystemCapability.FileManagement.File.FileIO 776 * @since 6 777 * @deprecated since 9 778 * @useinstead ohos.file.fs.mkdir 779 */ 780declare function mkdir(path: string, mode: number, callback: AsyncCallback<void>): void; 781/** 782 * mkdirSync. 783 * 784 * @param { string } path - path. 785 * @param { number } [mode = 0o770] - path. 786 * @throws { TypedError | Error } mkdir fail 787 * @syscap SystemCapability.FileManagement.File.FileIO 788 * @since 6 789 * @deprecated since 9 790 * @useinstead ohos.file.fs.mkdirSync 791 */ 792declare function mkdirSync(path: string, mode?: number): void; 793/** 794 * mkdtemp. 795 * 796 * @param { string } prefix - dir prefix. 797 * @returns { Promise<string> } return Promise 798 * @throws { TypedError } Parameter check failed 799 * @syscap SystemCapability.FileManagement.File.FileIO 800 * @since 7 801 * @deprecated since 9 802 * @useinstead ohos.file.fs.mkdtemp 803 */ 804declare function mkdtemp(prefix: string): Promise<string>; 805 806/** 807 * mkdtemp. 808 * 809 * @param { string } prefix - dir prefix. 810 * @param { AsyncCallback<string> } [callback] - callback. 811 * @throws { TypedError } Parameter check failed 812 * @syscap SystemCapability.FileManagement.File.FileIO 813 * @since 7 814 * @deprecated since 9 815 * @useinstead ohos.file.fs.mkdtemp 816 */ 817declare function mkdtemp(prefix: string, callback: AsyncCallback<string>): void; 818/** 819 * mkdtempSync. 820 * 821 * @param { string } prefix - dir prefix. 822 * @returns { string } directory name 823 * @throws { TypedError | Error } mkdtemp fail 824 * @syscap SystemCapability.FileManagement.File.FileIO 825 * @since 7 826 * @deprecated since 9 827 * @useinstead ohos.file.fs.mkdtempSync 828 */ 829declare function mkdtempSync(prefix: string): string; 830/** 831 * open. 832 * 833 * @param { string } path - path. 834 * @param { number } [flags = 0] - flags. 835 * @param { number } [mode = 0o666] - mode. 836 * @returns { Promise<number> } return Promise 837 * @throws { TypedError } Parameter check failed 838 * @syscap SystemCapability.FileManagement.File.FileIO 839 * @since 7 840 * @deprecated since 9 841 * @useinstead ohos.file.fs.open 842 */ 843declare function open(path: string, flags?: number, mode?: number): Promise<number>; 844 845/** 846 * open. 847 * 848 * @param { string } path - path. 849 * @param { AsyncCallback<number> } [callback] - callback. 850 * @throws { TypedError } Parameter check failed 851 * @syscap SystemCapability.FileManagement.File.FileIO 852 * @since 7 853 * @deprecated since 9 854 * @useinstead ohos.file.fs.open 855 */ 856declare function open(path: string, callback: AsyncCallback<number>): void; 857 858/** 859 * open. 860 * 861 * @param { string } path - path. 862 * @param { number } [flags = 0] - flags. 863 * @param { AsyncCallback<number> } [callback] - callback. 864 * @throws { TypedError } Parameter check failed 865 * @syscap SystemCapability.FileManagement.File.FileIO 866 * @since 7 867 * @deprecated since 9 868 * @useinstead ohos.file.fs.open 869 */ 870declare function open(path: string, flags: number, callback: AsyncCallback<number>): void; 871 872/** 873 * open. 874 * 875 * @param { string } path - path. 876 * @param { number } [flags = 0] - flags. 877 * @param { number } [mode = 0o666] - mode. 878 * @param { AsyncCallback<number> } [callback] - callback. 879 * @throws { TypedError } Parameter check failed 880 * @syscap SystemCapability.FileManagement.File.FileIO 881 * @since 7 882 * @deprecated since 9 883 * @useinstead ohos.file.fs.open 884 */ 885declare function open(path: string, flags: number, mode: number, callback: AsyncCallback<number>): void; 886/** 887 * openSync. 888 * 889 * @param { string } path - path. 890 * @param { number } [flags = 0] - flags. 891 * @param { number } [mode = 0o666] - mode. 892 * @returns { number } open fd 893 * @throws { TypedError | Error } open fail 894 * @syscap SystemCapability.FileManagement.File.FileIO 895 * @since 6 896 * @deprecated since 9 897 * @useinstead ohos.file.fs.openSync 898 */ 899declare function openSync(path: string, flags?: number, mode?: number): number; 900/** 901 * opendir. 902 * 903 * @param { string } path - directory name. 904 * @returns { Promise<Dir> } return Promise 905 * @throws { TypedError } Parameter check failed 906 * @syscap SystemCapability.FileManagement.File.FileIO 907 * @since 6 908 * @deprecated since 9 909 * @useinstead ohos.file.fs.listFile 910 */ 911declare function opendir(path: string): Promise<Dir>; 912 913/** 914 * opendir. 915 * 916 * @param { string } path - directory name. 917 * @param { AsyncCallback<Dir> } [callback] - callback. 918 * @throws { TypedError } Parameter check failed 919 * @syscap SystemCapability.FileManagement.File.FileIO 920 * @since 6 921 * @deprecated since 9 922 * @useinstead ohos.file.fs.listFile 923 */ 924declare function opendir(path: string, callback: AsyncCallback<Dir>): void; 925/** 926 * opendirSync. 927 * 928 * @param { string } path - directory name. 929 * @returns { Dir } opendir Dir Object 930 * @throws { TypedError | Error } opendir fail 931 * @syscap SystemCapability.FileManagement.File.FileIO 932 * @since 6 933 * @deprecated since 9 934 * @useinstead ohos.file.fs.listFileSync 935 */ 936declare function opendirSync(path: string): Dir; 937/** 938 * readText. 939 * 940 * @param { string } filePath - file path. 941 * @param { object } [options] - options. 942 * @returns { Promise<string> } return Promise 943 * @throws { TypedError } Parameter check failed 944 * @syscap SystemCapability.FileManagement.File.FileIO 945 * @since 7 946 * @deprecated since 9 947 * @useinstead ohos.file.fs.readText 948 */ 949declare function readText( 950 filePath: string, 951 options?: { 952 position?: number; 953 length?: number; 954 encoding?: string; 955 } 956): Promise<string>; 957 958/** 959 * readText. 960 * 961 * @param { string } filePath - file path. 962 * @param { object } [options] - options. 963 * @param { AsyncCallback<string> } [callback] - callback. 964 * @throws { TypedError } Parameter check failed 965 * @syscap SystemCapability.FileManagement.File.FileIO 966 * @since 7 967 * @deprecated since 9 968 * @useinstead ohos.file.fs.readText 969 */ 970declare function readText( 971 filePath: string, 972 options: { 973 position?: number; 974 length?: number; 975 encoding?: string; 976 }, 977 callback: AsyncCallback<string> 978): void; 979 980/** 981 * readTextSync. 982 * 983 * @param { string } filePath - file path. 984 * @param { object } [options] - options. 985 * @returns { string } readout result 986 * @throws { TypedError } Parameter check failed 987 * @syscap SystemCapability.FileManagement.File.FileIO 988 * @since 7 989 * @deprecated since 9 990 * @useinstead ohos.file.fs.readTextSync 991 */ 992declare function readTextSync( 993 filePath: string, 994 options?: { 995 position?: number; 996 length?: number; 997 encoding?: string; 998 } 999): string; 1000 1001/** 1002 * read. 1003 * 1004 * @param { number } fd - file descriptor. 1005 * @param { ArrayBuffer } buffer - file descriptor. 1006 * @param { object } [options] - options. 1007 * @returns { Promise<ReadOut> } return Promise 1008 * @throws { TypedError } Parameter check failed 1009 * @syscap SystemCapability.FileManagement.File.FileIO 1010 * @since 6 1011 * @deprecated since 9 1012 * @useinstead ohos.file.fs.read 1013 */ 1014declare function read( 1015 fd: number, 1016 buffer: ArrayBuffer, 1017 options?: { 1018 offset?: number; 1019 length?: number; 1020 position?: number; 1021 } 1022): Promise<ReadOut>; 1023 1024/** 1025 * read. 1026 * 1027 * @param { number } fd - file descriptor. 1028 * @param { ArrayBuffer } buffer - file descriptor. 1029 * @param { AsyncCallback<ReadOut> } [callback] - callback. 1030 * @throws { TypedError } Parameter check failed 1031 * @syscap SystemCapability.FileManagement.File.FileIO 1032 * @since 6 1033 * @deprecated since 9 1034 * @useinstead ohos.file.fs.read 1035 */ 1036declare function read(fd: number, buffer: ArrayBuffer, callback: AsyncCallback<ReadOut>): void; 1037 1038/** 1039 * read. 1040 * 1041 * @param { number } fd - file descriptor. 1042 * @param { ArrayBuffer } buffer - file descriptor. 1043 * @param { object } [options] - options. 1044 * @param { AsyncCallback<ReadOut> } [callback] - callback. 1045 * @throws { TypedError } Parameter check failed 1046 * @syscap SystemCapability.FileManagement.File.FileIO 1047 * @since 6 1048 * @deprecated since 9 1049 * @useinstead ohos.file.fs.read 1050 */ 1051declare function read( 1052 fd: number, 1053 buffer: ArrayBuffer, 1054 options: { 1055 offset?: number; 1056 length?: number; 1057 position?: number; 1058 }, 1059 callback: AsyncCallback<ReadOut> 1060): void; 1061/** 1062 * readSync. 1063 * 1064 * @param { number } fd - file descriptor. 1065 * @param { ArrayBuffer } buffer - file descriptor. 1066 * @param { object } [options] - options. 1067 * @returns { number } number of bytesRead 1068 * @throws { TypedError | Error } read fail 1069 * @syscap SystemCapability.FileManagement.File.FileIO 1070 * @since 6 1071 * @deprecated since 9 1072 * @useinstead ohos.file.fs.readSync 1073 */ 1074declare function readSync( 1075 fd: number, 1076 buffer: ArrayBuffer, 1077 options?: { 1078 offset?: number; 1079 length?: number; 1080 position?: number; 1081 } 1082): number; 1083/** 1084 * rename. 1085 * 1086 * @param { string } oldPath - oldPath. 1087 * @param { string } newPath - newPath. 1088 * @returns { Promise<void> } return Promise 1089 * @throws { TypedError } Parameter check failed 1090 * @syscap SystemCapability.FileManagement.File.FileIO 1091 * @since 7 1092 * @deprecated since 9 1093 * @useinstead ohos.file.fs.rename 1094 */ 1095declare function rename(oldPath: string, newPath: string): Promise<void>; 1096 1097/** 1098 * rename. 1099 * 1100 * @param { string } oldPath - oldPath. 1101 * @param { string } newPath - newPath. 1102 * @param { AsyncCallback<void> } [callback] - callback. 1103 * @throws { TypedError } Parameter check failed 1104 * @syscap SystemCapability.FileManagement.File.FileIO 1105 * @since 7 1106 * @deprecated since 9 1107 * @useinstead ohos.file.fs.rename 1108 */ 1109declare function rename(oldPath: string, newPath: string, callback: AsyncCallback<void>): void; 1110/** 1111 * renameSync. 1112 * 1113 * @param { string } oldPath - oldPath. 1114 * @param { string } newPath - newPath. 1115 * @throws { TypedError | Error } rename fail 1116 * @syscap SystemCapability.FileManagement.File.FileIO 1117 * @since 7 1118 * @deprecated since 9 1119 * @useinstead ohos.file.fs.renameSync 1120 */ 1121declare function renameSync(oldPath: string, newPath: string): void; 1122/** 1123 * rmdir. 1124 * 1125 * @param { string } path - path. 1126 * @returns { Promise<void> } return Promise 1127 * @throws { TypedError } Parameter check failed 1128 * @syscap SystemCapability.FileManagement.File.FileIO 1129 * @since 7 1130 * @deprecated since 9 1131 * @useinstead ohos.file.fs.rmdir 1132 */ 1133declare function rmdir(path: string): Promise<void>; 1134 1135/** 1136 * rmdir. 1137 * 1138 * @param { string } path - path. 1139 * @param { AsyncCallback<void> } [callback] - callback. 1140 * @throws { TypedError } Parameter check failed 1141 * @syscap SystemCapability.FileManagement.File.FileIO 1142 * @since 7 1143 * @deprecated since 9 1144 * @useinstead ohos.file.fs.rmdir 1145 */ 1146declare function rmdir(path: string, callback: AsyncCallback<void>): void; 1147/** 1148 * rmdirSync. 1149 * 1150 * @param { string } path - path. 1151 * @throws { TypedError | Error } rmdir fail 1152 * @syscap SystemCapability.FileManagement.File.FileIO 1153 * @since 7 1154 * @deprecated since 9 1155 * @useinstead ohos.file.fs.rmdirSync 1156 */ 1157declare function rmdirSync(path: string): void; 1158/** 1159 * stat. 1160 * 1161 * @param { string } path - path. 1162 * @returns { Promise<Stat> } return Promise 1163 * @throws { TypedError } Parameter check failed 1164 * @syscap SystemCapability.FileManagement.File.FileIO 1165 * @since 6 1166 * @deprecated since 9 1167 * @useinstead ohos.file.fs.stat 1168 */ 1169declare function stat(path: string): Promise<Stat>; 1170 1171/** 1172 * stat. 1173 * 1174 * @param { string } path - path. 1175 * @param { AsyncCallback<Stat> } [callback] - callback. 1176 * @throws { TypedError } Parameter check failed 1177 * @syscap SystemCapability.FileManagement.File.FileIO 1178 * @since 6 1179 * @deprecated since 9 1180 * @useinstead ohos.file.fs.stat 1181 */ 1182declare function stat(path: string, callback: AsyncCallback<Stat>): void; 1183/** 1184 * statSync. 1185 * 1186 * @param { string } path - path. 1187 * @returns { Stat } stat success 1188 * @throws { TypedError | Error } stat fail 1189 * @syscap SystemCapability.FileManagement.File.FileIO 1190 * @since 6 1191 * @deprecated since 9 1192 * @useinstead ohos.file.fs.statSync 1193 */ 1194declare function statSync(path: string): Stat; 1195/** 1196 * symlink. 1197 * 1198 * @param { string } target - target. 1199 * @param { string } srcPath - srcPath. 1200 * @returns { Promise<void> } return Promise 1201 * @throws { TypedError } Parameter check failed 1202 * @syscap SystemCapability.FileManagement.File.FileIO 1203 * @since 7 1204 * @deprecated since 9 1205 * @useinstead ohos.file.fs.symlink 1206 */ 1207declare function symlink(target: string, srcPath: string): Promise<void>; 1208 1209/** 1210 * symlink. 1211 * 1212 * @param { string } target - target. 1213 * @param { string } srcPath - srcPath. 1214 * @param { AsyncCallback<void> } [callback] - callback. 1215 * @throws { TypedError } Parameter check failed 1216 * @syscap SystemCapability.FileManagement.File.FileIO 1217 * @since 7 1218 * @deprecated since 9 1219 * @useinstead ohos.file.fs.symlink 1220 */ 1221declare function symlink(target: string, srcPath: string, callback: AsyncCallback<void>): void; 1222/** 1223 * symlinkSync. 1224 * 1225 * @param { string } target - target. 1226 * @param { string } srcPath - srcPath. 1227 * @throws { TypedError | Error } symlink fail 1228 * @syscap SystemCapability.FileManagement.File.FileIO 1229 * @since 7 1230 * @deprecated since 9 1231 * @useinstead ohos.file.fs.symlinkSync 1232 */ 1233declare function symlinkSync(target: string, srcPath: string): void; 1234/** 1235 * truncate. 1236 * 1237 * @param { string } path - path. 1238 * @param { number } [len = 0] - len. 1239 * @returns { Promise<void> } return Promise 1240 * @throws { TypedError } Parameter check failed 1241 * @syscap SystemCapability.FileManagement.File.FileIO 1242 * @since 7 1243 * @deprecated since 9 1244 * @useinstead ohos.file.fs.truncate 1245 */ 1246declare function truncate(path: string, len?: number): Promise<void>; 1247 1248/** 1249 * truncate. 1250 * 1251 * @param { string } path - path. 1252 * @param { AsyncCallback<void> } [callback] - callback. 1253 * @throws { TypedError } Parameter check failed 1254 * @syscap SystemCapability.FileManagement.File.FileIO 1255 * @since 7 1256 * @deprecated since 9 1257 * @useinstead ohos.file.fs.truncate 1258 */ 1259declare function truncate(path: string, callback: AsyncCallback<void>): void; 1260 1261/** 1262 * truncate. 1263 * 1264 * @param { string } path - path. 1265 * @param { number } [len = 0] - len. 1266 * @param { AsyncCallback<void> } [callback] - callback. 1267 * @throws { TypedError } Parameter check failed 1268 * @syscap SystemCapability.FileManagement.File.FileIO 1269 * @since 7 1270 * @deprecated since 9 1271 * @useinstead ohos.file.fs.truncate 1272 */ 1273declare function truncate(path: string, len: number, callback: AsyncCallback<void>): void; 1274/** 1275 * truncateSync. 1276 * 1277 * @param { string } path - path. 1278 * @param { number } [len = 0] - len. 1279 * @throws { TypedError | Error } truncate fail 1280 * @syscap SystemCapability.FileManagement.File.FileIO 1281 * @since 7 1282 * @deprecated since 9 1283 * @useinstead ohos.file.fs.truncateSync 1284 */ 1285declare function truncateSync(path: string, len?: number): void; 1286/** 1287 * unlink. 1288 * 1289 * @param { string } path - path. 1290 * @returns { Promise<void> } return Promise 1291 * @throws { TypedError } Parameter check failed 1292 * @syscap SystemCapability.FileManagement.File.FileIO 1293 * @since 6 1294 * @deprecated since 9 1295 * @useinstead ohos.file.fs.unlink 1296 */ 1297declare function unlink(path: string): Promise<void>; 1298 1299/** 1300 * unlink. 1301 * 1302 * @param { string } path - path. 1303 * @param { AsyncCallback<void> } [callback] - callback. 1304 * @throws { TypedError } Parameter check failed 1305 * @syscap SystemCapability.FileManagement.File.FileIO 1306 * @since 6 1307 * @deprecated since 9 1308 * @useinstead ohos.file.fs.unlink 1309 */ 1310declare function unlink(path: string, callback: AsyncCallback<void>): void; 1311/** 1312 * unlinkSync. 1313 * 1314 * @param { string } path - path. 1315 * @throws { TypedError | Error } unlink fail 1316 * @syscap SystemCapability.FileManagement.File.FileIO 1317 * @since 6 1318 * @deprecated since 9 1319 * @useinstead ohos.file.fs.unlinkSync 1320 */ 1321declare function unlinkSync(path: string): void; 1322/** 1323 * write. 1324 * 1325 * @param { number } fd - file descriptor. 1326 * @param { ArrayBuffer | string } buffer - buffer or string. 1327 * @param { object } [options] - options. 1328 * @returns { Promise<number> } return Promise 1329 * @throws { TypedError } Parameter check failed 1330 * @syscap SystemCapability.FileManagement.File.FileIO 1331 * @since 6 1332 * @deprecated since 9 1333 * @useinstead ohos.file.fs.write 1334 */ 1335declare function write( 1336 fd: number, 1337 buffer: ArrayBuffer | string, 1338 options?: { 1339 offset?: number; 1340 length?: number; 1341 position?: number; 1342 encoding?: string; 1343 } 1344): Promise<number>; 1345 1346/** 1347 * write. 1348 * 1349 * @param { number } fd - file descriptor. 1350 * @param { ArrayBuffer | string } buffer - buffer or string. 1351 * @param { AsyncCallback<number> } [callback] - callback. 1352 * @throws { TypedError } Parameter check failed 1353 * @syscap SystemCapability.FileManagement.File.FileIO 1354 * @since 6 1355 * @deprecated since 9 1356 * @useinstead ohos.file.fs.write 1357 */ 1358declare function write(fd: number, buffer: ArrayBuffer | string, callback: AsyncCallback<number>): void; 1359 1360/** 1361 * write. 1362 * 1363 * @param { number } fd - file descriptor. 1364 * @param { ArrayBuffer | string } buffer - buffer or string. 1365 * @param { object } [options] - options. 1366 * @param { AsyncCallback<number> } [callback] - callback. 1367 * @throws { TypedError } Parameter check failed 1368 * @syscap SystemCapability.FileManagement.File.FileIO 1369 * @since 6 1370 * @deprecated since 9 1371 * @useinstead ohos.file.fs.write 1372 */ 1373declare function write( 1374 fd: number, 1375 buffer: ArrayBuffer | string, 1376 options: { 1377 offset?: number; 1378 length?: number; 1379 position?: number; 1380 encoding?: string; 1381 }, 1382 callback: AsyncCallback<number> 1383): void; 1384/** 1385 * writeSync. 1386 * 1387 * @param { number } fd - file descriptor. 1388 * @param { ArrayBuffer | string } buffer - buffer or string. 1389 * @param { object } [options] - options. 1390 * @returns { number } on success number of bytesRead 1391 * @throws { TypedError | Error } write fail 1392 * @syscap SystemCapability.FileManagement.File.FileIO 1393 * @since 6 1394 * @deprecated since 9 1395 * @useinstead ohos.file.fs.writeSync 1396 */ 1397declare function writeSync( 1398 fd: number, 1399 buffer: ArrayBuffer | string, 1400 options?: { 1401 offset?: number; 1402 length?: number; 1403 position?: number; 1404 encoding?: string; 1405 } 1406): number; 1407 1408/** 1409 * createWatcher. 1410 * 1411 * @param { string } filename - filename. 1412 * @param { number } events - events(depends on OS & filesystem) events = 1 rename events = 2 change. 1413 * @param { AsyncCallback<number> } [callback] - callback. 1414 * @returns { Watcher } watch success 1415 * @throws { TypedError | Error } watch fail 1416 * @syscap SystemCapability.FileManagement.File.FileIO 1417 * @since 7 1418 * @deprecated since 10 1419 * @useinstead ohos.file.fs.createWatcher 1420 */ 1421declare function createWatcher(filename: string, events: number, callback: AsyncCallback<number>): Watcher; 1422/** 1423 * Dir 1424 * 1425 * @interface Dir 1426 * @syscap SystemCapability.FileManagement.File.FileIO 1427 * @since 6 1428 * @deprecated since 9 1429 * @useinstead ohos.file.fs.listFile 1430 */ 1431declare interface Dir { 1432 /** 1433 * read. 1434 * 1435 * @returns { Promise<Dirent> } return Promise 1436 * @throws { TypedError } Parameter check failed if read to end, Error.msg = "NoMore" 1437 * @syscap SystemCapability.FileManagement.File.FileIO 1438 * @since 6 1439 * @deprecated since 9 1440 * @useinstead ohos.file.fs.listFile 1441 */ 1442 read(): Promise<Dirent>; 1443 1444 /** 1445 * read. 1446 * 1447 * @param { AsyncCallback<Dirent> } [callback] - callback. 1448 * @throws { TypedError } Parameter check failed if read to end, Error.msg = "NoMore" 1449 * @syscap SystemCapability.FileManagement.File.FileIO 1450 * @since 6 1451 * @deprecated since 9 1452 * @useinstead ohos.file.fs.listFile 1453 */ 1454 read(callback: AsyncCallback<Dirent>): void; 1455 /** 1456 * readSync. 1457 * 1458 * @returns { Dirent } Dirent Object 1459 * @throws { TypedError | Error } read fail if read to end, Error.msg = "NoMore" 1460 * @syscap SystemCapability.FileManagement.File.FileIO 1461 * @since 6 1462 * @deprecated since 9 1463 * @useinstead ohos.file.fs.listFile 1464 */ 1465 readSync(): Dirent; 1466 /** 1467 * close. 1468 * 1469 * @returns { Promise<void> } return Promise 1470 * @throws { TypedError } close fail 1471 * @syscap SystemCapability.FileManagement.File.FileIO 1472 * @since 7 1473 * @deprecated since 9 1474 * @useinstead ohos.file.fs.listFile 1475 */ 1476 close(): Promise<void>; 1477 1478 /** 1479 * close. 1480 * 1481 * @param { AsyncCallback<void> } [callback] - callback. 1482 * @throws { TypedError } close fail 1483 * @syscap SystemCapability.FileManagement.File.FileIO 1484 * @since 7 1485 * @deprecated since 9 1486 * @useinstead ohos.file.fs.listFile 1487 */ 1488 close(callback: AsyncCallback<void>): void; 1489 /** 1490 * closeSync. 1491 * 1492 * @throws { TypedError | Error } close fail 1493 * @syscap SystemCapability.FileManagement.File.FileIO 1494 * @since 6 1495 * @deprecated since 9 1496 * @useinstead ohos.file.fs.listFile 1497 */ 1498 closeSync(): void; 1499} 1500 1501/** 1502 * Dirent 1503 * 1504 * @interface Dirent 1505 * @syscap SystemCapability.FileManagement.File.FileIO 1506 * @since 6 1507 * @deprecated since 9 1508 * @useinstead ohos.file.fs.listFile 1509 */ 1510declare interface Dirent { 1511 /** 1512 * @type { string } 1513 * @readonly 1514 * @syscap SystemCapability.FileManagement.File.FileIO 1515 * @since 6 1516 * @deprecated since 9 1517 * @useinstead ohos.file.fs.listFile 1518 */ 1519 readonly name: string; 1520 /** 1521 * isBlockDevice. 1522 * 1523 * @returns { boolean } is or not 1524 * @syscap SystemCapability.FileManagement.File.FileIO 1525 * @since 6 1526 * @deprecated since 9 1527 * @useinstead ohos.file.fs.listFile 1528 */ 1529 isBlockDevice(): boolean; 1530 /** 1531 * isCharacterDevice. 1532 * 1533 * @returns { boolean } is or not 1534 * @syscap SystemCapability.FileManagement.File.FileIO 1535 * @since 6 1536 * @deprecated since 9 1537 * @useinstead ohos.file.fs.listFile 1538 */ 1539 isCharacterDevice(): boolean; 1540 /** 1541 * isDirectory. 1542 * 1543 * @returns { boolean } is or not 1544 * @syscap SystemCapability.FileManagement.File.FileIO 1545 * @since 6 1546 * @deprecated since 9 1547 * @useinstead ohos.file.fs.listFile 1548 */ 1549 isDirectory(): boolean; 1550 /** 1551 * isFIFO. 1552 * 1553 * @returns { boolean } is or not 1554 * @syscap SystemCapability.FileManagement.File.FileIO 1555 * @since 6 1556 * @deprecated since 9 1557 * @useinstead ohos.file.fs.listFile 1558 */ 1559 isFIFO(): boolean; 1560 /** 1561 * isFile. 1562 * 1563 * @returns { boolean } is or not 1564 * @syscap SystemCapability.FileManagement.File.FileIO 1565 * @since 6 1566 * @deprecated since 9 1567 * @useinstead ohos.file.fs.listFile 1568 */ 1569 isFile(): boolean; 1570 /** 1571 * isSocket. 1572 * 1573 * @returns { boolean } is or not 1574 * @syscap SystemCapability.FileManagement.File.FileIO 1575 * @since 6 1576 * @deprecated since 9 1577 * @useinstead ohos.file.fs.listFile 1578 */ 1579 isSocket(): boolean; 1580 /** 1581 * isSymbolicLink. 1582 * 1583 * @returns { boolean } is or not 1584 * @syscap SystemCapability.FileManagement.File.FileIO 1585 * @since 6 1586 * @deprecated since 9 1587 * @useinstead ohos.file.fs.listFile 1588 */ 1589 isSymbolicLink(): boolean; 1590} 1591 1592/** 1593 * Stat 1594 * 1595 * @interface Stat 1596 * @syscap SystemCapability.FileManagement.File.FileIO 1597 * @since 6 1598 * @deprecated since 9 1599 * @useinstead ohos.file.fs.Stat 1600 */ 1601declare interface Stat { 1602 /** 1603 * @type { number } 1604 * @readonly 1605 * @syscap SystemCapability.FileManagement.File.FileIO 1606 * @since 6 1607 * @deprecated since 9 1608 */ 1609 readonly dev: number; 1610 /** 1611 * @type { number } 1612 * @readonly 1613 * @syscap SystemCapability.FileManagement.File.FileIO 1614 * @since 6 1615 * @deprecated since 9 1616 * @useinstead ohos.file.fs.Stat.ino 1617 */ 1618 readonly ino: number; 1619 /** 1620 * @type { number } 1621 * @readonly 1622 * @syscap SystemCapability.FileManagement.File.FileIO 1623 * @since 6 1624 * @deprecated since 9 1625 * @useinstead ohos.file.fs.Stat.mode 1626 */ 1627 readonly mode: number; 1628 /** 1629 * @type { number } 1630 * @readonly 1631 * @syscap SystemCapability.FileManagement.File.FileIO 1632 * @since 6 1633 * @deprecated since 9 1634 */ 1635 readonly nlink: number; 1636 /** 1637 * @type { number } 1638 * @readonly 1639 * @syscap SystemCapability.FileManagement.File.FileIO 1640 * @since 6 1641 * @deprecated since 9 1642 * @useinstead ohos.file.fs.Stat.uid 1643 */ 1644 readonly uid: number; 1645 /** 1646 * @type { number } 1647 * @readonly 1648 * @syscap SystemCapability.FileManagement.File.FileIO 1649 * @since 6 1650 * @deprecated since 9 1651 * @useinstead ohos.file.fs.Stat.gid 1652 */ 1653 readonly gid: number; 1654 /** 1655 * @type { number } 1656 * @readonly 1657 * @syscap SystemCapability.FileManagement.File.FileIO 1658 * @since 6 1659 * @deprecated since 9 1660 */ 1661 readonly rdev: number; 1662 /** 1663 * @type { number } 1664 * @readonly 1665 * @syscap SystemCapability.FileManagement.File.FileIO 1666 * @since 6 1667 * @deprecated since 9 1668 * @useinstead ohos.file.fs.Stat.size 1669 */ 1670 readonly size: number; 1671 /** 1672 * @type { number } 1673 * @readonly 1674 * @syscap SystemCapability.FileManagement.File.FileIO 1675 * @since 6 1676 * @deprecated since 9 1677 */ 1678 readonly blocks: number; 1679 /** 1680 * @type { number } 1681 * @readonly 1682 * @syscap SystemCapability.FileManagement.File.FileIO 1683 * @since 6 1684 * @deprecated since 9 1685 * @useinstead ohos.file.fs.Stat.atime 1686 */ 1687 readonly atime: number; 1688 /** 1689 * @type { number } 1690 * @readonly 1691 * @syscap SystemCapability.FileManagement.File.FileIO 1692 * @since 6 1693 * @deprecated since 9 1694 * @useinstead ohos.file.fs.Stat.mtime 1695 */ 1696 readonly mtime: number; 1697 /** 1698 * @type { number } 1699 * @readonly 1700 * @syscap SystemCapability.FileManagement.File.FileIO 1701 * @since 6 1702 * @deprecated since 9 1703 * @useinstead ohos.file.fs.Stat.ctime 1704 */ 1705 readonly ctime: number; 1706 /** 1707 * isBlockDevice. 1708 * 1709 * @returns { boolean } is or not 1710 * @syscap SystemCapability.FileManagement.File.FileIO 1711 * @since 6 1712 * @deprecated since 9 1713 * @useinstead ohos.file.fs.Stat.isBlockDevice 1714 */ 1715 isBlockDevice(): boolean; 1716 /** 1717 * isCharacterDevice. 1718 * 1719 * @returns { boolean } is or not 1720 * @syscap SystemCapability.FileManagement.File.FileIO 1721 * @since 6 1722 * @deprecated since 9 1723 * @useinstead ohos.file.fs.Stat.isCharacterDevice 1724 */ 1725 isCharacterDevice(): boolean; 1726 /** 1727 * isDirectory. 1728 * 1729 * @returns { boolean } is or not 1730 * @syscap SystemCapability.FileManagement.File.FileIO 1731 * @since 6 1732 * @deprecated since 9 1733 * @useinstead ohos.file.fs.Stat.isDirectory 1734 */ 1735 isDirectory(): boolean; 1736 /** 1737 * isFIFO. 1738 * 1739 * @returns { boolean } is or not 1740 * @syscap SystemCapability.FileManagement.File.FileIO 1741 * @since 6 1742 * @deprecated since 9 1743 * @useinstead ohos.file.fs.Stat.isFIFO 1744 */ 1745 isFIFO(): boolean; 1746 /** 1747 * isFile. 1748 * 1749 * @returns { boolean } is or not 1750 * @syscap SystemCapability.FileManagement.File.FileIO 1751 * @since 6 1752 * @deprecated since 9 1753 * @useinstead ohos.file.fs.Stat.isFile 1754 */ 1755 isFile(): boolean; 1756 /** 1757 * isSocket. 1758 * 1759 * @returns { boolean } is or not 1760 * @syscap SystemCapability.FileManagement.File.FileIO 1761 * @since 6 1762 * @deprecated since 9 1763 * @useinstead ohos.file.fs.Stat.isSocket 1764 */ 1765 isSocket(): boolean; 1766 /** 1767 * isSymbolicLink. 1768 * 1769 * @returns { boolean } is or not 1770 * @syscap SystemCapability.FileManagement.File.FileIO 1771 * @since 6 1772 * @deprecated since 9 1773 * @useinstead ohos.file.fs.Stat.isSymbolicLink 1774 */ 1775 isSymbolicLink(): boolean; 1776} 1777 1778/** 1779 * Stream 1780 * 1781 * @interface Stream 1782 * @syscap SystemCapability.FileManagement.File.FileIO 1783 * @since 6 1784 * @deprecated since 9 1785 * @useinstead ohos.file.fs.Stream 1786 */ 1787declare interface Stream { 1788 /** 1789 * close. 1790 * 1791 * @returns { Promise<void> } return Promise 1792 * @throws { TypedError } close fail 1793 * @syscap SystemCapability.FileManagement.File.FileIO 1794 * @since 7 1795 * @deprecated since 9 1796 * @useinstead ohos.file.fs.Stream.close 1797 */ 1798 close(): Promise<void>; 1799 1800 /** 1801 * close. 1802 * 1803 * @param { AsyncCallback<void> } [callback] - callback. 1804 * @throws { TypedError } close fail 1805 * @syscap SystemCapability.FileManagement.File.FileIO 1806 * @since 7 1807 * @deprecated since 9 1808 * @useinstead ohos.file.fs.Stream.close 1809 */ 1810 close(callback: AsyncCallback<void>): void; 1811 /** 1812 * closeSync. 1813 * 1814 * @throws { TypedError | Error } close fail 1815 * @syscap SystemCapability.FileManagement.File.FileIO 1816 * @since 6 1817 * @deprecated since 9 1818 * @useinstead ohos.file.fs.Stream.closeSync 1819 */ 1820 closeSync(): void; 1821 /** 1822 * flush. 1823 * 1824 * @returns { Promise<void> } return Promise 1825 * @throws { TypedError } Parameter check failed 1826 * @syscap SystemCapability.FileManagement.File.FileIO 1827 * @since 7 1828 * @deprecated since 9 1829 * @useinstead ohos.file.fs.Stream.flush 1830 */ 1831 flush(): Promise<void>; 1832 1833 /** 1834 * flush. 1835 * 1836 * @param { AsyncCallback<void> } [callback] - callback. 1837 * @throws { TypedError } Parameter check failed 1838 * @syscap SystemCapability.FileManagement.File.FileIO 1839 * @since 7 1840 * @deprecated since 9 1841 * @useinstead ohos.file.fs.Stream.flush 1842 */ 1843 flush(callback: AsyncCallback<void>): void; 1844 /** 1845 * flushSync. 1846 * 1847 * @throws { TypedError | Error } flush fail 1848 * @syscap SystemCapability.FileManagement.File.FileIO 1849 * @since 7 1850 * @deprecated since 9 1851 * @useinstead ohos.file.fs.Stream.flushSync 1852 */ 1853 flushSync(): void; 1854 /** 1855 * write. 1856 * 1857 * @param { ArrayBuffer | string } buffer - buffer or string. 1858 * @param { object } [options] - options. 1859 * @returns { Promise<number> } return Promise 1860 * @throws { TypedError } Parameter check failed 1861 * @syscap SystemCapability.FileManagement.File.FileIO 1862 * @since 7 1863 * @deprecated since 9 1864 * @useinstead ohos.file.fs.Stream.write 1865 */ 1866 write( 1867 buffer: ArrayBuffer | string, 1868 options?: { 1869 offset?: number; 1870 length?: number; 1871 position?: number; 1872 encoding?: string; 1873 } 1874 ): Promise<number>; 1875 1876 /** 1877 * write. 1878 * 1879 * @param { ArrayBuffer | string } buffer - buffer or string. 1880 * @param { AsyncCallback<number> } [callback] - callback. 1881 * @throws { TypedError } Parameter check failed 1882 * @syscap SystemCapability.FileManagement.File.FileIO 1883 * @since 7 1884 * @deprecated since 9 1885 * @useinstead ohos.file.fs.Stream.write 1886 */ 1887 write(buffer: ArrayBuffer | string, callback: AsyncCallback<number>): void; 1888 1889 /** 1890 * write. 1891 * 1892 * @param { ArrayBuffer | string } buffer - buffer or string. 1893 * @param { object } [options] - options. 1894 * @param { AsyncCallback<number> } [callback] - callback. 1895 * @throws { TypedError } Parameter check failed 1896 * @syscap SystemCapability.FileManagement.File.FileIO 1897 * @since 7 1898 * @deprecated since 9 1899 * @useinstead ohos.file.fs.Stream.write 1900 */ 1901 write( 1902 buffer: ArrayBuffer | string, 1903 options: { 1904 offset?: number; 1905 length?: number; 1906 position?: number; 1907 encoding?: string; 1908 }, 1909 callback: AsyncCallback<number> 1910 ): void; 1911 /** 1912 * writeSync. 1913 * 1914 * @param { ArrayBuffer | string } buffer - buffer or string. 1915 * @param { object } [options] - options. 1916 * @returns { number } on success number of bytes written 1917 * @throws { TypedError | Error } write fail 1918 * @syscap SystemCapability.FileManagement.File.FileIO 1919 * @since 7 1920 * @deprecated since 9 1921 * @useinstead ohos.file.fs.Stream.writeSync 1922 */ 1923 writeSync( 1924 buffer: ArrayBuffer | string, 1925 options?: { 1926 offset?: number; 1927 length?: number; 1928 position?: number; 1929 encoding?: string; 1930 } 1931 ): number; 1932 /** 1933 * read. 1934 * 1935 * @param { ArrayBuffer } buffer - buffer. 1936 * @param { object } [options] - options. 1937 * @returns { Promise<ReadOut> } return Promise 1938 * @throws { TypedError } Parameter check failed 1939 * @syscap SystemCapability.FileManagement.File.FileIO 1940 * @since 7 1941 * @deprecated since 9 1942 * @useinstead ohos.file.fs.Stream.read 1943 */ 1944 read( 1945 buffer: ArrayBuffer, 1946 options?: { 1947 position?: number; 1948 offset?: number; 1949 length?: number; 1950 } 1951 ): Promise<ReadOut>; 1952 1953 /** 1954 * read. 1955 * 1956 * @param { ArrayBuffer } buffer - buffer. 1957 * @param { AsyncCallback<ReadOut> } [callback] - callback. 1958 * @throws { TypedError } Parameter check failed 1959 * @syscap SystemCapability.FileManagement.File.FileIO 1960 * @since 7 1961 * @deprecated since 9 1962 * @useinstead ohos.file.fs.Stream.read 1963 */ 1964 read(buffer: ArrayBuffer, callback: AsyncCallback<ReadOut>): void; 1965 1966 /** 1967 * read. 1968 * 1969 * @param { ArrayBuffer } buffer - buffer. 1970 * @param { object } [options] - options. 1971 * @param { AsyncCallback<ReadOut> } [callback] - callback. 1972 * @throws { TypedError } Parameter check failed 1973 * @syscap SystemCapability.FileManagement.File.FileIO 1974 * @since 7 1975 * @deprecated since 9 1976 * @useinstead ohos.file.fs.Stream.read 1977 */ 1978 read( 1979 buffer: ArrayBuffer, 1980 options: { 1981 position?: number; 1982 offset?: number; 1983 length?: number; 1984 }, 1985 callback: AsyncCallback<ReadOut> 1986 ): void; 1987 /** 1988 * readSync. 1989 * 1990 * @param { ArrayBuffer } buffer - buffer. 1991 * @param { object } [options] - options. 1992 * @returns { number } number of bytesRead 1993 * @throws { TypedError | Error } read fail 1994 * @syscap SystemCapability.FileManagement.File.FileIO 1995 * @since 7 1996 * @deprecated since 9 1997 * @useinstead ohos.file.fs.Stream.readSync 1998 */ 1999 readSync( 2000 buffer: ArrayBuffer, 2001 options?: { 2002 position?: number; 2003 offset?: number; 2004 length?: number; 2005 } 2006 ): number; 2007} 2008 2009/** 2010 * ReadOut 2011 * 2012 * @interface ReadOut 2013 * @syscap SystemCapability.FileManagement.File.FileIO 2014 * @since 6 2015 * @deprecated since 9 2016 */ 2017declare interface ReadOut { 2018 /** 2019 * @type { number } 2020 * @readonly 2021 * @syscap SystemCapability.FileManagement.File.FileIO 2022 * @since 6 2023 * @deprecated since 9 2024 */ 2025 bytesRead: number; 2026 /** 2027 * @type { number } 2028 * @readonly 2029 * @syscap SystemCapability.FileManagement.File.FileIO 2030 * @since 6 2031 * @deprecated since 9 2032 */ 2033 offset: number; 2034 /** 2035 * @type { ArrayBuffer } 2036 * @readonly 2037 * @syscap SystemCapability.FileManagement.File.FileIO 2038 * @since 6 2039 * @deprecated since 9 2040 */ 2041 buffer: ArrayBuffer; 2042} 2043 2044/** 2045 * Watcher 2046 * 2047 * @interface Watcher 2048 * @syscap SystemCapability.FileManagement.File.FileIO 2049 * @since 7 2050 * @deprecated since 10 2051 * @useinstead ohos.file.fs.Watcher 2052 */ 2053declare interface Watcher { 2054 /** 2055 * stop. 2056 * 2057 * @returns { Promise<void> } return Promise 2058 * @throws { TypedError | Error } stop fail 2059 * @syscap SystemCapability.FileManagement.File.FileIO 2060 * @since 7 2061 * @deprecated since 10 2062 * @useinstead ohos.file.fs.Watcher.stop 2063 */ 2064 stop(): Promise<void>; 2065 2066 /** 2067 * stop. 2068 * 2069 * @param { AsyncCallback<void> } [callback] - callback. 2070 * @throws { TypedError | Error } stop fail 2071 * @syscap SystemCapability.FileManagement.File.FileIO 2072 * @since 7 2073 * @deprecated since 10 2074 * @useinstead ohos.file.fs.Watcher.stop 2075 */ 2076 stop(callback: AsyncCallback<void>): void; 2077} 2078