@dcloudio/uni-app-x 0.7.39 → 0.7.41

package/types/uni/uts-plugin-api/lib/uni-fileSystemManager/utssdk/interface.d.ts

@@ -1,7 +1,7 @@
 
 export type ReadFileSuccessResult = {
     /**
-     * 读取的内容，类型为 String 或 ArrayBuffer，在4.31以前类型是string，4.31起为了同时支持arraybuffer，类型改成了any，请在使用时手动as为指定类型
+     * 读取的内容，类型为 String 或 ArrayBuffer(iOS平台仅支持String)，在4.31以前类型是string，4.31起为了同时支持arraybuffer，类型改成了any，请在使用时手动as为指定类型
      * @uniPlatform {
      *    "app": {
      *        "android": {
@@ -12,7 +12,7 @@ export type ReadFileSuccessResult = {
      *        "ios": {
      *            "osVer": "12.0",
      *            "uniVer": "x",
-     *            "unixVer": "x"
+     *            "unixVer": "4.11"
      *        },
      *    "harmony": {
      *      "osVer": "x",
@@ -73,6 +73,7 @@ export type ReadFileSuccessResult = {
 
 export type OpenFileSuccessResult = {
     fd: string
+    errMsg?: string
 }
 
 
@@ -103,9 +104,9 @@ export type ReadFileSuccessCallback = (res: ReadFileSuccessResult) => void
 
 export type ReadFileOptions = {
     /**
-     * base64 / utf-8,指定读取文件的字符编码，4.31及以后版本Android平台如果不传 encoding，则以 ArrayBuffer 格式读取文件的二进制内容
+     * base64 / utf-8 / ascii,指定读取文件的字符编码，4.31及以后版本Android平台如果不传 encoding，则以 ArrayBuffer 格式读取文件的二进制内容
      */
-    encoding?: "base64" | "utf-8",
+    encoding?: "base64" | "utf-8" | "ascii",
     /**
      * 文件路径，支持相对地址和绝对地址，app-android平台支持代码包文件目录
      */
@@ -139,7 +140,7 @@ export type WriteFileOptions = {
      */
     encoding?: "ascii" | "base64" | "utf-8",
     /**
-     * 写入的内容，类型为 String 或 ArrayBuffer，在4.31以前类型是string，4.31起为了同时支持arraybuffer，类型改成了any
+     * 写入的内容，类型为 String 或 ArrayBuffer(iOS平台仅支持String)， 在4.31以前类型是string，4.31起为了同时支持arraybuffer，类型改成了any
      * @uniPlatform {
      *    "app": {
      *        "android": {
@@ -150,7 +151,7 @@ export type WriteFileOptions = {
      *        "ios": {
      *            "osVer": "12.0",
      *            "uniVer": "x",
-     *            "unixVer": "x"
+     *            "unixVer": "4.11"
      *        },
      *    "harmony": {
      *      "osVer": "x",
@@ -437,6 +438,7 @@ export type RmDirOptions = {
 
 export type ReadDirSuccessResult = {
     files: string[],
+    errMsg?: string
 }
 
 export type ReadDirSuccessCallback = (res: ReadDirSuccessResult) => void
@@ -627,11 +629,11 @@ export interface Stats {
     /**
      * 判断当前文件是否一个目录
      */
-    isDirectory(): boolean;
+    isDirectory: () => boolean;
     /**
      * 判断当前文件是否一个普通文件
      */
-    isFile(): boolean;
+    isFile: () => boolean;
 }
 
 
@@ -1509,7 +1511,12 @@ export type EntryItem = {
 }
 export type EntriesResult = {
     /** 文件路径 */
+    entries: Map<string, ZipFileItem>,
+    /**
+     * @deprecated 已废弃，使用 entries
+     */
     result: Map<string, ZipFileItem>
+    errMsg?: string
 }
 export type ZipFileItem = {
     /** string/ArrayBuffer	文件内容，4.31及以后版本支持ArrayBuffer */
@@ -1834,7 +1841,12 @@ export interface FileSystemManager {
      *            "osVer": "12.0",
      *            "uniVer": "x",
      *            "unixVer": "4.11"
-     *   	  }
+     *   	  },
+     *        "harmony": {
+     *          "osVer": "3.0",
+     *          "uniVer": "4.51",
+     *          "unixVer": "x"
+     *        }
      *    },
      *  "mp": {
      *    "weixin": {
@@ -1901,7 +1913,12 @@ export interface FileSystemManager {
      *            "osVer": "12.0",
      *            "uniVer": "x",
      *            "unixVer": "x"
-     *   	  }
+     *   	  },
+     *        "harmony": {
+     *          "osVer": "3.0",
+     *          "uniVer": "4.51",
+     *          "unixVer": "x"
+     *        }
      *    },
      *  "mp": {
      *    "weixin": {
@@ -2035,7 +2052,12 @@ export interface FileSystemManager {
      *            "osVer": "12.0",
      *            "uniVer": "x",
      *            "unixVer": "x"
-     *   	  }
+     *   	  },
+     *        "harmony": {
+     *          "osVer": "3.0",
+     *          "uniVer": "4.51",
+     *          "unixVer": "x"
+     *        }
      *    },
      *  "mp": {
      *    "weixin": {
@@ -2099,7 +2121,12 @@ export interface FileSystemManager {
      *            "osVer": "12.0",
      *            "uniVer": "x",
      *            "unixVer": "x"
-     *   	  }
+     *   	  },
+     *        "harmony": {
+     *          "osVer": "3.0",
+     *          "uniVer": "4.51",
+     *          "unixVer": "x"
+     *        }
      *    },
      *  "mp": {
      *    "weixin": {
@@ -2235,7 +2262,12 @@ export interface FileSystemManager {
      *            "osVer": "12.0",
      *            "uniVer": "x",
      *            "unixVer": "4.11"
-     *   	  }
+     *   	  },
+     *        "harmony": {
+     *          "osVer": "3.0",
+     *          "uniVer": "4.51",
+     *          "unixVer": "x"
+     *        }
      *    },
      *  "mp": {
      *    "weixin": {
@@ -2300,7 +2332,12 @@ export interface FileSystemManager {
      *            "osVer": "12.0",
      *            "uniVer": "x",
      *            "unixVer": "x"
-     *   	  }
+     *   	  },
+     *        "harmony": {
+     *          "osVer": "3.0",
+     *          "uniVer": "4.51",
+     *          "unixVer": "x"
+     *        }
      *    },
      *  "mp": {
      *    "weixin": {
@@ -2504,7 +2541,12 @@ export interface FileSystemManager {
      *            "osVer": "12.0",
      *            "uniVer": "x",
      *            "unixVer": "4.11"
-     *   	  }
+     *   	  },
+     *        "harmony": {
+     *          "osVer": "3.0",
+     *          "uniVer": "4.51",
+     *          "unixVer": "x"
+     *        }
      *    },
      *  "mp": {
      *    "weixin": {
@@ -2570,7 +2612,12 @@ export interface FileSystemManager {
      *            "osVer": "12.0",
      *            "uniVer": "x",
      *            "unixVer": "x"
-     *   	  }
+     *   	  },
+     *        "harmony": {
+     *          "osVer": "3.0",
+     *          "uniVer": "4.51",
+     *          "unixVer": "x"
+     *        }
      *    },
      *  "mp": {
      *    "weixin": {
@@ -2634,7 +2681,12 @@ export interface FileSystemManager {
      *            "osVer": "12.0",
      *            "uniVer": "x",
      *            "unixVer": "4.11"
-     *   	  }
+     *   	  },
+     *        "harmony": {
+     *          "osVer": "3.0",
+     *          "uniVer": "4.51",
+     *          "unixVer": "x"
+     *        }
      *    },
      *  "mp": {
      *    "weixin": {
@@ -2699,7 +2751,12 @@ export interface FileSystemManager {
      *            "osVer": "12.0",
      *            "uniVer": "x",
      *            "unixVer": "x"
-     *   	  }
+     *   	  },
+     *        "harmony": {
+     *          "osVer": "3.0",
+     *          "uniVer": "4.51",
+     *          "unixVer": "x"
+     *        }
      *    },
      *  "mp": {
      *    "weixin": {
@@ -2763,7 +2820,12 @@ export interface FileSystemManager {
      *            "osVer": "12.0",
      *            "uniVer": "x",
      *            "unixVer": "4.11"
-     *   	  }
+     *   	  },
+     *        "harmony": {
+     *          "osVer": "3.0",
+     *          "uniVer": "4.51",
+     *          "unixVer": "x"
+     *        }
      *    },
      *  "mp": {
      *    "weixin": {
@@ -2828,7 +2890,12 @@ export interface FileSystemManager {
      *            "osVer": "12.0",
      *            "uniVer": "x",
      *            "unixVer": "x"
-     *   	  }
+     *   	  },
+     *        "harmony": {
+     *          "osVer": "3.0",
+     *          "uniVer": "4.51",
+     *          "unixVer": "x"
+     *        }
      *    },
      *  "mp": {
      *    "weixin": {
@@ -2892,7 +2959,12 @@ export interface FileSystemManager {
      *            "osVer": "12.0",
      *            "uniVer": "x",
      *            "unixVer": "4.11"
-     *   	  }
+     *   	  },
+     *        "harmony": {
+     *          "osVer": "3.0",
+     *          "uniVer": "4.51",
+     *          "unixVer": "x"
+     *        }
      *    },
      *  "mp": {
      *    "weixin": {
@@ -2958,7 +3030,12 @@ export interface FileSystemManager {
      *            "osVer": "12.0",
      *            "uniVer": "x",
      *            "unixVer": "x"
-     *   	  }
+     *   	  },
+     *        "harmony": {
+     *          "osVer": "3.0",
+     *          "uniVer": "4.51",
+     *          "unixVer": "x"
+     *        }
      *    },
      *  "mp": {
      *    "weixin": {
@@ -3022,7 +3099,12 @@ export interface FileSystemManager {
      *            "osVer": "12.0",
      *            "uniVer": "x",
      *            "unixVer": "4.11"
-     *   	  }
+     *   	  },
+     *        "harmony": {
+     *          "osVer": "3.0",
+     *          "uniVer": "4.51",
+     *          "unixVer": "x"
+     *        }
      *    },
      *  "web": {
      *    "uniVer": "x",
@@ -3046,7 +3128,12 @@ export interface FileSystemManager {
      *            "osVer": "12.0",
      *            "uniVer": "x",
      *            "unixVer": "x"
-     *   	  }
+     *   	  },
+     *        "harmony": {
+     *          "osVer": "3.0",
+     *          "uniVer": "4.51",
+     *          "unixVer": "x"
+     *        }
      *    },
      *  "mp": {
      *    "weixin": {
@@ -3110,7 +3197,12 @@ export interface FileSystemManager {
      *            "osVer": "12.0",
      *            "uniVer": "x",
      *            "unixVer": "4.11"
-     *   	  }
+     *   	  },
+     *        "harmony": {
+     *          "osVer": "3.0",
+     *          "uniVer": "4.51",
+     *          "unixVer": "x"
+     *        }
      *    },
      *  "mp": {
      *    "weixin": {
@@ -3174,7 +3266,12 @@ export interface FileSystemManager {
      *            "osVer": "12.0",
      *            "uniVer": "x",
      *            "unixVer": "4.11"
-     *   	  }
+     *   	  },
+     *        "harmony": {
+     *          "osVer": "3.0",
+     *          "uniVer": "4.51",
+     *          "unixVer": "x"
+     *        }
      *    },
      *  "mp": {
      *    "weixin": {
@@ -3240,7 +3337,12 @@ export interface FileSystemManager {
      *            "osVer": "12.0",
      *            "uniVer": "x",
      *            "unixVer": "x"
-     *   	  }
+     *   	  },
+     *        "harmony": {
+     *          "osVer": "3.0",
+     *          "uniVer": "4.51",
+     *          "unixVer": "x"
+     *        }
      *    },
      *  "mp": {
      *    "weixin": {
@@ -3304,7 +3406,12 @@ export interface FileSystemManager {
      *            "osVer": "12.0",
      *            "uniVer": "x",
      *            "unixVer": "x"
-     *   	  }
+     *   	  },
+     *        "harmony": {
+     *          "osVer": "3.0",
+     *          "uniVer": "4.51",
+     *          "unixVer": "x"
+     *        }
      *    },
      *  "mp": {
      *    "weixin": {
@@ -3371,7 +3478,12 @@ export interface FileSystemManager {
      *            "osVer": "12.0",
      *            "uniVer": "x",
      *            "unixVer": "x"
-     *   	  }
+     *   	  },
+     *        "harmony": {
+     *          "osVer": "3.0",
+     *          "uniVer": "4.51",
+     *          "unixVer": "x"
+     *        }
      *    },
      *  "mp": {
      *    "weixin": {
@@ -3421,7 +3533,6 @@ export interface FileSystemManager {
      *  }
      * }
      */
-
     appendFileSync(filePath: string, data: any, encoding?: string): void;
 
     /**
@@ -3437,7 +3548,12 @@ export interface FileSystemManager {
      *            "osVer": "12.0",
      *            "uniVer": "x",
      *            "unixVer": "x"
-     *   	  }
+     *   	  },
+     *        "harmony": {
+     *          "osVer": "3.0",
+     *          "uniVer": "4.51",
+     *          "unixVer": "x"
+     *        }
      *    },
      *  "mp": {
      *    "weixin": {
@@ -3503,7 +3619,12 @@ export interface FileSystemManager {
      *            "osVer": "12.0",
      *            "uniVer": "x",
      *            "unixVer": "x"
-     *   	  }
+     *   	  },
+     *        "harmony": {
+     *          "osVer": "3.0",
+     *          "uniVer": "4.51",
+     *          "unixVer": "x"
+     *        }
      *    },
      *  "web": {
      *    "uniVer": "x",
@@ -3525,7 +3646,12 @@ export interface FileSystemManager {
      *            "osVer": "12.0",
      *            "uniVer": "x",
      *            "unixVer": "x"
-     *   	  }
+     *   	  },
+     *        "harmony": {
+     *          "osVer": "3.0",
+     *          "uniVer": "4.51",
+     *          "unixVer": "x"
+     *        }
      *    },
      *  "mp": {
      *    "weixin": {
@@ -3589,7 +3715,12 @@ export interface FileSystemManager {
      *            "osVer": "12.0",
      *            "uniVer": "x",
      *            "unixVer": "x"
-     *   	  }
+     *   	  },
+     *        "harmony": {
+     *          "osVer": "3.0",
+     *          "uniVer": "4.51",
+     *          "unixVer": "x"
+     *        }
      *    },
      *  "mp": {
      *    "weixin": {
@@ -3653,7 +3784,12 @@ export interface FileSystemManager {
      *            "osVer": "12.0",
      *            "uniVer": "x",
      *            "unixVer": "x"
-     *   	  }
+     *   	  },
+     *        "harmony": {
+     *          "osVer": "3.0",
+     *          "uniVer": "4.51",
+     *          "unixVer": "x"
+     *        }
      *    },
      *  "mp": {
      *    "weixin": {
@@ -3717,7 +3853,12 @@ export interface FileSystemManager {
      *            "osVer": "12.0",
      *            "uniVer": "x",
      *            "unixVer": "x"
-     *   	  }
+     *   	  },
+     *        "harmony": {
+     *          "osVer": "3.0",
+     *          "uniVer": "4.51",
+     *          "unixVer": "x"
+     *        }
      *    },
      *  "mp": {
      *    "weixin": {
@@ -3783,7 +3924,12 @@ export interface FileSystemManager {
      *            "osVer": "12.0",
      *            "uniVer": "x",
      *            "unixVer": "x"
-     *   	  }
+     *   	  },
+     *        "harmony": {
+     *          "osVer": "3.0",
+     *          "uniVer": "4.51",
+     *          "unixVer": "x"
+     *        }
      *    },
      *  "mp": {
      *    "weixin": {
@@ -3847,6 +3993,11 @@ export interface FileSystemManager {
      *            "osVer": "12.0",
      *            "uniVer": "x",
      *            "unixVer": "x"
+     *   	  },
+     *        "harmony": {
+     *            "osVer": "x",
+     *            "uniVer": "x",
+     *            "unixVer": "x"
      *   	  }
      *    },
      *  "web": {
@@ -3871,6 +4022,11 @@ export interface FileSystemManager {
      *            "osVer": "12.0",
      *            "uniVer": "x",
      *            "unixVer": "x"
+     *   	  },
+     *        "harmony": {
+     *            "osVer": "x",
+     *            "uniVer": "x",
+     *            "unixVer": "x"
      *   	  }
      *    },
      *  "mp": {
@@ -3935,7 +4091,12 @@ export interface FileSystemManager {
      *            "osVer": "12.0",
      *            "uniVer": "x",
      *            "unixVer": "x"
-     *   	  }
+     *   	  },
+     *        "harmony": {
+     *          "osVer": "3.0",
+     *          "uniVer": "4.51",
+     *          "unixVer": "x"
+     *        }
      *    },
      *  "mp": {
      *    "weixin": {
@@ -3999,7 +4160,12 @@ export interface FileSystemManager {
      *            "osVer": "12.0",
      *            "uniVer": "x",
      *            "unixVer": "x"
-     *   	  }
+     *   	  },
+     *        "harmony": {
+     *          "osVer": "3.0",
+     *          "uniVer": "4.51",
+     *          "unixVer": "x"
+     *        }
      *    },
      *  "mp": {
      *    "weixin": {
@@ -4159,7 +4325,12 @@ export interface FileSystemManager {
      *            "osVer": "12.0",
      *            "uniVer": "x",
      *            "unixVer": "x"
-     *   	  }
+     *   	  },
+     *        "harmony": {
+     *          "osVer": "3.0",
+     *          "uniVer": "4.51",
+     *          "unixVer": "x"
+     *        }
      *    },
      *  "mp": {
      *    "weixin": {
@@ -4223,7 +4394,12 @@ export interface FileSystemManager {
      *            "osVer": "12.0",
      *            "uniVer": "x",
      *            "unixVer": "x"
-     *   	  }
+     *   	  },
+     *        "harmony": {
+     *          "osVer": "3.0",
+     *          "uniVer": "4.51",
+     *          "unixVer": "x"
+     *        }
      *    },
      *  "mp": {
      *    "weixin": {
@@ -4287,7 +4463,12 @@ export interface FileSystemManager {
      *            "osVer": "12.0",
      *            "uniVer": "x",
      *            "unixVer": "x"
-     *   	  }
+     *   	  },
+     *        "harmony": {
+     *          "osVer": "3.0",
+     *          "uniVer": "4.51",
+     *          "unixVer": "x"
+     *        }
      *    },
      *  "mp": {
      *    "weixin": {
@@ -4351,7 +4532,12 @@ export interface FileSystemManager {
      *            "osVer": "12.0",
      *            "uniVer": "x",
      *            "unixVer": "x"
-     *   	  }
+     *   	  },
+     *        "harmony": {
+     *          "osVer": "3.0",
+     *          "uniVer": "4.51",
+     *          "unixVer": "x"
+     *        }
      *    },
      *  "mp": {
      *    "weixin": {
@@ -4415,7 +4601,12 @@ export interface FileSystemManager {
      *            "osVer": "12.0",
      *            "uniVer": "x",
      *            "unixVer": "x"
-     *   	  }
+     *   	  },
+     *        "harmony": {
+     *          "osVer": "3.0",
+     *          "uniVer": "4.51",
+     *          "unixVer": "x"
+     *        }
      *    },
      *  "web": {
      *    "uniVer": "x",
@@ -4437,7 +4628,12 @@ export interface FileSystemManager {
      *            "osVer": "12.0",
      *            "uniVer": "x",
      *            "unixVer": "x"
-     *   	  }
+     *   	  },
+     *        "harmony": {
+     *          "osVer": "3.0",
+     *          "uniVer": "4.51",
+     *          "unixVer": "x"
+     *        }
      *    },
      *  "mp": {
      *    "weixin": {
@@ -4501,7 +4697,12 @@ export interface FileSystemManager {
      *            "osVer": "12.0",
      *            "uniVer": "x",
      *            "unixVer": "x"
-     *   	  }
+     *   	  },
+     *        "harmony": {
+     *          "osVer": "3.0",
+     *          "uniVer": "4.51",
+     *          "unixVer": "x"
+     *        }
      *    },
      *  "mp": {
      *    "weixin": {
@@ -4564,71 +4765,72 @@ export interface Uni {
      * @tutorial-uni-app-x https://doc.dcloud.net.cn/uni-app-x/api/get-file-system-manager.html
      * @tutorial https://doc.dcloud.net.cn/uni-app-x/api/get-file-system-manager.html
      * @uniPlatform {
-     *    "app": {
-     *        "android": {
-     *            "osVer": "5.0",
-     *            "uniVer": "x",
-     *            "unixVer": "3.9.0"
-     *        },
-     *        "ios": {
-     *            "osVer": "12.0",
-     *            "uniVer": "x",
-     *            "unixVer": "4.11"
-     *   	  },
-     *    "harmony": {
-     *      "osVer": "x",
-     *      "uniVer": "x",
-     *      "unixVer": "x"
-     *    }
-     *    },
-     *  "mp": {
-     *    "weixin": {
-     *        "hostVer": "√",
-     *        "uniVer": "√",
-     *        "unixVer": "4.41"
-     *    },
-     *    "alipay": {
-     *        "hostVer": "√",
-     *        "uniVer": "√",
-     *        "unixVer": "x"
-     *    },
-     *    "baidu": {
-     *        "hostVer": "√",
-     *        "uniVer": "√",
-     *        "unixVer": "x"
-     *    },
-     *    "toutiao": {
-     *        "hostVer": "√",
-     *        "uniVer": "√",
-     *        "unixVer": "x"
-     *    },
-     *    "lark": {
-     *        "hostVer": "√",
-     *        "uniVer": "√",
-     *        "unixVer": "x"
-     *    },
-     *    "qq": {
-     *        "hostVer": "√",
-     *        "uniVer": "√",
-     *        "unixVer": "x"
-     *    },
-     *    "kuaishou": {
-     *        "hostVer": "√",
-     *        "uniVer": "√",
-     *        "unixVer": "x"
-     *    },
-     *    "jd": {
-     *        "hostVer": "√",
-     *        "uniVer": "√",
-     *        "unixVer": "x"
-     *    }
-     *  },
-     *  "web": {
-     *    "uniVer": "x",
-     *    "unixVer": "x"
-     *  }
+     *   "app": {
+     *     "android": {
+     *       "osVer": "5.0",
+     *       "uniVer": "x",
+     *       "unixVer": "3.9.0"
+     *     },
+     *     "ios": {
+     *       "osVer": "12.0",
+     *       "uniVer": "x",
+     *       "unixVer": "4.11"
+     *     },
+     *     "harmony": {
+     *       "osVer": "x",
+     *       "uniVer": "x",
+     *       "unixVer": "x"
+     *     }
+     *   },
+     *   "mp": {
+     *     "weixin": {
+     *       "hostVer": "1.9.9",
+     *       "uniVer": "√",
+     *       "unixVer": "4.41"
+     *     },
+     *     "alipay": {
+     *       "hostVer": "√",
+     *       "uniVer": "√",
+     *       "unixVer": "x"
+     *     },
+     *     "baidu": {
+     *       "hostVer": "√",
+     *       "uniVer": "√",
+     *       "unixVer": "x"
+     *     },
+     *     "toutiao": {
+     *       "hostVer": "√",
+     *       "uniVer": "√",
+     *       "unixVer": "x"
+     *     },
+     *     "lark": {
+     *       "hostVer": "√",
+     *       "uniVer": "√",
+     *       "unixVer": "x"
+     *     },
+     *     "qq": {
+     *       "hostVer": "√",
+     *       "uniVer": "√",
+     *       "unixVer": "x"
+     *     },
+     *     "kuaishou": {
+     *       "hostVer": "√",
+     *       "uniVer": "√",
+     *       "unixVer": "x"
+     *     },
+     *     "jd": {
+     *       "hostVer": "√",
+     *       "uniVer": "√",
+     *       "unixVer": "x"
+     *     }
+     *   },
+     *   "web": {
+     *     "uniVer": "x",
+     *     "unixVer": "x"
+     *   }
      * }
      * @uniVueVersion 2,3  //支持的vue版本
+     * @tutorial_weixin https://developers.weixin.qq.com/miniprogram/dev/api/file/FileSystemManager.html
      */
     getFileSystemManager(): FileSystemManager
 }
@@ -5066,5 +5268,5 @@ export type FileSystemManagerErrorCode =
 
 export type FileSystemManagerFail = IFileSystemManagerFail;
 export interface IFileSystemManagerFail extends IUniError {
-    errCode: number
+    errCode: FileSystemManagerErrorCode
 };