interface.uts 42.1 KB
Newer Older
DCloud-yyl's avatar
DCloud-yyl 已提交
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23

export type ReadFileSuccessResult = {
	data : string
}

export type OpenFileSuccessResult = {
	fd : string
}


/**
 *  通用的正确返回结果
 */
export type FileManagerSuccessResult = {
	errMsg : string,
}
/**
 * 通用的正确返回结果回调
 */
export type FileManagerSuccessCallback = (res : FileManagerSuccessResult) => void
/**
 * 通用的错误返回结果回调
 */
DCloud-yyl's avatar
DCloud-yyl 已提交
24
export type FileManagerFailCallback = (res : FileSystemManagerFail) => void
DCloud-yyl's avatar
DCloud-yyl 已提交
25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41
/**
 * 通用的结束返回结果回调
 */
export type FileManagerCompleteCallback = (res : any) => void



export type ReadFileSuccessCallback = (res : ReadFileSuccessResult) => void



export type ReadFileOptions = {
	/**
	 * base64 / utf-8
	 */
	encoding : "base64" | "utf-8",
	/**
DCloud-yyl's avatar
DCloud-yyl 已提交
42
	 * 文件路径,支持相对地址和绝对地址,app-android平台支持代码包文件目录
DCloud-yyl's avatar
DCloud-yyl 已提交
43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271
	 */
	filePath : string.URIString,
	/**
	 * 接口调用的回调函数
	 */
	success ?: ReadFileSuccessCallback | null,
	/**
	 * 接口调用失败的回调函数
	 */
	fail ?: FileManagerFailCallback | null,
	/**
	 * 接口调用结束的回调函数(调用成功、失败都会执行)
	 */
	complete ?: FileManagerCompleteCallback | null
}





export type WriteFileOptions = {
	/**
	 * 文件路径,只支持绝对地址
	 */
	filePath : string.URIString,
	/**
	 * 指定写入文件的字符编码
	 * 支持:ascii base64 utf-8
	 */
	encoding : "ascii" | "base64" | "utf-8",
	/**
	 * 写入的文本内容
	 */
	data : string,
	/**
	 * 接口调用的回调函数
	 */
	success ?: FileManagerSuccessCallback | null,
	/**
	 * 接口调用失败的回调函数
	 */
	fail ?: FileManagerFailCallback | null,
	/**
	 * 接口调用结束的回调函数(调用成功、失败都会执行)
	 */
	complete ?: FileManagerCompleteCallback | null
}

export type AppendFileOptions = {
	/**
	 * 要追加内容的文件路径 (本地路径)
	 */
	filePath : string.URIString,
	/**
	 * 指定写入文件的字符编码
	 * 支持:ascii base64 utf-8
	 */
	encoding : "ascii" | "base64" | "utf-8",
	/**
	 * 要追加的文本
	 */
	data : string,
	/**
	 * 接口调用的回调函数
	 */
	success ?: FileManagerSuccessCallback | null,
	/**
	 * 接口调用失败的回调函数
	 */
	fail ?: FileManagerFailCallback | null,
	/**
	 * 接口调用结束的回调函数(调用成功、失败都会执行)
	 */
	complete ?: FileManagerCompleteCallback | null
}


export type OpenFileSuccessCallback = (res : OpenFileSuccessResult) => void

export type OpenFileOptions = {
	/**
	 * 要追加内容的文件路径 (本地路径)
	 */
	filePath : string.URIString,
	/**
	 * 文件系统标志,默认值: 'r'
	 */
	flag : "a" | "ax" | "a+" | "ax+" | "r" | "r+" | "w" | "wx" | "w+" | "wx" | "wx+",
	/**
	 * 接口调用的回调函数
	 */
	success ?: OpenFileSuccessCallback | null,
	/**
	 * 接口调用失败的回调函数
	 */
	fail ?: FileManagerFailCallback | null,
	/**
	 * 接口调用结束的回调函数(调用成功、失败都会执行)
	 */
	complete ?: FileManagerCompleteCallback | null
}

export type OpenFileSyncOptions = {
	/**
	 * 要追加内容的文件路径 (本地路径)
	 */
	filePath : string.URIString,
	/**
	 * 文件系统标志,默认值: 'r'
	 */
	flag : "a" | "ax" | "a+" | "ax+" | "r" | "r+" | "w" | "wx" | "w+" | "wx" | "wx+",
}




export type UnLinkSuccessCallback = (res : FileManagerSuccessResult) => void



export type UnLinkOptions = {
	/**
	 * 文件路径,只支持绝对地址
	 */
	filePath : string.URIString,
	/**
	 * 接口调用的回调函数
	 */
	success ?: UnLinkSuccessCallback | null,
	/**
	 * 接口调用失败的回调函数
	 */
	fail ?: FileManagerFailCallback | null,
	/**
	 * 接口调用结束的回调函数(调用成功、失败都会执行)
	 */
	complete ?: FileManagerCompleteCallback | null
}

export type MkDirSuccessCallback = (res : FileManagerSuccessResult) => void




export type MkDirOptions = {
	/**
	 * 创建的目录路径 (本地路径)
	 */
	dirPath : string.URIString,
	/**
	 *是否在递归创建该目录的上级目录后再创建该目录。如果对应的上级目录已经存在,则不创建该上级目录。如 dirPath 为 a/b/c/d 且 recursive 为 true,将创建 a 目录,再在 a 目录下创建 b 目录,以此类推直至创建 a/b/c 目录下的 d 目录。
	 */
	recursive : boolean,
	/**
	 * 接口调用的回调函数
	 */
	success ?: MkDirSuccessCallback | null,
	/**
	 * 接口调用失败的回调函数
	 */
	fail ?: FileManagerFailCallback | null,
	/**
	 * 接口调用结束的回调函数(调用成功、失败都会执行)
	 */
	complete ?: FileManagerCompleteCallback | null
}


export type RmDirSuccessCallback = (res : FileManagerSuccessResult) => void




export type RmDirOptions = {
	/**
	 * 要删除的目录路径 (本地路径)
	 */
	dirPath : string.URIString,
	/**
	 *是否递归删除目录。如果为 true,则删除该目录和该目录下的所有子目录以及文件。
	 */
	recursive : boolean,
	/**
	 * 接口调用的回调函数
	 */
	success ?: MkDirSuccessCallback | null,
	/**
	 * 接口调用失败的回调函数
	 */
	fail ?: FileManagerFailCallback | null,
	/**
	 * 接口调用结束的回调函数(调用成功、失败都会执行)
	 */
	complete ?: FileManagerCompleteCallback | null
}


export type ReadDirSuccessResult = {
	files : string[],
}

export type ReadDirSuccessCallback = (res : ReadDirSuccessResult) => void


export type ReadDirOptions = {
	/**
	 * 要读取的目录路径 (本地路径)
	 */
	dirPath : string.URIString,

	/**
	 * 接口调用的回调函数
	 */
	success ?: ReadDirSuccessCallback | null,
	/**
	 * 接口调用失败的回调函数
	 */
	fail ?: FileManagerFailCallback | null,
	/**
	 * 接口调用结束的回调函数(调用成功、失败都会执行)
	 */
	complete ?: FileManagerCompleteCallback | null
}




export type AccessOptions = {
	/**
DCloud-yyl's avatar
DCloud-yyl 已提交
272
	 * 要判断是否存在的文件/目录路径 (本地路径)
DCloud-yyl's avatar
DCloud-yyl 已提交
273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555
	 */
	path : string.URIString,

	/**
	 * 接口调用的回调函数
	 */
	success ?: FileManagerSuccessCallback | null,
	/**
	 * 接口调用失败的回调函数
	 */
	fail ?: FileManagerFailCallback | null,
	/**
	 * 接口调用结束的回调函数(调用成功、失败都会执行)
	 */
	complete ?: FileManagerCompleteCallback | null
}

export type RenameOptions = {
	/**
	 * 源文件路径,支持本地路径
	 */
	oldPath : string.URIString,
	/**
	 * 新文件路径,支持本地路径
	 */
	newPath : string.URIString,

	/**
	 * 接口调用的回调函数
	 */
	success ?: FileManagerSuccessCallback | null,
	/**
	 * 接口调用失败的回调函数
	 */
	fail ?: FileManagerFailCallback | null,
	/**
	 * 接口调用结束的回调函数(调用成功、失败都会执行)
	 */
	complete ?: FileManagerCompleteCallback | null
}

export type CopyFileOptions = {
	/**
	 * 源文件路径,支持本地路径
	 */
	srcPath : string.URIString,
	/**
	 * 新文件路径,支持本地路径
	 */
	destPath : string.URIString,

	/**
	 * 接口调用的回调函数
	 */
	success ?: FileManagerSuccessCallback | null,
	/**
	 * 接口调用失败的回调函数
	 */
	fail ?: FileManagerFailCallback | null,
	/**
	 * 接口调用结束的回调函数(调用成功、失败都会执行)
	 */
	complete ?: FileManagerCompleteCallback | null
}

export type SaveFileOptions = {
	/**
	 * 临时存储文件路径 (本地路径)
	 */
	tempFilePath : string.URIString,
	/**
	 * 要存储的文件路径 (本地路径)
	 */
	filePath : string.URIString | null,

	/**
	 * 接口调用的回调函数
	 */
	success ?: SaveFileSuccessCallback | null,
	/**
	 * 接口调用失败的回调函数
	 */
	fail ?: FileManagerFailCallback | null,
	/**
	 * 接口调用结束的回调函数(调用成功、失败都会执行)
	 */
	complete ?: FileManagerCompleteCallback | null
}


export type SaveFileSuccessCallback = (res : SaveFileSuccessResult) => void

export type SaveFileSuccessResult = {
	/**
	 * 存储后的文件路径 (本地路径)
	 */
	savedFilePath : string,
}

export type GetFileInfoSuccessResult = {
	digest : string,
	size : number,
	errMsg : string
}

export type GetFileInfoSuccessCallback = (res : GetFileInfoSuccessResult) => void

export type GetFileInfoOptions = {
	/**
	 * 要读取的文件路径 (本地路径)
	 */
	filePath : string.URIString,
	/**
	 * md5 / sha1
	 */
	digestAlgorithm : "md5" | "sha1" | null,
	/**
	 * 接口调用的回调函数
	 */
	success ?: GetFileInfoSuccessCallback | null,
	/**
	 * 接口调用失败的回调函数
	 */
	fail ?: FileManagerFailCallback | null,
	/**
	 * 接口调用结束的回调函数(调用成功、失败都会执行)
	 */
	complete ?: FileManagerCompleteCallback | null
}


export interface Stats {
	/**
	 * 文件的类型和存取的权限,对应 POSIX stat.st_mode
	 * 注意android中,文件类型只包含是否是目录与文件,
	 * 另外在android中这里的权限指的是当前进程对文件或者文件夹是否有读,写,执行的权限,
	 * 这里没有与 POSIX stat.st_mode对应的组,其他人等相关权限的数据返回,只有所有者的相关权限
	 */
	mode : number;
	/**
	 * 文件大小,单位:B,对应 POSIX stat.st_size
	 */
	size : number;
	/**
	 * 文件最近一次被存取或被执行的时间,UNIX 时间戳,对应 POSIX stat.st_atime
	 * 注意:android中由于系统限制无法获取该数据
	 */
	lastAccessedTime : number;
	/**
	 * 文件最后一次被修改的时间,UNIX 时间戳,对应 POSIX stat.st_mtime
	 */
	lastModifiedTime : number;
	/**
	 * @internal
	 */
	mIsFile : boolean;
	/**
	 * 判断当前文件是否一个目录
	 */
	isDirectory() : boolean;
	/**
	 * 判断当前文件是否一个普通文件
	 */
	isFile() : boolean;
}


export type FileStats = {
	path : string,
	stats : Stats,
}

export type StatSuccessResult = {
	errMsg : string,
	stats : FileStats[]
}


export type StatSuccessCallback = (res : StatSuccessResult) => void


export type StatOptions = {
	/**
	 * 文件/目录路径 (本地路径)
	 */
	path : string.URIString,
	/**
	 * 是否递归获取目录下的每个文件的 Stats 信息
	 */
	recursive : boolean,
	/**
	 * 接口调用的回调函数
	 */
	success ?: StatSuccessCallback | null,
	/**
	 * 接口调用失败的回调函数
	 */
	fail ?: FileManagerFailCallback | null,
	/**
	 * 接口调用结束的回调函数(调用成功、失败都会执行)
	 */
	complete ?: FileManagerCompleteCallback | null
}


export type UnzipFileOptions = {
	/**
	 * 源文件路径,支持本地路径, 只可以是 zip 压缩文件
	 */
	zipFilePath : string,
	/**
	 * 目标目录路径, 支持本地路径
	 */
	targetPath : string,
	/**
	 * 接口调用的回调函数
	 */
	success ?: FileManagerSuccessCallback | null,
	/**
	 * 接口调用失败的回调函数
	 */
	fail ?: FileManagerFailCallback | null,
	/**
	 * 接口调用结束的回调函数(调用成功、失败都会执行)
	 */
	complete ?: FileManagerCompleteCallback | null
}

export type GetSavedFileListResult = {
	fileList : string[]
}

export type GetSavedFileListCallback = (res : GetSavedFileListResult) => void

export type GetSavedFileListOptions = {
	/**
	 * 接口调用的回调函数
	 */
	success ?: GetSavedFileListCallback | null,
	/**
	 * 接口调用失败的回调函数
	 */
	fail ?: FileManagerFailCallback | null,
	/**
	 * 接口调用结束的回调函数(调用成功、失败都会执行)
	 */
	complete ?: FileManagerCompleteCallback | null
}



export type TruncateFileOptions = {
	/**
	 * 要截断的文件路径 (本地路径)
	 */
	filePath : string.URIString,
	/**
	 * 截断位置,默认0。如果 length 小于文件长度(字节),则只有前面 length 个字节会保留在文件中,其余内容会被删除;
	 * 如果 length 大于文件长度,不做处理
	 */
	length : number,
	/**
	 * 接口调用的回调函数
	 */
	success ?: FileManagerSuccessCallback | null,
	/**
	 * 接口调用失败的回调函数
	 */
	fail ?: FileManagerFailCallback | null,
	/**
	 * 接口调用结束的回调函数(调用成功、失败都会执行)
	 */
	complete ?: FileManagerCompleteCallback | null
}


export type ReadCompressedFileResult = {
	data : string
}

export type ReadCompressedFileCallback = (res : ReadCompressedFileResult) => void
export type ReadCompressedFileOptions = {
	/**
DCloud-yyl's avatar
DCloud-yyl 已提交
556
	 * 要读取的文件的路径 (本地用户文件或代码包文件),app-android平台支持代码包文件目录
DCloud-yyl's avatar
DCloud-yyl 已提交
557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 735 736 737 738 739 740 741 742 743 744 745 746 747 748 749 750 751 752 753 754 755 756 757 758 759 760 761 762 763 764 765 766 767 768 769 770 771 772 773 774 775 776 777 778 779 780 781
	 */
	filePath : string.URIString,
	/**
	 * 文件压缩类型,目前仅支持 'br'。
	 */
	compressionAlgorithm : "br",
	/**
	 * 接口调用的回调函数
	 */
	success ?: ReadCompressedFileCallback | null,
	/**
	 * 接口调用失败的回调函数
	 */
	fail ?: FileManagerFailCallback | null,
	/**
	 * 接口调用结束的回调函数(调用成功、失败都会执行)
	 */
	complete ?: FileManagerCompleteCallback | null
}


export type RemoveSavedFileOptions = {
	/**
	 * 需要删除的文件路径 (本地路径)
	 */
	filePath : string.URIString,
	/**
	 * 接口调用的回调函数
	 */
	success ?: FileManagerSuccessCallback | null,
	/**
	 * 接口调用失败的回调函数
	 */
	fail ?: FileManagerFailCallback | null,
	/**
	 * 接口调用结束的回调函数(调用成功、失败都会执行)
	 */
	complete ?: FileManagerCompleteCallback | null
}



export type WriteResult = {
	/**
	 * 实际被写入到文件中的字节数(注意,被写入的字节数不一定与被写入的字符串字符数相同)
	 */
	bytesWritten : number
}

export type WriteCallback = (res : WriteResult) => void
export type WriteOptions = {
	/**
	 * 文件描述符。fd 通过 FileSystemManager.open 或 FileSystemManager.openSync 接口获得
	 */
	fd : string,
	/**
	 * 写入的内容
	 */
	data : string,
	/**
	 * 指定写入文件的字符编码
	 * 支持:ascii base64 utf-8
	 */
	encoding : "ascii" | "base64" | "utf-8",
	// /**
	//  * 指定文件开头的偏移量,即数据要被写入的位置。当 position 不传或者传入非 Number 类型的值时,数据会被写入当前指针所在位置。
	//  */
	// position : number | null,

	/**
	 * 接口调用的回调函数
	 */
	success ?: WriteCallback | null,
	/**
	 * 接口调用失败的回调函数
	 */
	fail ?: FileManagerFailCallback | null,
	/**
	 * 接口调用结束的回调函数(调用成功、失败都会执行)
	 */
	complete ?: FileManagerCompleteCallback | null
}
export type WriteSyncOptions = {
	/**
	 * 文件描述符。fd 通过 FileSystemManager.open 或 FileSystemManager.openSync 接口获得
	 */
	fd : string,
	/**
	 * 写入的内容
	 */
	data : string,
	/**
	 * 指定写入文件的字符编码
	 * 支持:ascii base64 utf-8
	 */
	encoding : "ascii" | "base64" | "utf-8",
}

export type CloseOptions = {
	/**
	 * 需要被关闭的文件描述符。fd 通过 FileSystemManager.open 或 FileSystemManager.openSync 接口获得
	 */
	fd : string,
	/**
	 * 接口调用的回调函数
	 */
	success ?: FileManagerSuccessCallback | null,
	/**
	 * 接口调用失败的回调函数
	 */
	fail ?: FileManagerFailCallback | null,
	/**
	 * 接口调用结束的回调函数(调用成功、失败都会执行)
	 */
	complete ?: FileManagerCompleteCallback | null
}

export type CloseSyncOptions = {
	/**
	 * 需要被关闭的文件描述符。fd 通过 FileSystemManager.open 或 FileSystemManager.openSync 接口获得
	 */
	fd : string,
}


export type FStatSuccessResult = {
	/**
	 * Stats 对象,包含了文件的状态信息
	 */
	stats : Stats
}


export type FStatSuccessCallback = (res : FStatSuccessResult) => void


export type FStatOptions = {
	/**
	 * 文件描述符。fd 通过 FileSystemManager.open 或 FileSystemManager.openSync 接口获得
	 */
	fd : string,
	/**
	 * 接口调用的回调函数
	 */
	success ?: FStatSuccessCallback | null,
	/**
	 * 接口调用失败的回调函数
	 */
	fail ?: FileManagerFailCallback | null,
	/**
	 * 接口调用结束的回调函数(调用成功、失败都会执行)
	 */
	complete ?: FileManagerCompleteCallback | null
}

export type FStatSyncOptions = {
	/**
	 * 文件描述符。fd 通过 FileSystemManager.open 或 FileSystemManager.openSync 接口获得
	 */
	fd : string
}

export type FTruncateFileOptions = {
	/**
	 * 文件描述符。fd 通过 FileSystemManager.open 或 FileSystemManager.openSync 接口获得
	 */
	fd : string,
	/**
	 * 截断位置,默认0。如果 length 小于文件长度(字节),则只有前面 length 个字节会保留在文件中,其余内容会被删除;
	 * 如果 length 大于文件长度,不做处理
	 */
	length : number,
	/**
	 * 接口调用的回调函数
	 */
	success ?: FileManagerSuccessCallback | null,
	/**
	 * 接口调用失败的回调函数
	 */
	fail ?: FileManagerFailCallback | null,
	/**
	 * 接口调用结束的回调函数(调用成功、失败都会执行)
	 */
	complete ?: FileManagerCompleteCallback | null
}

export type FTruncateFileSyncOptions = {
	/**
	 * 文件描述符。fd 通过 FileSystemManager.open 或 FileSystemManager.openSync 接口获得
	 */
	fd : string,
	/**
	 * 截断位置,默认0。如果 length 小于文件长度(字节),则只有前面 length 个字节会保留在文件中,其余内容会被删除;
	 * 如果 length 大于文件长度,不做处理
	 */
	length : number,
}


export type EntryItem = {
	/** 压缩包内文件路径 */
	path : string
	/**
	 * 指定写入文件的字符编码
	 * 支持:ascii base64 utf-8
	 */
	encoding : "ascii" | "base64" | "base64",
	// /** 指定文件的长度,如果不指定,则读到文件末尾。有效范围:[1, fileLength]。单位:byte */
	// length ?: number
	// /** 从文件指定位置开始读,如果不指定,则从文件头开始读。读取的范围应该是左闭右开区间 [position, position+length)。有效范围:[0, fileLength - 1]。单位:byte */
	// position ?: number
}
export type EntriesResult = {
	/** 文件路径 */
	result : Map<string, ZipFileItem>
}
export type ZipFileItem = {
	/** 文件内容 */
	data ?: string | null,
	/** 错误信息 */
	errMsg : string
}
export type ReadZipEntryCallback = (res : EntriesResult) => void
export type ReadZipEntryOptions = {
	/**
DCloud-yyl's avatar
DCloud-yyl 已提交
782
	 * 要读取的压缩包的路径 (本地路径),app-android平台支持代码包文件目录
DCloud-yyl's avatar
DCloud-yyl 已提交
783 784 785 786 787 788 789 790 791 792 793 794 795 796 797 798 799 800 801 802 803 804 805 806 807 808 809 810 811 812 813 814 815 816 817 818 819 820 821 822 823 824 825 826 827 828 829 830 831
	 */
	filePath : string.URIString,
	/**
	*统一指定读取文件的字符编码,只在 entries 值为"all"时有效。
	*如果 entries 值为"all"且不传 encoding,则以 string 格式读取文件的内容
	 */
	encoding : "ascii" | "base64" | "utf-8",
	/** 要读取的压缩包内的文件列表(当不传入时表示读取压缩包内所有文件) */
	entries ?: EntryItem[] | null,
	/**
	 * 接口调用的回调函数
	 */
	success ?: ReadZipEntryCallback | null,
	/**
	 * 接口调用失败的回调函数
	 */
	fail ?: FileManagerFailCallback | null,
	/**
	 * 接口调用结束的回调函数(调用成功、失败都会执行)
	 */
	complete ?: FileManagerCompleteCallback | null
}


export interface FileSystemManager {
	/**
	 * 读取本地文件内容
	 * @uniPlatform {
	 *    "app": {
	 *        "android": {
	 *            "osVer": "5.0",
	 *            "uniVer": "x",
	 *            "unixVer": "3.9.0"
	 *        },
	 *        "ios": {
	 *            "osVer": "12.0",
	 *            "uniVer": "x",
	 *            "unixVer": "4.11"
	 *   	  }
	 *    },
	 *  "web": {
	 *    "uniVer": "x",
	 *    "unixVer": "x"
	 *  }
	 * }
	 */
	readFile(options : ReadFileOptions) : void;
	/**
	 * FileSystemManager.readFile 的同步版本参数
DCloud-yyl's avatar
DCloud-yyl 已提交
832 833
	 * @param filePath 文件路径,支持相对地址和绝对地址,app-android平台支持代码包文件目录
	 * @param encoding base64 / utf-8
DCloud-yyl's avatar
DCloud-yyl 已提交
834 835 836 837 838 839 840 841 842 843 844 845 846 847 848 849 850 851 852 853 854 855 856 857 858 859 860 861 862 863 864 865 866 867 868 869 870 871 872 873 874 875 876 877
	 * @uniPlatform {
	 *    "app": {
	 *        "android": {
	 *            "osVer": "5.0",
	 *            "uniVer": "x",
	 *            "unixVer": "4.13"
	 *        },
	 *        "ios": {
	 *            "osVer": "12.0",
	 *            "uniVer": "x",
	 *            "unixVer": "x"
	 *   	  }
	 *    },
	 *  "web": {
	 *    "uniVer": "x",
	 *    "unixVer": "x"
	 *  }
	 * }
	 */
	readFileSync(filePath : string, encoding : string | null) : string;
	/**
	 * 写文件
	 * @uniPlatform {
	 *    "app": {
	 *        "android": {
	 *            "osVer": "5.0",
	 *            "uniVer": "x",
	 *            "unixVer": "3.9.0"
	 *        },
	 *        "ios": {
	 *            "osVer": "12.0",
	 *            "uniVer": "x",
	 *            "unixVer": "4.11"
	 *   	  }
	 *    },
	 *  "web": {
	 *    "uniVer": "x",
	 *    "unixVer": "x"
	 *  }
	 * }
	 */
	writeFile(options : WriteFileOptions) : void;
	/**
	 * FileSystemManager.writeFile 的同步版本
DCloud-yyl's avatar
DCloud-yyl 已提交
878 879 880
	 * @param filePath 文件路径,只支持绝对地址
	 * @param data 写入的文本内容
	 * @param encoding 指定写入文件的字符编码,支持:ascii base64 utf-8
DCloud-yyl's avatar
DCloud-yyl 已提交
881 882 883 884 885 886 887 888 889 890 891 892 893 894 895 896 897 898 899 900 901 902 903 904 905 906 907 908 909 910 911 912 913 914 915 916 917 918 919 920 921 922 923 924
	 * @uniPlatform {
	 *    "app": {
	 *        "android": {
	 *            "osVer": "5.0",
	 *            "uniVer": "x",
	 *            "unixVer": "4.13"
	 *        },
	 *        "ios": {
	 *            "osVer": "12.0",
	 *            "uniVer": "x",
	 *            "unixVer": "x"
	 *   	  }
	 *    },
	 *  "web": {
	 *    "uniVer": "x",
	 *    "unixVer": "x"
	 *  }
	 * }
	 */
	writeFileSync(filePath : string, data : string, encoding : string) : void;
	/**
	 * 删除文件
	 * @uniPlatform {
	 *    "app": {
	 *        "android": {
	 *            "osVer": "5.0",
	 *            "uniVer": "x",
	 *            "unixVer": "3.9.0"
	 *        },
	 *        "ios": {
	 *            "osVer": "12.0",
	 *            "uniVer": "x",
	 *            "unixVer": "4.11"
	 *   	  }
	 *    },
	 *  "web": {
	 *    "uniVer": "x",
	 *    "unixVer": "x"
	 *  }
	 * }
	 */
	unlink(options : UnLinkOptions) : void;
	/**
	 * FileSystemManager.unlink 的同步版本
DCloud-yyl's avatar
DCloud-yyl 已提交
925
	 * @param filePath 文件路径,只支持绝对地址
DCloud-yyl's avatar
DCloud-yyl 已提交
926 927 928 929 930 931 932 933 934 935 936 937 938 939 940 941 942 943 944 945 946 947 948 949 950 951 952 953 954 955 956 957 958 959 960 961 962 963 964 965 966 967 968 969
	 * @uniPlatform {
	 *    "app": {
	 *        "android": {
	 *            "osVer": "5.0",
	 *            "uniVer": "x",
	 *            "unixVer": "4.13"
	 *        },
	 *        "ios": {
	 *            "osVer": "12.0",
	 *            "uniVer": "x",
	 *            "unixVer": "x"
	 *   	  }
	 *    },
	 *  "web": {
	 *    "uniVer": "x",
	 *    "unixVer": "x"
	 *  }
	 * }
	 */
	unlinkSync(filePath : string) : void;
	/**
	 * 创建目录
	 * @uniPlatform {
	 *    "app": {
	 *        "android": {
	 *            "osVer": "5.0",
	 *            "uniVer": "x",
	 *            "unixVer": "3.9.0"
	 *        },
	 *        "ios": {
	 *            "osVer": "12.0",
	 *            "uniVer": "x",
	 *            "unixVer": "4.11"
	 *   	  }
	 *    },
	 *  "web": {
	 *    "uniVer": "x",
	 *    "unixVer": "x"
	 *  }
	 * }
	 */
	mkdir(options : MkDirOptions) : void;
	/**
	 * FileSystemManager.mkdir 的同步版本
DCloud-yyl's avatar
DCloud-yyl 已提交
970 971
	 * @param dirPath 创建的目录路径 (本地路径)
	 * @param recursive 是否在递归创建该目录的上级目录后再创建该目录。如果对应的上级目录已经存在,则不创建该上级目录。如 dirPath 为 a/b/c/d 且 recursive 为 true,将创建 a 目录,再在 a 目录下创建 b 目录,以此类推直至创建 a/b/c 目录下的 d 目录。
DCloud-yyl's avatar
DCloud-yyl 已提交
972 973 974 975 976 977 978 979 980 981 982 983 984 985 986 987 988 989 990 991 992 993 994 995 996 997 998 999 1000 1001 1002 1003 1004 1005 1006 1007 1008 1009 1010 1011 1012 1013 1014 1015
	 * @uniPlatform {
	 *    "app": {
	 *        "android": {
	 *            "osVer": "5.0",
	 *            "uniVer": "x",
	 *            "unixVer": "4.13"
	 *        },
	 *        "ios": {
	 *            "osVer": "12.0",
	 *            "uniVer": "x",
	 *            "unixVer": "x"
	 *   	  }
	 *    },
	 *  "web": {
	 *    "uniVer": "x",
	 *    "unixVer": "x"
	 *  }
	 * }
	 */
	mkdirSync(dirPath : string, recursive : boolean) : void;
	/**
	 * 删除目录
	 * @uniPlatform {
	 *    "app": {
	 *        "android": {
	 *            "osVer": "5.0",
	 *            "uniVer": "x",
	 *            "unixVer": "3.9.0"
	 *        },
	 *        "ios": {
	 *            "osVer": "12.0",
	 *            "uniVer": "x",
	 *            "unixVer": "4.11"
	 *   	  }
	 *    },
	 *  "web": {
	 *    "uniVer": "x",
	 *    "unixVer": "x"
	 *  }
	 * }
	 */
	rmdir(options : RmDirOptions) : void;
	/**
	 * FileSystemManager.rmdir 的同步版本
DCloud-yyl's avatar
DCloud-yyl 已提交
1016 1017
	 * @param dirPath 要删除的目录路径 (本地路径)
	 * @param recursive 是否递归删除目录。如果为 true,则删除该目录和该目录下的所有子目录以及文件。
DCloud-yyl's avatar
DCloud-yyl 已提交
1018 1019 1020 1021 1022 1023 1024 1025 1026 1027 1028 1029 1030 1031 1032 1033 1034 1035 1036 1037 1038 1039 1040 1041 1042 1043 1044 1045 1046 1047 1048 1049 1050 1051 1052 1053 1054 1055 1056 1057 1058 1059 1060 1061
	 * @uniPlatform {
	 *    "app": {
	 *        "android": {
	 *            "osVer": "5.0",
	 *            "uniVer": "x",
	 *            "unixVer": "4.13"
	 *        },
	 *        "ios": {
	 *            "osVer": "12.0",
	 *            "uniVer": "x",
	 *            "unixVer": "x"
	 *   	  }
	 *    },
	 *  "web": {
	 *    "uniVer": "x",
	 *    "unixVer": "x"
	 *  }
	 * }
	 */
	rmdirSync(dirPath : string, recursive : boolean) : void;
	/**
	 * 读取目录内文件列表
	 * @uniPlatform {
	 *    "app": {
	 *        "android": {
	 *            "osVer": "5.0",
	 *            "uniVer": "x",
	 *            "unixVer": "3.9.0"
	 *        },
	 *        "ios": {
	 *            "osVer": "12.0",
	 *            "uniVer": "x",
	 *            "unixVer": "4.11"
	 *   	  }
	 *    },
	 *  "web": {
	 *    "uniVer": "x",
	 *    "unixVer": "x"
	 *  }
	 * }
	 */
	readdir(options : ReadDirOptions) : void;
	/**
	 * FileSystemManager.readdir 的同步版本
DCloud-yyl's avatar
DCloud-yyl 已提交
1062
	 * @param dirPath 要读取的目录路径 (本地路径)
DCloud-yyl's avatar
DCloud-yyl 已提交
1063 1064 1065 1066 1067 1068 1069 1070 1071 1072 1073 1074 1075 1076 1077 1078 1079 1080 1081 1082 1083 1084 1085 1086 1087 1088 1089 1090 1091 1092 1093 1094 1095 1096 1097 1098 1099 1100 1101 1102 1103 1104 1105 1106
	 * @uniPlatform {
	 *    "app": {
	 *        "android": {
	 *            "osVer": "5.0",
	 *            "uniVer": "x",
	 *            "unixVer": "4.13"
	 *        },
	 *        "ios": {
	 *            "osVer": "12.0",
	 *            "uniVer": "x",
	 *            "unixVer": "x"
	 *   	  }
	 *    },
	 *  "web": {
	 *    "uniVer": "x",
	 *    "unixVer": "x"
	 *  }
	 * }
	 */
	readdirSync(dirPath : string) : string[] | null;
	/**
	 * 判断文件/目录是否存在
	 * @uniPlatform {
	 *    "app": {
	 *        "android": {
	 *            "osVer": "5.0",
	 *            "uniVer": "x",
	 *            "unixVer": "3.9.0"
	 *        },
	 *        "ios": {
	 *            "osVer": "12.0",
	 *            "uniVer": "x",
	 *            "unixVer": "4.11"
	 *   	  }
	 *    },
	 *  "web": {
	 *    "uniVer": "x",
	 *    "unixVer": "x"
	 *  }
	 * }
	 */
	access(options : AccessOptions) : void;
	/**
	 * FileSystemManager.access 的同步版本
DCloud-yyl's avatar
DCloud-yyl 已提交
1107
	 * @param path 要判断是否存在的文件/目录路径 (本地路径)
DCloud-yyl's avatar
DCloud-yyl 已提交
1108 1109 1110 1111 1112 1113 1114 1115 1116 1117 1118 1119 1120 1121 1122 1123 1124 1125 1126 1127 1128 1129 1130 1131 1132 1133 1134 1135 1136 1137 1138 1139 1140 1141 1142 1143 1144 1145 1146 1147 1148 1149 1150 1151
	 * @uniPlatform {
	 *    "app": {
	 *        "android": {
	 *            "osVer": "5.0",
	 *            "uniVer": "x",
	 *            "unixVer": "4.13"
	 *        },
	 *        "ios": {
	 *            "osVer": "12.0",
	 *            "uniVer": "x",
	 *            "unixVer": "x"
	 *   	  }
	 *    },
	 *  "web": {
	 *    "uniVer": "x",
	 *    "unixVer": "x"
	 *  }
	 * }
	 */
	accessSync(path : string) : void;
	/**
	 * 重命名文件。可以把文件从 oldPath 移动到 newPath
	 * @uniPlatform {
	 *    "app": {
	 *        "android": {
	 *            "osVer": "5.0",
	 *            "uniVer": "x",
	 *            "unixVer": "3.9.0"
	 *        },
	 *        "ios": {
	 *            "osVer": "12.0",
	 *            "uniVer": "x",
	 *            "unixVer": "4.11"
	 *   	  }
	 *    },
	 *  "web": {
	 *    "uniVer": "x",
	 *    "unixVer": "x"
	 *  }
	 * }
	 */
	rename(options : RenameOptions) : void;
	/**
	 * FileSystemManager.rename 的同步版本
DCloud-yyl's avatar
DCloud-yyl 已提交
1152 1153
	 * @param oldPath 源文件路径,支持本地路径
	 * @param newPath 新文件路径,支持本地路径
DCloud-yyl's avatar
DCloud-yyl 已提交
1154 1155 1156 1157 1158 1159 1160 1161 1162 1163 1164 1165 1166 1167 1168 1169 1170 1171 1172 1173 1174 1175 1176 1177 1178 1179 1180 1181 1182 1183 1184 1185 1186 1187 1188 1189 1190 1191 1192 1193 1194 1195 1196 1197
	 * @uniPlatform {
	 *    "app": {
	 *        "android": {
	 *            "osVer": "5.0",
	 *            "uniVer": "x",
	 *            "unixVer": "4.13"
	 *        },
	 *        "ios": {
	 *            "osVer": "12.0",
	 *            "uniVer": "x",
	 *            "unixVer": "x"
	 *   	  }
	 *    },
	 *  "web": {
	 *    "uniVer": "x",
	 *    "unixVer": "x"
	 *  }
	 * }
	 */
	renameSync(oldPath : string, newPath : string) : void;
	/**
	 * 复制文件
	 * @uniPlatform {
	 *    "app": {
	 *        "android": {
	 *            "osVer": "5.0",
	 *            "uniVer": "x",
	 *            "unixVer": "3.9.0"
	 *        },
	 *        "ios": {
	 *            "osVer": "12.0",
	 *            "uniVer": "x",
	 *            "unixVer": "4.11"
	 *   	  }
	 *    },
	 *  "web": {
	 *    "uniVer": "x",
	 *    "unixVer": "x"
	 *  }
	 * }
	 */
	copyFile(options : CopyFileOptions) : void;
	/**
	 * FileSystemManager.copyFile 的同步版本
DCloud-yyl's avatar
DCloud-yyl 已提交
1198 1199
	 * @param srcPath 源文件路径,支持本地路径
	 * @param destPath 新文件路径,支持本地路径
DCloud-yyl's avatar
DCloud-yyl 已提交
1200 1201 1202 1203 1204 1205 1206 1207 1208 1209 1210 1211 1212 1213 1214 1215 1216 1217 1218 1219 1220 1221 1222 1223 1224 1225 1226 1227 1228 1229 1230 1231 1232 1233 1234 1235 1236 1237 1238 1239 1240 1241 1242 1243 1244 1245 1246 1247 1248 1249 1250 1251 1252 1253 1254 1255 1256 1257 1258 1259 1260 1261 1262 1263 1264 1265
	 * @uniPlatform {
	 *    "app": {
	 *        "android": {
	 *            "osVer": "5.0",
	 *            "uniVer": "x",
	 *            "unixVer": "4.13"
	 *        },
	 *        "ios": {
	 *            "osVer": "12.0",
	 *            "uniVer": "x",
	 *            "unixVer": "x"
	 *   	  }
	 *    },
	 *  "web": {
	 *    "uniVer": "x",
	 *    "unixVer": "x"
	 *  }
	 * }
	 */
	copyFileSync(srcPath : string, destPath : string) : void;
	/**
	 * 获取该本地临时文件 或 本地缓存文件 信息
	 * @uniPlatform {
	 *    "app": {
	 *        "android": {
	 *            "osVer": "5.0",
	 *            "uniVer": "x",
	 *            "unixVer": "3.9.0"
	 *        },
	 *        "ios": {
	 *            "osVer": "12.0",
	 *            "uniVer": "x",
	 *            "unixVer": "4.11"
	 *   	  }
	 *    },
	 *  "web": {
	 *    "uniVer": "x",
	 *    "unixVer": "x"
	 *  }
	 * }
	 */
	getFileInfo(options : GetFileInfoOptions) : void;
	/**
	 * 获取文件 Stats 对象
	 * @uniPlatform {
	 *    "app": {
	 *        "android": {
	 *            "osVer": "5.0",
	 *            "uniVer": "x",
	 *            "unixVer": "3.9.0"
	 *        },
	 *        "ios": {
	 *            "osVer": "12.0",
	 *            "uniVer": "x",
	 *            "unixVer": "4.11"
	 *   	  }
	 *    },
	 *  "web": {
	 *    "uniVer": "x",
	 *    "unixVer": "x"
	 *  }
	 * }
	 */
	stat(options : StatOptions) : void;
	/**
	 * FileSystemManager.stat 的同步版本
DCloud-yyl's avatar
DCloud-yyl 已提交
1266 1267
	 * @param path 文件/目录路径 (本地路径)
	 * @param recursive 是否递归获取目录下的每个文件的 Stats 信息
DCloud-yyl's avatar
DCloud-yyl 已提交
1268 1269 1270 1271 1272 1273 1274 1275 1276 1277 1278 1279 1280 1281 1282 1283 1284 1285 1286 1287 1288 1289 1290 1291 1292 1293 1294 1295 1296 1297 1298 1299 1300 1301 1302 1303 1304 1305 1306 1307 1308 1309 1310 1311
	 * @uniPlatform {
	 *    "app": {
	 *        "android": {
	 *            "osVer": "5.0",
	 *            "uniVer": "x",
	 *            "unixVer": "4.13"
	 *        },
	 *        "ios": {
	 *            "osVer": "12.0",
	 *            "uniVer": "x",
	 *            "unixVer": "x"
	 *   	  }
	 *    },
	 *  "web": {
	 *    "uniVer": "x",
	 *    "unixVer": "x"
	 *  }
	 * }
	 */
	statSync(path : string, recursive : boolean) : FileStats[];
	/**
	 * 在文件结尾追加内容
	 * @uniPlatform {
	 *    "app": {
	 *        "android": {
	 *            "osVer": "5.0",
	 *            "uniVer": "x",
	 *            "unixVer": "4.13"
	 *        },
	 *        "ios": {
	 *            "osVer": "12.0",
	 *            "uniVer": "x",
	 *            "unixVer": "x"
	 *   	  }
	 *    },
	 *  "web": {
	 *    "uniVer": "x",
	 *    "unixVer": "x"
	 *  }
	 * }
	 */
	appendFile(options : AppendFileOptions) : void;
	/**
	 * FileSystemManager.appendFile 的同步版本
DCloud-yyl's avatar
DCloud-yyl 已提交
1312 1313 1314
	 * @param filePath 要追加内容的文件路径 (本地路径)
	 * @param data 要追加的文本
	 * @param encoding 指定写入文件的字符编码支持:ascii base64 utf-8
DCloud-yyl's avatar
DCloud-yyl 已提交
1315 1316 1317 1318 1319 1320 1321 1322 1323 1324 1325 1326 1327 1328 1329 1330 1331 1332 1333 1334 1335 1336 1337 1338 1339 1340 1341 1342 1343 1344 1345 1346 1347 1348 1349 1350 1351 1352 1353 1354 1355 1356 1357 1358
	 * @uniPlatform {
	 *    "app": {
	 *        "android": {
	 *            "osVer": "5.0",
	 *            "uniVer": "x",
	 *            "unixVer": "4.13"
	 *        },
	 *        "ios": {
	 *            "osVer": "12.0",
	 *            "uniVer": "x",
	 *            "unixVer": "x"
	 *   	  }
	 *    },
	 *  "web": {
	 *    "uniVer": "x",
	 *    "unixVer": "x"
	 *  }
	 * }
	 */
	appendFileSync(filePath : string, data : string, encoding : string) : void;
	/**
	 * 保存临时文件到本地。此接口会移动临时文件,因此调用成功后,tempFilePath 将不可用。
	 * @uniPlatform {
	 *    "app": {
	 *        "android": {
	 *            "osVer": "5.0",
	 *            "uniVer": "x",
	 *            "unixVer": "4.13"
	 *        },
	 *        "ios": {
	 *            "osVer": "12.0",
	 *            "uniVer": "x",
	 *            "unixVer": "x"
	 *   	  }
	 *    },
	 *  "web": {
	 *    "uniVer": "x",
	 *    "unixVer": "x"
	 *  }
	 * }
	 */
	saveFile(options : SaveFileOptions) : void;
	/**
	 * FileSystemManager.saveFile 的同步版本
DCloud-yyl's avatar
DCloud-yyl 已提交
1359 1360
	 * @param tempFilePath 临时存储文件路径 (本地路径)
	 * @param filePath 要存储的文件路径 (本地路径)
DCloud-yyl's avatar
DCloud-yyl 已提交
1361 1362 1363 1364 1365 1366 1367 1368 1369 1370 1371 1372 1373 1374 1375 1376 1377 1378 1379 1380 1381 1382 1383 1384 1385 1386 1387 1388 1389 1390 1391 1392 1393 1394 1395 1396 1397 1398 1399 1400 1401 1402 1403 1404 1405 1406 1407 1408 1409 1410 1411 1412 1413 1414 1415 1416 1417 1418 1419 1420 1421 1422 1423 1424 1425 1426 1427 1428 1429 1430 1431 1432 1433 1434 1435 1436 1437 1438 1439 1440 1441 1442 1443 1444 1445 1446 1447 1448 1449 1450 1451 1452 1453 1454 1455 1456 1457 1458 1459 1460 1461 1462 1463 1464 1465 1466 1467 1468 1469 1470
	 * @uniPlatform {
	 *    "app": {
	 *        "android": {
	 *            "osVer": "5.0",
	 *            "uniVer": "x",
	 *            "unixVer": "4.13"
	 *        },
	 *        "ios": {
	 *            "osVer": "12.0",
	 *            "uniVer": "x",
	 *            "unixVer": "x"
	 *   	  }
	 *    },
	 *  "web": {
	 *    "uniVer": "x",
	 *    "unixVer": "x"
	 *  }
	 * }
	 */
	saveFileSync(tempFilePath : string, filePath : string | null) : string;
	/**
	 * 删除该小程序下已保存的本地缓存文件
	 * @uniPlatform {
	 *    "app": {
	 *        "android": {
	 *            "osVer": "5.0",
	 *            "uniVer": "x",
	 *            "unixVer": "4.13"
	 *        },
	 *        "ios": {
	 *            "osVer": "12.0",
	 *            "uniVer": "x",
	 *            "unixVer": "x"
	 *   	  }
	 *    },
	 *  "web": {
	 *    "uniVer": "x",
	 *    "unixVer": "x"
	 *  }
	 * }
	 */
	removeSavedFile(options : RemoveSavedFileOptions) : void;
	/**
	 * 解压文件
	 * @uniPlatform {
	 *    "app": {
	 *        "android": {
	 *            "osVer": "5.0",
	 *            "uniVer": "x",
	 *            "unixVer": "4.13"
	 *        },
	 *        "ios": {
	 *            "osVer": "12.0",
	 *            "uniVer": "x",
	 *            "unixVer": "x"
	 *   	  }
	 *    },
	 *  "web": {
	 *    "uniVer": "x",
	 *    "unixVer": "x"
	 *  }
	 * }
	 */
	unzip(options : UnzipFileOptions) : void;
	/**
	 * 获取该已保存的本地缓存文件列表
	 * @uniPlatform {
	 *    "app": {
	 *        "android": {
	 *            "osVer": "5.0",
	 *            "uniVer": "x",
	 *            "unixVer": "4.13"
	 *        },
	 *        "ios": {
	 *            "osVer": "12.0",
	 *            "uniVer": "x",
	 *            "unixVer": "x"
	 *   	  }
	 *    },
	 *  "web": {
	 *    "uniVer": "x",
	 *    "unixVer": "x"
	 *  }
	 * }
	 */
	getSavedFileList(options : GetSavedFileListOptions) : void;
	/**
	 * 对文件内容进行截断操作
	 * @uniPlatform {
	 *    "app": {
	 *        "android": {
	 *            "osVer": "5.0",
	 *            "uniVer": "x",
	 *            "unixVer": "4.13"
	 *        },
	 *        "ios": {
	 *            "osVer": "12.0",
	 *            "uniVer": "x",
	 *            "unixVer": "x"
	 *   	  }
	 *    },
	 *  "web": {
	 *    "uniVer": "x",
	 *    "unixVer": "x"
	 *  }
	 * }
	 */
	truncate(options : TruncateFileOptions) : void;
	/**
	 * 对文件内容进行截断操作 (truncate 的同步版本)
DCloud-yyl's avatar
DCloud-yyl 已提交
1471 1472
	 * @param filePath 要截断的文件路径 (本地路径)
	 * @param length 截断位置,默认0。如果 length 小于文件长度(字节),则只有前面 length 个字节会保留在文件中,其余内容会被删除;如果 length 大于文件长度,不做处理
DCloud-yyl's avatar
DCloud-yyl 已提交
1473 1474 1475 1476 1477 1478 1479 1480 1481 1482 1483 1484 1485 1486 1487 1488 1489 1490 1491 1492 1493 1494 1495 1496 1497 1498 1499 1500 1501 1502 1503 1504 1505 1506 1507 1508 1509 1510 1511 1512 1513 1514 1515 1516
	 * @uniPlatform {
	 *    "app": {
	 *        "android": {
	 *            "osVer": "5.0",
	 *            "uniVer": "x",
	 *            "unixVer": "4.13"
	 *        },
	 *        "ios": {
	 *            "osVer": "12.0",
	 *            "uniVer": "x",
	 *            "unixVer": "x"
	 *   	  }
	 *    },
	 *  "web": {
	 *    "uniVer": "x",
	 *    "unixVer": "x"
	 *  }
	 * }
	 */
	truncateSync(filePath : string, length ?: number) : void;
	/**
	 * 读取指定压缩类型的本地文件内容
	 * @uniPlatform {
	 *    "app": {
	 *        "android": {
	 *            "osVer": "5.0",
	 *            "uniVer": "x",
	 *            "unixVer": "4.13"
	 *        },
	 *        "ios": {
	 *            "osVer": "12.0",
	 *            "uniVer": "x",
	 *            "unixVer": "x"
	 *   	  }
	 *    },
	 *  "web": {
	 *    "uniVer": "x",
	 *    "unixVer": "x"
	 *  }
	 * }
	 */
	readCompressedFile(options : ReadCompressedFileOptions) : void;
	/**
	 * 同步读取指定压缩类型的本地文件内容
DCloud-yyl's avatar
DCloud-yyl 已提交
1517 1518
	 * @param filePath 要读取的文件的路径 (本地用户文件或代码包文件),app-android平台支持代码包文件目录
	 * @param compressionAlgorithm 文件压缩类型,目前仅支持 'br'。
DCloud-yyl's avatar
DCloud-yyl 已提交
1519 1520 1521 1522 1523 1524 1525 1526 1527 1528 1529 1530 1531 1532 1533 1534 1535 1536 1537 1538 1539 1540 1541 1542 1543 1544 1545 1546 1547 1548 1549 1550 1551 1552 1553 1554 1555 1556 1557 1558 1559 1560 1561 1562 1563 1564 1565 1566 1567 1568 1569 1570 1571 1572 1573 1574 1575 1576 1577 1578 1579 1580 1581 1582 1583 1584 1585 1586 1587 1588 1589 1590 1591 1592 1593 1594 1595 1596 1597 1598 1599 1600 1601 1602 1603 1604 1605 1606 1607 1608 1609 1610 1611 1612 1613 1614 1615 1616 1617 1618 1619 1620 1621 1622 1623 1624 1625 1626 1627 1628 1629 1630 1631 1632 1633 1634 1635 1636 1637 1638 1639 1640 1641 1642 1643 1644 1645 1646 1647
	 * @uniPlatform {
	 *    "app": {
	 *        "android": {
	 *            "osVer": "5.0",
	 *            "uniVer": "x",
	 *            "unixVer": "4.13"
	 *        },
	 *        "ios": {
	 *            "osVer": "12.0",
	 *            "uniVer": "x",
	 *            "unixVer": "x"
	 *   	  }
	 *    },
	 *  "web": {
	 *    "uniVer": "x",
	 *    "unixVer": "x"
	 *  }
	 * }
	 */
	readCompressedFileSync(filePath : string, compressionAlgorithm : string) : string
	/**
	 * 打开文件,返回文件描述符
	 * @uniPlatform {
	 *    "app": {
	 *        "android": {
	 *            "osVer": "5.0",
	 *            "uniVer": "x",
	 *            "unixVer": "4.13"
	 *        },
	 *        "ios": {
	 *            "osVer": "12.0",
	 *            "uniVer": "x",
	 *            "unixVer": "x"
	 *   	  }
	 *    },
	 *  "web": {
	 *    "uniVer": "x",
	 *    "unixVer": "x"
	 *  }
	 * }
	 */
	open(options : OpenFileOptions) : void;
	/**
	 * 同步打开文件,返回文件描述符
	 * @uniPlatform {
	 *    "app": {
	 *        "android": {
	 *            "osVer": "5.0",
	 *            "uniVer": "x",
	 *            "unixVer": "4.13"
	 *        },
	 *        "ios": {
	 *            "osVer": "12.0",
	 *            "uniVer": "x",
	 *            "unixVer": "x"
	 *   	  }
	 *    },
	 *  "web": {
	 *    "uniVer": "x",
	 *    "unixVer": "x"
	 *  }
	 * }
	 */
	openSync(options : OpenFileSyncOptions) : string;
	/**
	 * 写入文件
	 * @uniPlatform {
	 *    "app": {
	 *        "android": {
	 *            "osVer": "5.0",
	 *            "uniVer": "x",
	 *            "unixVer": "4.13"
	 *        },
	 *        "ios": {
	 *            "osVer": "12.0",
	 *            "uniVer": "x",
	 *            "unixVer": "x"
	 *   	  }
	 *    },
	 *  "web": {
	 *    "uniVer": "x",
	 *    "unixVer": "x"
	 *  }
	 * }
	 */
	write(options : WriteOptions) : void;
	/**
	 * 同步写入文件
	 * @uniPlatform {
	 *    "app": {
	 *        "android": {
	 *            "osVer": "5.0",
	 *            "uniVer": "x",
	 *            "unixVer": "4.13"
	 *        },
	 *        "ios": {
	 *            "osVer": "12.0",
	 *            "uniVer": "x",
	 *            "unixVer": "x"
	 *   	  }
	 *    },
	 *  "web": {
	 *    "uniVer": "x",
	 *    "unixVer": "x"
	 *  }
	 * }
	 */
	writeSync(options : WriteSyncOptions) : WriteResult;
	/**
	 * 关闭文件
	 * @uniPlatform {
	 *    "app": {
	 *        "android": {
	 *            "osVer": "5.0",
	 *            "uniVer": "x",
	 *            "unixVer": "4.13"
	 *        },
	 *        "ios": {
	 *            "osVer": "12.0",
	 *            "uniVer": "x",
	 *            "unixVer": "x"
	 *   	  }
	 *    },
	 *  "web": {
	 *    "uniVer": "x",
	 *    "unixVer": "x"
	 *  }
	 * }
	 */
DCloud-yyl's avatar
DCloud-yyl 已提交
1648
	close(options : CloseOptions) : void;
DCloud-yyl's avatar
DCloud-yyl 已提交
1649 1650 1651 1652 1653 1654 1655 1656 1657 1658 1659 1660 1661 1662 1663 1664 1665 1666 1667 1668 1669 1670 1671 1672 1673 1674 1675 1676 1677 1678 1679 1680 1681 1682 1683 1684 1685 1686 1687 1688 1689 1690 1691 1692 1693 1694 1695 1696 1697 1698 1699 1700 1701 1702 1703 1704 1705 1706 1707 1708 1709 1710 1711 1712 1713 1714 1715 1716 1717 1718 1719 1720 1721 1722 1723 1724 1725 1726 1727 1728 1729 1730 1731 1732 1733 1734 1735 1736 1737 1738 1739 1740 1741 1742 1743 1744 1745 1746 1747 1748 1749 1750 1751 1752 1753 1754 1755 1756 1757 1758 1759 1760 1761 1762 1763 1764 1765 1766 1767 1768 1769 1770 1771 1772 1773 1774 1775 1776 1777 1778 1779 1780 1781 1782 1783 1784 1785 1786 1787 1788 1789 1790 1791 1792 1793 1794 1795 1796 1797 1798 1799 1800 1801 1802 1803 1804 1805 1806 1807 1808 1809 1810
	/**
	 * 同步关闭文件
	 * @uniPlatform {
	 *    "app": {
	 *        "android": {
	 *            "osVer": "5.0",
	 *            "uniVer": "x",
	 *            "unixVer": "4.13"
	 *        },
	 *        "ios": {
	 *            "osVer": "12.0",
	 *            "uniVer": "x",
	 *            "unixVer": "x"
	 *   	  }
	 *    },
	 *  "web": {
	 *    "uniVer": "x",
	 *    "unixVer": "x"
	 *  }
	 * }
	 */
	closeSync(options : CloseSyncOptions) : void;
	/**
	 * 获取文件的状态信息
	 * @uniPlatform {
	 *    "app": {
	 *        "android": {
	 *            "osVer": "5.0",
	 *            "uniVer": "x",
	 *            "unixVer": "4.13"
	 *        },
	 *        "ios": {
	 *            "osVer": "12.0",
	 *            "uniVer": "x",
	 *            "unixVer": "x"
	 *   	  }
	 *    },
	 *  "web": {
	 *    "uniVer": "x",
	 *    "unixVer": "x"
	 *  }
	 * }
	 */
	fstat(options : FStatOptions) : void;
	/**
	 * 同步获取文件的状态信息
	 * @uniPlatform {
	 *    "app": {
	 *        "android": {
	 *            "osVer": "5.0",
	 *            "uniVer": "x",
	 *            "unixVer": "4.13"
	 *        },
	 *        "ios": {
	 *            "osVer": "12.0",
	 *            "uniVer": "x",
	 *            "unixVer": "x"
	 *   	  }
	 *    },
	 *  "web": {
	 *    "uniVer": "x",
	 *    "unixVer": "x"
	 *  }
	 * }
	 */
	fstatSync(options : FStatSyncOptions) : Stats;
	/**
	 * 对文件内容进行截断操作
	 * @uniPlatform {
	 *    "app": {
	 *        "android": {
	 *            "osVer": "5.0",
	 *            "uniVer": "x",
	 *            "unixVer": "4.13"
	 *        },
	 *        "ios": {
	 *            "osVer": "12.0",
	 *            "uniVer": "x",
	 *            "unixVer": "x"
	 *   	  }
	 *    },
	 *  "web": {
	 *    "uniVer": "x",
	 *    "unixVer": "x"
	 *  }
	 * }
	 */
	ftruncate(options : FTruncateFileOptions) : void;
	/**
	 * 同步对文件内容进行截断操作
	 * @uniPlatform {
	 *    "app": {
	 *        "android": {
	 *            "osVer": "5.0",
	 *            "uniVer": "x",
	 *            "unixVer": "4.13"
	 *        },
	 *        "ios": {
	 *            "osVer": "12.0",
	 *            "uniVer": "x",
	 *            "unixVer": "x"
	 *   	  }
	 *    },
	 *  "web": {
	 *    "uniVer": "x",
	 *    "unixVer": "x"
	 *  }
	 * }
	 */
	ftruncateSync(options : FTruncateFileSyncOptions) : void;
	/**
	 * 读取压缩包内的文件
	 * @uniPlatform {
	 *    "app": {
	 *        "android": {
	 *            "osVer": "5.0",
	 *            "uniVer": "x",
	 *            "unixVer": "4.13"
	 *        },
	 *        "ios": {
	 *            "osVer": "12.0",
	 *            "uniVer": "x",
	 *            "unixVer": "x"
	 *   	  }
	 *    },
	 *  "web": {
	 *    "uniVer": "x",
	 *    "unixVer": "x"
	 *  }
	 * }
	 */
	readZipEntry(options : ReadZipEntryOptions) : void;
}


export type GetFileSystemManager = () => FileSystemManager;


export interface Uni {
	/**
	 * 获取文件管理器
	 * @uniPlatform {
	 *    "app": {
	 *        "android": {
	 *            "osVer": "5.0",
	 *            "uniVer": "x",
	 *            "unixVer": "3.9.0"
	 *        },
	 *        "ios": {
	 *            "osVer": "12.0",
	 *            "uniVer": "x",
	 *            "unixVer": "4.11"
	 *   	  }
	 *    },
	 *  "web": {
	 *    "uniVer": "x",
	 *    "unixVer": "x"
	 *  }
	 * }
	 * @uniVueVersion 2,3  //支持的vue版本
	 */
	getFileSystemManager() : FileSystemManager
DCloud-yyl's avatar
DCloud-yyl 已提交
1811 1812 1813 1814 1815 1816 1817 1818 1819 1820 1821 1822 1823 1824 1825 1826 1827 1828 1829 1830 1831 1832 1833
}

/**
 * 错误码
 * - 1200002  类型错误。仅支持 base64 / utf-8
 * - 1300002  未找到文件
 * - 1300013  无权限
 * - 1300021  是目录
 * - 1300022  参数无效
 * - 1300066  目录非空
 * - 1301003  对目录的非法操作
 * - 1301005  文件已存在
 * - 1300201  系统错误
 * - 1300202  超出文件存储限制的最大尺寸
 * - 1301111  brotli解压失败
 * - 1302003  标志无效
 * - 1300009  文件描述符错误
 */
export type FileSystemManagerErrorCode = 1200002 | 1300002 | 1300013 | 1300021 | 1300022 | 1300066 | 1301003 | 1301005 | 1300201 | 1300202 | 1301111 | 1302003 | 1300009;
export type FileSystemManagerFail = IFileSystemManagerFail;
export interface IFileSystemManagerFail extends IUniError {
	errCode : FileSystemManagerErrorCode
};