tmui-cli 2.0.3 → 2.0.5

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (1168) hide show
  1. package/README.md +22 -14
  2. package/data/components.json +1 -1
  3. package/data/config.json +1 -1
  4. package/data/doc-index.json +1 -1
  5. package/data/examples/radio.vue +4 -0
  6. package/data/guides//346/233/264/346/226/260/346/227/245/345/277/227.md +2 -0
  7. package/data/tmui4x/60.AI/350/207/252/345/212/250/345/214/226/01.Agent.md +42 -16
  8. package/data/tmui4x/60.AI/350/207/252/345/212/250/345/214/226/04.SKILL.md +9 -8
  9. package/data/tmui4x-doc-index.json +1 -1
  10. package/data/uni-app-x-docs/.vuepress/components/md/banner.vue +241 -0
  11. package/data/uni-app-x-docs/.vuepress/components/md/hperm.vue +59 -0
  12. package/data/uni-app-x-docs/.vuepress/components/md/virtual.vue +49 -0
  13. package/data/uni-app-x-docs/.vuepress/config/copy.js +7 -0
  14. package/data/uni-app-x-docs/.vuepress/config/footer.js +220 -0
  15. package/data/uni-app-x-docs/.vuepress/config/help.js +4 -0
  16. package/data/uni-app-x-docs/.vuepress/config/i18n/index.js +2 -0
  17. package/data/uni-app-x-docs/.vuepress/config/navbar.js +144 -0
  18. package/data/uni-app-x-docs/.vuepress/config/redirectRouter.js +35 -0
  19. package/data/uni-app-x-docs/.vuepress/config/routerMap.js +30 -0
  20. package/data/uni-app-x-docs/.vuepress/config/searchPage.js +53 -0
  21. package/data/uni-app-x-docs/.vuepress/config/siderbar/index.js +6 -0
  22. package/data/uni-app-x-docs/.vuepress/config/siderbar/uni-app-x.js +69 -0
  23. package/data/uni-app-x-docs/.vuepress/config/toc.js +13 -0
  24. package/data/uni-app-x-docs/.vuepress/config.js +130 -0
  25. package/data/uni-app-x-docs/.vuepress/markdown/inject-json-to-md.js +248 -0
  26. package/data/uni-app-x-docs/.vuepress/public/baidu.js +7 -0
  27. package/data/uni-app-x-docs/.vuepress/public/h5/hybrid/html/local.html +88 -0
  28. package/data/uni-app-x-docs/.vuepress/public/h5/index.html +14 -0
  29. package/data/uni-app-x-docs/.vuepress/public/h5/pcguide.html +241 -0
  30. package/data/uni-app-x-docs/.vuepress/public/h5/touch-emulator.js +363 -0
  31. package/data/uni-app-x-docs/.vuepress/public/js/miku.js +10 -0
  32. package/data/uni-app-x-docs/.vuepress/public/miku-delivery-1.2.1.js +7 -0
  33. package/data/uni-app-x-docs/.vuepress/public/miku-delivery-sw-1.2.1.js +7 -0
  34. package/data/uni-app-x-docs/.vuepress/public/pc.html +157 -0
  35. package/data/uni-app-x-docs/.vuepress/public/static/web-view-forum.html +119 -0
  36. package/data/uni-app-x-docs/.vuepress/public/static/web-view.html +119 -0
  37. package/data/uni-app-x-docs/.vuepress/public/svg/uni-open-bridge.svg +1 -0
  38. package/data/uni-app-x-docs/.vuepress/utils/code.js +61 -0
  39. package/data/uni-app-x-docs/.vuepress/utils/cssJson.json +1 -0
  40. package/data/uni-app-x-docs/.vuepress/utils/customTypeJson.json +1 -0
  41. package/data/uni-app-x-docs/.vuepress/utils/example-mapping.json +46 -0
  42. package/data/uni-app-x-docs/.vuepress/utils/example.js +107 -0
  43. package/data/uni-app-x-docs/.vuepress/utils/index.js +20 -0
  44. package/data/uni-app-x-docs/.vuepress/utils/maniFestJson.json +1 -0
  45. package/data/uni-app-x-docs/.vuepress/utils/pageInstanceJson.json +1 -0
  46. package/data/uni-app-x-docs/.vuepress/utils/pagesJson.json +1 -0
  47. package/data/uni-app-x-docs/.vuepress/utils/specialStringJson.json +1 -0
  48. package/data/uni-app-x-docs/.vuepress/utils/utsApiJson.json +1 -0
  49. package/data/uni-app-x-docs/.vuepress/utils/utsComJson.json +1 -0
  50. package/data/uni-app-x-docs/.vuepress/utils/utsDiffTSJson.json +1 -0
  51. package/data/uni-app-x-docs/.vuepress/utils/utsJson.json +1 -0
  52. package/data/uni-app-x-docs/.vuepress/utils/utsUnicloudApiJson.json +1 -0
  53. package/data/uni-app-x-docs/.vuepress/utils/vueJson.json +1 -0
  54. package/data/uni-app-x-docs/404.md +2 -0
  55. package/data/uni-app-x-docs/_sidebar.md +140 -0
  56. package/data/uni-app-x-docs/adapt.md +169 -0
  57. package/data/uni-app-x-docs/ai/NOTE.md +7 -0
  58. package/data/uni-app-x-docs/api/README.md +105 -0
  59. package/data/uni-app-x-docs/api/_sidebar.md +165 -0
  60. package/data/uni-app-x-docs/api/accelerometer.md +72 -0
  61. package/data/uni-app-x-docs/api/action-sheet.md +40 -0
  62. package/data/uni-app-x-docs/api/animation-frame.md +57 -0
  63. package/data/uni-app-x-docs/api/app-route.md +323 -0
  64. package/data/uni-app-x-docs/api/authentication.md +62 -0
  65. package/data/uni-app-x-docs/api/base64.md +33 -0
  66. package/data/uni-app-x-docs/api/bio-auth.md +5 -0
  67. package/data/uni-app-x-docs/api/calendar.md +40 -0
  68. package/data/uni-app-x-docs/api/canvas-get-image-data.md +5 -0
  69. package/data/uni-app-x-docs/api/canvas-put-image-data.md +5 -0
  70. package/data/uni-app-x-docs/api/canvas-to-temp-file-path.md +17 -0
  71. package/data/uni-app-x-docs/api/canvasrenderingcontext2d.md +673 -0
  72. package/data/uni-app-x-docs/api/capture-screen.md +55 -0
  73. package/data/uni-app-x-docs/api/capturescreen.md +5 -0
  74. package/data/uni-app-x-docs/api/choose-file.md +27 -0
  75. package/data/uni-app-x-docs/api/choose-image.md +40 -0
  76. package/data/uni-app-x-docs/api/choose-location.md +304 -0
  77. package/data/uni-app-x-docs/api/choose-media.md +29 -0
  78. package/data/uni-app-x-docs/api/choose-video.md +31 -0
  79. package/data/uni-app-x-docs/api/clipboard.md +44 -0
  80. package/data/uni-app-x-docs/api/compass.md +53 -0
  81. package/data/uni-app-x-docs/api/compress-image.md +25 -0
  82. package/data/uni-app-x-docs/api/compress-video.md +21 -0
  83. package/data/uni-app-x-docs/api/connect-event-source.md +34 -0
  84. package/data/uni-app-x-docs/api/contact.md +37 -0
  85. package/data/uni-app-x-docs/api/create-camera-context.md +27 -0
  86. package/data/uni-app-x-docs/api/create-canvas-context-async.md +36 -0
  87. package/data/uni-app-x-docs/api/create-editor-context-async.md +23 -0
  88. package/data/uni-app-x-docs/api/create-inner-audio-context.md +67 -0
  89. package/data/uni-app-x-docs/api/create-intersection-observer.md +17 -0
  90. package/data/uni-app-x-docs/api/create-interstitial-ad.md +43 -0
  91. package/data/uni-app-x-docs/api/create-live-player-context.md +26 -0
  92. package/data/uni-app-x-docs/api/create-live-pusher-context.md +26 -0
  93. package/data/uni-app-x-docs/api/create-map-context.md +13 -0
  94. package/data/uni-app-x-docs/api/create-request-permission-listener.md +37 -0
  95. package/data/uni-app-x-docs/api/create-rewarded-video-ad.md +58 -0
  96. package/data/uni-app-x-docs/api/create-selector-query.md +161 -0
  97. package/data/uni-app-x-docs/api/create-video-context.md +46 -0
  98. package/data/uni-app-x-docs/api/create-webview-context.md +66 -0
  99. package/data/uni-app-x-docs/api/create-worker.md +293 -0
  100. package/data/uni-app-x-docs/api/dialog-page.md +113 -0
  101. package/data/uni-app-x-docs/api/dom/README.md +520 -0
  102. package/data/uni-app-x-docs/api/dom/cssstyledeclaration.md +515 -0
  103. package/data/uni-app-x-docs/api/dom/domrect.md +11 -0
  104. package/data/uni-app-x-docs/api/dom/drawablecontext.md +212 -0
  105. package/data/uni-app-x-docs/api/dom/element.md +5 -0
  106. package/data/uni-app-x-docs/api/dom/unicanvaselement.md +101 -0
  107. package/data/uni-app-x-docs/api/dom/unielement.md +608 -0
  108. package/data/uni-app-x-docs/api/dom/uniimageelement.md +25 -0
  109. package/data/uni-app-x-docs/api/dom/uniinputelement.md +11 -0
  110. package/data/uni-app-x-docs/api/dom/uninativeviewelement.md +98 -0
  111. package/data/uni-app-x-docs/api/dom/uniresizeobserver.md +48 -0
  112. package/data/uni-app-x-docs/api/dom/unitextareaelement.md +11 -0
  113. package/data/uni-app-x-docs/api/dom/unitextelement.md +49 -0
  114. package/data/uni-app-x-docs/api/dom/univideoelement.md +108 -0
  115. package/data/uni-app-x-docs/api/dom/uniwebviewelement.md +97 -0
  116. package/data/uni-app-x-docs/api/download-file.md +52 -0
  117. package/data/uni-app-x-docs/api/env.md +19 -0
  118. package/data/uni-app-x-docs/api/event-bus.md +81 -0
  119. package/data/uni-app-x-docs/api/exit.md +63 -0
  120. package/data/uni-app-x-docs/api/ext.md +61 -0
  121. package/data/uni-app-x-docs/api/facial-recognition-meta-info.md +47 -0
  122. package/data/uni-app-x-docs/api/facial-recognition-verify.md +5 -0
  123. package/data/uni-app-x-docs/api/file-system-spec.md +224 -0
  124. package/data/uni-app-x-docs/api/get-accessibility-info.md +23 -0
  125. package/data/uni-app-x-docs/api/get-app-authorize-setting.md +29 -0
  126. package/data/uni-app-x-docs/api/get-app-base-info.md +32 -0
  127. package/data/uni-app-x-docs/api/get-app.md +28 -0
  128. package/data/uni-app-x-docs/api/get-background-audio-manager.md +54 -0
  129. package/data/uni-app-x-docs/api/get-battery-info.md +31 -0
  130. package/data/uni-app-x-docs/api/get-current-pages.md +39 -0
  131. package/data/uni-app-x-docs/api/get-device-info.md +35 -0
  132. package/data/uni-app-x-docs/api/get-element-by-id.md +55 -0
  133. package/data/uni-app-x-docs/api/get-element.md +5 -0
  134. package/data/uni-app-x-docs/api/get-file-system-manager.md +62 -0
  135. package/data/uni-app-x-docs/api/get-image-info.md +22 -0
  136. package/data/uni-app-x-docs/api/get-launch-options-sync.md +5 -0
  137. package/data/uni-app-x-docs/api/get-location.md +210 -0
  138. package/data/uni-app-x-docs/api/get-network-type.md +23 -0
  139. package/data/uni-app-x-docs/api/get-performance.md +17 -0
  140. package/data/uni-app-x-docs/api/get-provider.md +5 -0
  141. package/data/uni-app-x-docs/api/get-recorder-manager.md +51 -0
  142. package/data/uni-app-x-docs/api/get-system-info.md +100 -0
  143. package/data/uni-app-x-docs/api/get-system-setting.md +24 -0
  144. package/data/uni-app-x-docs/api/get-univerify-manager.md +306 -0
  145. package/data/uni-app-x-docs/api/get-video-info.md +21 -0
  146. package/data/uni-app-x-docs/api/get-window-info.md +55 -0
  147. package/data/uni-app-x-docs/api/gyroscope.md +80 -0
  148. package/data/uni-app-x-docs/api/image.md +32 -0
  149. package/data/uni-app-x-docs/api/install-apk.md +26 -0
  150. package/data/uni-app-x-docs/api/interceptor.md +35 -0
  151. package/data/uni-app-x-docs/api/is-simulator.md +29 -0
  152. package/data/uni-app-x-docs/api/keyboard.md +55 -0
  153. package/data/uni-app-x-docs/api/launch.md +43 -0
  154. package/data/uni-app-x-docs/api/load-font-face.md +46 -0
  155. package/data/uni-app-x-docs/api/loading.md +61 -0
  156. package/data/uni-app-x-docs/api/locale.md +43 -0
  157. package/data/uni-app-x-docs/api/location-change.md +123 -0
  158. package/data/uni-app-x-docs/api/make-phone-call.md +25 -0
  159. package/data/uni-app-x-docs/api/memory.md +29 -0
  160. package/data/uni-app-x-docs/api/modal.md +51 -0
  161. package/data/uni-app-x-docs/api/navigator-bar-loading.md +40 -0
  162. package/data/uni-app-x-docs/api/navigator.md +89 -0
  163. package/data/uni-app-x-docs/api/network-status-change.md +41 -0
  164. package/data/uni-app-x-docs/api/network-summarize.md +40 -0
  165. package/data/uni-app-x-docs/api/nodes-info.md +5 -0
  166. package/data/uni-app-x-docs/api/on-tab-bar-mid-button-tap.md +20 -0
  167. package/data/uni-app-x-docs/api/open-app-authorize-setting.md +23 -0
  168. package/data/uni-app-x-docs/api/open-document.md +21 -0
  169. package/data/uni-app-x-docs/api/open-location.md +22 -0
  170. package/data/uni-app-x-docs/api/page-scroll-to.md +57 -0
  171. package/data/uni-app-x-docs/api/path2d.md +160 -0
  172. package/data/uni-app-x-docs/api/preview-image.md +44 -0
  173. package/data/uni-app-x-docs/api/privacy.md +84 -0
  174. package/data/uni-app-x-docs/api/provider.md +123 -0
  175. package/data/uni-app-x-docs/api/pull-down-refresh.md +46 -0
  176. package/data/uni-app-x-docs/api/push.md +1 -0
  177. package/data/uni-app-x-docs/api/report.md +44 -0
  178. package/data/uni-app-x-docs/api/request-merchant-transfer.md +31 -0
  179. package/data/uni-app-x-docs/api/request-payment.md +212 -0
  180. package/data/uni-app-x-docs/api/request-system-permission.md +21 -0
  181. package/data/uni-app-x-docs/api/request.md +73 -0
  182. package/data/uni-app-x-docs/api/rpx2px.md +19 -0
  183. package/data/uni-app-x-docs/api/save-image-to-photos-album.md +19 -0
  184. package/data/uni-app-x-docs/api/save-video-to-photos-album.md +17 -0
  185. package/data/uni-app-x-docs/api/scan-code.md +39 -0
  186. package/data/uni-app-x-docs/api/screen-brightness.md +53 -0
  187. package/data/uni-app-x-docs/api/set-navigation-bar-color.md +27 -0
  188. package/data/uni-app-x-docs/api/set-navigation-bar-title.md +22 -0
  189. package/data/uni-app-x-docs/api/set-tab-bar.md +121 -0
  190. package/data/uni-app-x-docs/api/set-tabbar.md +5 -0
  191. package/data/uni-app-x-docs/api/share-with-system.md +27 -0
  192. package/data/uni-app-x-docs/api/share.md +128 -0
  193. package/data/uni-app-x-docs/api/show-action-sheet.md +5 -0
  194. package/data/uni-app-x-docs/api/show-loading.md +5 -0
  195. package/data/uni-app-x-docs/api/show-modal.md +5 -0
  196. package/data/uni-app-x-docs/api/show-toast.md +5 -0
  197. package/data/uni-app-x-docs/api/sign-in.md +141 -0
  198. package/data/uni-app-x-docs/api/storage.md +347 -0
  199. package/data/uni-app-x-docs/api/theme-change.md +477 -0
  200. package/data/uni-app-x-docs/api/theme.md +5 -0
  201. package/data/uni-app-x-docs/api/toast.md +62 -0
  202. package/data/uni-app-x-docs/api/uni-push.md +251 -0
  203. package/data/uni-app-x-docs/api/unicloud/README.md +25 -0
  204. package/data/uni-app-x-docs/api/unicloud/database.md +27 -0
  205. package/data/uni-app-x-docs/api/unicloud/function.md +58 -0
  206. package/data/uni-app-x-docs/api/unicloud/object.md +75 -0
  207. package/data/uni-app-x-docs/api/unicloud/sse-channel.md +103 -0
  208. package/data/uni-app-x-docs/api/unicloud/storage.md +46 -0
  209. package/data/uni-app-x-docs/api/unicloud/utils.md +71 -0
  210. package/data/uni-app-x-docs/api/unipage.md +389 -0
  211. package/data/uni-app-x-docs/api/upload-file.md +40 -0
  212. package/data/uni-app-x-docs/api/vibrate.md +37 -0
  213. package/data/uni-app-x-docs/api/virtual-payment.md +228 -0
  214. package/data/uni-app-x-docs/api/websocket-global.md +5 -0
  215. package/data/uni-app-x-docs/api/websocket.md +116 -0
  216. package/data/uni-app-x-docs/api/wide-screen-adaptation.md +197 -0
  217. package/data/uni-app-x-docs/api/wifi.md +135 -0
  218. package/data/uni-app-x-docs/api/window.md +39 -0
  219. package/data/uni-app-x-docs/app-harmony/README.md +75 -0
  220. package/data/uni-app-x-docs/app-harmony/harmony-vapor.md +5 -0
  221. package/data/uni-app-x-docs/app-vapor.md +599 -0
  222. package/data/uni-app-x-docs/benchmark/vapor-benchmark-android.md +488 -0
  223. package/data/uni-app-x-docs/benchmark/vapor-benchmark-harmony.md +312 -0
  224. package/data/uni-app-x-docs/benchmark/vapor-benchmark-ios.md +375 -0
  225. package/data/uni-app-x-docs/collocation/_sidebar.md +15 -0
  226. package/data/uni-app-x-docs/collocation/app.md +268 -0
  227. package/data/uni-app-x-docs/collocation/manifest-android.md +1321 -0
  228. package/data/uni-app-x-docs/collocation/manifest-harmony.md +152 -0
  229. package/data/uni-app-x-docs/collocation/manifest-ios.md +732 -0
  230. package/data/uni-app-x-docs/collocation/manifest-modules.md +521 -0
  231. package/data/uni-app-x-docs/collocation/manifest-splashscreen.md +232 -0
  232. package/data/uni-app-x-docs/collocation/manifest.md +591 -0
  233. package/data/uni-app-x-docs/collocation/pagesjson.md +462 -0
  234. package/data/uni-app-x-docs/collocation/themejson.md +177 -0
  235. package/data/uni-app-x-docs/compiler/README.md +125 -0
  236. package/data/uni-app-x-docs/compiler/_sidebar.md +4 -0
  237. package/data/uni-app-x-docs/component/README.md +228 -0
  238. package/data/uni-app-x-docs/component/_sidebar.md +118 -0
  239. package/data/uni-app-x-docs/component/ad-custom.md +19 -0
  240. package/data/uni-app-x-docs/component/ad.md +45 -0
  241. package/data/uni-app-x-docs/component/animation-view.md +19 -0
  242. package/data/uni-app-x-docs/component/aria-component.md +19 -0
  243. package/data/uni-app-x-docs/component/audio.md +7 -0
  244. package/data/uni-app-x-docs/component/block.md +21 -0
  245. package/data/uni-app-x-docs/component/button.md +105 -0
  246. package/data/uni-app-x-docs/component/camera.md +54 -0
  247. package/data/uni-app-x-docs/component/canvas.md +163 -0
  248. package/data/uni-app-x-docs/component/channel-live.md +19 -0
  249. package/data/uni-app-x-docs/component/channel-video.md +19 -0
  250. package/data/uni-app-x-docs/component/checkbox-group.md +21 -0
  251. package/data/uni-app-x-docs/component/checkbox.md +27 -0
  252. package/data/uni-app-x-docs/component/common.md +304 -0
  253. package/data/uni-app-x-docs/component/cover-image.md +25 -0
  254. package/data/uni-app-x-docs/component/cover-view.md +25 -0
  255. package/data/uni-app-x-docs/component/custom-tab-bar.md +19 -0
  256. package/data/uni-app-x-docs/component/double-tap-gesture-handler.md +19 -0
  257. package/data/uni-app-x-docs/component/draggable-sheet.md +19 -0
  258. package/data/uni-app-x-docs/component/editor.md +33 -0
  259. package/data/uni-app-x-docs/component/flow-item.md +5 -0
  260. package/data/uni-app-x-docs/component/force-press-gesture-handler.md +19 -0
  261. package/data/uni-app-x-docs/component/form.md +108 -0
  262. package/data/uni-app-x-docs/component/functional-page-navigator.md +19 -0
  263. package/data/uni-app-x-docs/component/glass-effect-view.md +32 -0
  264. package/data/uni-app-x-docs/component/grid-builder.md +19 -0
  265. package/data/uni-app-x-docs/component/grid-view.md +19 -0
  266. package/data/uni-app-x-docs/component/horizontal-drag-gesture-handler.md +19 -0
  267. package/data/uni-app-x-docs/component/icon.md +19 -0
  268. package/data/uni-app-x-docs/component/image.md +79 -0
  269. package/data/uni-app-x-docs/component/input.md +121 -0
  270. package/data/uni-app-x-docs/component/keyboard-accessory.md +19 -0
  271. package/data/uni-app-x-docs/component/label.md +21 -0
  272. package/data/uni-app-x-docs/component/list-builder.md +19 -0
  273. package/data/uni-app-x-docs/component/list-item.md +1 -0
  274. package/data/uni-app-x-docs/component/list-view.md +191 -0
  275. package/data/uni-app-x-docs/component/live-player.md +29 -0
  276. package/data/uni-app-x-docs/component/live-pusher.md +31 -0
  277. package/data/uni-app-x-docs/component/loading.md +31 -0
  278. package/data/uni-app-x-docs/component/long-press-gesture-handler.md +19 -0
  279. package/data/uni-app-x-docs/component/map.md +116 -0
  280. package/data/uni-app-x-docs/component/match-media.md +21 -0
  281. package/data/uni-app-x-docs/component/movable-area.md +27 -0
  282. package/data/uni-app-x-docs/component/movable-view.md +27 -0
  283. package/data/uni-app-x-docs/component/native-component.md +19 -0
  284. package/data/uni-app-x-docs/component/native-view.md +210 -0
  285. package/data/uni-app-x-docs/component/navigation-bar.md +19 -0
  286. package/data/uni-app-x-docs/component/navigator.md +22 -0
  287. package/data/uni-app-x-docs/component/nested-scroll-body.md +32 -0
  288. package/data/uni-app-x-docs/component/nested-scroll-header.md +32 -0
  289. package/data/uni-app-x-docs/component/nested-scroll.md +8 -0
  290. package/data/uni-app-x-docs/component/official-account.md +19 -0
  291. package/data/uni-app-x-docs/component/open-container.md +19 -0
  292. package/data/uni-app-x-docs/component/page-container.md +37 -0
  293. package/data/uni-app-x-docs/component/page-meta.md +19 -0
  294. package/data/uni-app-x-docs/component/pan-gesture-handler.md +19 -0
  295. package/data/uni-app-x-docs/component/picker-view-column.md +5 -0
  296. package/data/uni-app-x-docs/component/picker-view.md +48 -0
  297. package/data/uni-app-x-docs/component/picker.md +29 -0
  298. package/data/uni-app-x-docs/component/progress.md +19 -0
  299. package/data/uni-app-x-docs/component/radio-group.md +21 -0
  300. package/data/uni-app-x-docs/component/radio.md +27 -0
  301. package/data/uni-app-x-docs/component/rich-text.md +108 -0
  302. package/data/uni-app-x-docs/component/root-portal.md +19 -0
  303. package/data/uni-app-x-docs/component/scale-gesture-handler.md +19 -0
  304. package/data/uni-app-x-docs/component/scroll-view.md +213 -0
  305. package/data/uni-app-x-docs/component/share-element.md +84 -0
  306. package/data/uni-app-x-docs/component/slider.md +44 -0
  307. package/data/uni-app-x-docs/component/snapshot.md +19 -0
  308. package/data/uni-app-x-docs/component/span.md +19 -0
  309. package/data/uni-app-x-docs/component/sticky-header.md +50 -0
  310. package/data/uni-app-x-docs/component/sticky-section.md +54 -0
  311. package/data/uni-app-x-docs/component/sticky.md +8 -0
  312. package/data/uni-app-x-docs/component/store-home.md +19 -0
  313. package/data/uni-app-x-docs/component/store-product.md +19 -0
  314. package/data/uni-app-x-docs/component/swiper-item.md +5 -0
  315. package/data/uni-app-x-docs/component/swiper.md +94 -0
  316. package/data/uni-app-x-docs/component/switch.md +28 -0
  317. package/data/uni-app-x-docs/component/tap-gesture-handler.md +19 -0
  318. package/data/uni-app-x-docs/component/text.md +242 -0
  319. package/data/uni-app-x-docs/component/textarea.md +90 -0
  320. package/data/uni-app-x-docs/component/uni-ui-x/README.md +1 -0
  321. package/data/uni-app-x-docs/component/uni-ui-x/uni-badge-view.md +25 -0
  322. package/data/uni-app-x-docs/component/uni-ui-x/uni-collapse-item.md +5 -0
  323. package/data/uni-app-x-docs/component/uni-ui-x/uni-collapse.md +48 -0
  324. package/data/uni-app-x-docs/component/uni-ui-x/uni-drag-cell.md +25 -0
  325. package/data/uni-app-x-docs/component/uni-ui-x/uni-fab-button.md +25 -0
  326. package/data/uni-app-x-docs/component/uni-ui-x/uni-index-bar.md +25 -0
  327. package/data/uni-app-x-docs/component/uni-ui-x/uni-link.md +25 -0
  328. package/data/uni-app-x-docs/component/uni-ui-x/uni-nav-bar.md +25 -0
  329. package/data/uni-app-x-docs/component/uni-ui-x/uni-number-box.md +25 -0
  330. package/data/uni-app-x-docs/component/uni-ui-x/uni-rate.md +25 -0
  331. package/data/uni-app-x-docs/component/uni-ui-x/uni-refresh-box.md +25 -0
  332. package/data/uni-app-x-docs/component/uni-ui-x/uni-tab-bar.md +5 -0
  333. package/data/uni-app-x-docs/component/uni-ui-x/uni-tab-content.md +5 -0
  334. package/data/uni-app-x-docs/component/uni-ui-x/uni-tab-item.md +5 -0
  335. package/data/uni-app-x-docs/component/uni-ui-x/uni-tab-midbutton.md +5 -0
  336. package/data/uni-app-x-docs/component/uni-ui-x/uni-tab.md +111 -0
  337. package/data/uni-app-x-docs/component/uni-ui-x/uni-time-format.md +25 -0
  338. package/data/uni-app-x-docs/component/unicloud-db.md +19 -0
  339. package/data/uni-app-x-docs/component/vertical-drag-gesture-handler.md +19 -0
  340. package/data/uni-app-x-docs/component/video.md +139 -0
  341. package/data/uni-app-x-docs/component/view.md +86 -0
  342. package/data/uni-app-x-docs/component/voip-room.md +19 -0
  343. package/data/uni-app-x-docs/component/waterflow.md +122 -0
  344. package/data/uni-app-x-docs/component/web-view.md +160 -0
  345. package/data/uni-app-x-docs/css/README.md +274 -0
  346. package/data/uni-app-x-docs/css/_sidebar.md +103 -0
  347. package/data/uni-app-x-docs/css/align-content.md +22 -0
  348. package/data/uni-app-x-docs/css/align-items.md +20 -0
  349. package/data/uni-app-x-docs/css/align-self.md +20 -0
  350. package/data/uni-app-x-docs/css/animation-composition.md +18 -0
  351. package/data/uni-app-x-docs/css/animation-delay.md +18 -0
  352. package/data/uni-app-x-docs/css/animation-direction.md +18 -0
  353. package/data/uni-app-x-docs/css/animation-duration.md +18 -0
  354. package/data/uni-app-x-docs/css/animation-fill-mode.md +18 -0
  355. package/data/uni-app-x-docs/css/animation-iteration-count.md +18 -0
  356. package/data/uni-app-x-docs/css/animation-name.md +18 -0
  357. package/data/uni-app-x-docs/css/animation-play-state.md +18 -0
  358. package/data/uni-app-x-docs/css/animation-range-end.md +18 -0
  359. package/data/uni-app-x-docs/css/animation-range-start.md +18 -0
  360. package/data/uni-app-x-docs/css/animation-range.md +18 -0
  361. package/data/uni-app-x-docs/css/animation-timeline.md +18 -0
  362. package/data/uni-app-x-docs/css/animation-timing-function.md +18 -0
  363. package/data/uni-app-x-docs/css/animation.md +18 -0
  364. package/data/uni-app-x-docs/css/backdrop-filter.md +21 -0
  365. package/data/uni-app-x-docs/css/background-clip.md +20 -0
  366. package/data/uni-app-x-docs/css/background-color.md +25 -0
  367. package/data/uni-app-x-docs/css/background-image.md +48 -0
  368. package/data/uni-app-x-docs/css/background.md +20 -0
  369. package/data/uni-app-x-docs/css/border-bottom-color.md +20 -0
  370. package/data/uni-app-x-docs/css/border-bottom-left-radius.md +23 -0
  371. package/data/uni-app-x-docs/css/border-bottom-right-radius.md +23 -0
  372. package/data/uni-app-x-docs/css/border-bottom-style.md +20 -0
  373. package/data/uni-app-x-docs/css/border-bottom-width.md +27 -0
  374. package/data/uni-app-x-docs/css/border-bottom.md +20 -0
  375. package/data/uni-app-x-docs/css/border-color.md +20 -0
  376. package/data/uni-app-x-docs/css/border-left-color.md +20 -0
  377. package/data/uni-app-x-docs/css/border-left-style.md +20 -0
  378. package/data/uni-app-x-docs/css/border-left-width.md +27 -0
  379. package/data/uni-app-x-docs/css/border-left.md +20 -0
  380. package/data/uni-app-x-docs/css/border-radius.md +27 -0
  381. package/data/uni-app-x-docs/css/border-right-color.md +20 -0
  382. package/data/uni-app-x-docs/css/border-right-style.md +20 -0
  383. package/data/uni-app-x-docs/css/border-right-width.md +27 -0
  384. package/data/uni-app-x-docs/css/border-right.md +20 -0
  385. package/data/uni-app-x-docs/css/border-style.md +24 -0
  386. package/data/uni-app-x-docs/css/border-top-color.md +20 -0
  387. package/data/uni-app-x-docs/css/border-top-left-radius.md +23 -0
  388. package/data/uni-app-x-docs/css/border-top-right-radius.md +23 -0
  389. package/data/uni-app-x-docs/css/border-top-style.md +20 -0
  390. package/data/uni-app-x-docs/css/border-top-width.md +27 -0
  391. package/data/uni-app-x-docs/css/border-top.md +20 -0
  392. package/data/uni-app-x-docs/css/border-width.md +24 -0
  393. package/data/uni-app-x-docs/css/border.md +23 -0
  394. package/data/uni-app-x-docs/css/bottom.md +20 -0
  395. package/data/uni-app-x-docs/css/box-shadow.md +26 -0
  396. package/data/uni-app-x-docs/css/box-sizing.md +20 -0
  397. package/data/uni-app-x-docs/css/color.md +27 -0
  398. package/data/uni-app-x-docs/css/common/at-rules.md +293 -0
  399. package/data/uni-app-x-docs/css/common/color.md +9 -0
  400. package/data/uni-app-x-docs/css/common/function.md +165 -0
  401. package/data/uni-app-x-docs/css/common/length.md +89 -0
  402. package/data/uni-app-x-docs/css/common/selector.md +50 -0
  403. package/data/uni-app-x-docs/css/common/style-isolation.md +258 -0
  404. package/data/uni-app-x-docs/css/common/variable.md +1 -0
  405. package/data/uni-app-x-docs/css/direction.md +18 -0
  406. package/data/uni-app-x-docs/css/display.md +23 -0
  407. package/data/uni-app-x-docs/css/flex-basis.md +20 -0
  408. package/data/uni-app-x-docs/css/flex-direction.md +20 -0
  409. package/data/uni-app-x-docs/css/flex-flow.md +20 -0
  410. package/data/uni-app-x-docs/css/flex-grow.md +20 -0
  411. package/data/uni-app-x-docs/css/flex-shrink.md +20 -0
  412. package/data/uni-app-x-docs/css/flex-wrap.md +20 -0
  413. package/data/uni-app-x-docs/css/flex.md +20 -0
  414. package/data/uni-app-x-docs/css/font-family.md +50 -0
  415. package/data/uni-app-x-docs/css/font-size.md +51 -0
  416. package/data/uni-app-x-docs/css/font-style.md +23 -0
  417. package/data/uni-app-x-docs/css/font-weight.md +24 -0
  418. package/data/uni-app-x-docs/css/height.md +23 -0
  419. package/data/uni-app-x-docs/css/justify-content.md +20 -0
  420. package/data/uni-app-x-docs/css/left.md +20 -0
  421. package/data/uni-app-x-docs/css/letter-spacing.md +20 -0
  422. package/data/uni-app-x-docs/css/line-height.md +37 -0
  423. package/data/uni-app-x-docs/css/lines.md +23 -0
  424. package/data/uni-app-x-docs/css/margin-bottom.md +25 -0
  425. package/data/uni-app-x-docs/css/margin-left.md +25 -0
  426. package/data/uni-app-x-docs/css/margin-right.md +25 -0
  427. package/data/uni-app-x-docs/css/margin-top.md +25 -0
  428. package/data/uni-app-x-docs/css/margin.md +33 -0
  429. package/data/uni-app-x-docs/css/max-height.md +20 -0
  430. package/data/uni-app-x-docs/css/max-width.md +20 -0
  431. package/data/uni-app-x-docs/css/min-height.md +27 -0
  432. package/data/uni-app-x-docs/css/min-width.md +20 -0
  433. package/data/uni-app-x-docs/css/opacity.md +20 -0
  434. package/data/uni-app-x-docs/css/overflow.md +28 -0
  435. package/data/uni-app-x-docs/css/padding-bottom.md +23 -0
  436. package/data/uni-app-x-docs/css/padding-left.md +23 -0
  437. package/data/uni-app-x-docs/css/padding-right.md +23 -0
  438. package/data/uni-app-x-docs/css/padding-top.md +23 -0
  439. package/data/uni-app-x-docs/css/padding.md +23 -0
  440. package/data/uni-app-x-docs/css/pointer-events.md +26 -0
  441. package/data/uni-app-x-docs/css/position.md +50 -0
  442. package/data/uni-app-x-docs/css/right.md +20 -0
  443. package/data/uni-app-x-docs/css/text-align.md +23 -0
  444. package/data/uni-app-x-docs/css/text-decoration-color.md +25 -0
  445. package/data/uni-app-x-docs/css/text-decoration-line.md +24 -0
  446. package/data/uni-app-x-docs/css/text-decoration-style.md +23 -0
  447. package/data/uni-app-x-docs/css/text-decoration-thickness.md +23 -0
  448. package/data/uni-app-x-docs/css/text-decoration.md +24 -0
  449. package/data/uni-app-x-docs/css/text-overflow.md +24 -0
  450. package/data/uni-app-x-docs/css/text-shadow.md +22 -0
  451. package/data/uni-app-x-docs/css/top.md +20 -0
  452. package/data/uni-app-x-docs/css/transform-origin.md +20 -0
  453. package/data/uni-app-x-docs/css/transform.md +32 -0
  454. package/data/uni-app-x-docs/css/transition-delay.md +27 -0
  455. package/data/uni-app-x-docs/css/transition-duration.md +27 -0
  456. package/data/uni-app-x-docs/css/transition-property.md +23 -0
  457. package/data/uni-app-x-docs/css/transition-timing-function.md +23 -0
  458. package/data/uni-app-x-docs/css/transition.md +43 -0
  459. package/data/uni-app-x-docs/css/visibility.md +26 -0
  460. package/data/uni-app-x-docs/css/white-space.md +49 -0
  461. package/data/uni-app-x-docs/css/width.md +23 -0
  462. package/data/uni-app-x-docs/css/z-index.md +127 -0
  463. package/data/uni-app-x-docs/debug/android-inspector.md +55 -0
  464. package/data/uni-app-x-docs/i18n.md +379 -0
  465. package/data/uni-app-x-docs/mp/README.md +155 -0
  466. package/data/uni-app-x-docs/mp/native-component-and-wxs.md +166 -0
  467. package/data/uni-app-x-docs/native/README.md +67 -0
  468. package/data/uni-app-x-docs/native/debug/android.md +126 -0
  469. package/data/uni-app-x-docs/native/debug/harmony.md +119 -0
  470. package/data/uni-app-x-docs/native/debug/ios.md +92 -0
  471. package/data/uni-app-x-docs/native/download/android.md +132 -0
  472. package/data/uni-app-x-docs/native/download/ios.md +32 -0
  473. package/data/uni-app-x-docs/native/modules/android/others.md +1441 -0
  474. package/data/uni-app-x-docs/native/modules/android/uni-ad.md +104 -0
  475. package/data/uni-app-x-docs/native/modules/android/uni-facialRecognitionVerify.md +74 -0
  476. package/data/uni-app-x-docs/native/modules/android/uni-getLocation.md +131 -0
  477. package/data/uni-app-x-docs/native/modules/android/uni-map-tencent.md +101 -0
  478. package/data/uni-app-x-docs/native/modules/android/uni-oauth.md +61 -0
  479. package/data/uni-app-x-docs/native/modules/android/uni-payment.md +120 -0
  480. package/data/uni-app-x-docs/native/modules/android/uni-push.md +229 -0
  481. package/data/uni-app-x-docs/native/modules/android/uni-share.md +61 -0
  482. package/data/uni-app-x-docs/native/modules/android/uni-verify.md +105 -0
  483. package/data/uni-app-x-docs/native/modules/android/uni-video.md +135 -0
  484. package/data/uni-app-x-docs/native/modules/harmony/facialVerify.md +47 -0
  485. package/data/uni-app-x-docs/native/modules/harmony/location.md +43 -0
  486. package/data/uni-app-x-docs/native/modules/harmony/map.md +64 -0
  487. package/data/uni-app-x-docs/native/modules/harmony/modules.md +23 -0
  488. package/data/uni-app-x-docs/native/modules/harmony/oauth.md +47 -0
  489. package/data/uni-app-x-docs/native/modules/harmony/pay.md +87 -0
  490. package/data/uni-app-x-docs/native/modules/harmony/push.md +74 -0
  491. package/data/uni-app-x-docs/native/modules/harmony/verify.md +45 -0
  492. package/data/uni-app-x-docs/native/modules/ios/modules.md +962 -0
  493. package/data/uni-app-x-docs/native/permission/android_permission_adapter.md +63 -0
  494. package/data/uni-app-x-docs/native/use/android.md +541 -0
  495. package/data/uni-app-x-docs/native/use/androidcomm.md +164 -0
  496. package/data/uni-app-x-docs/native/use/androiduts.md +398 -0
  497. package/data/uni-app-x-docs/native/use/harmony.md +105 -0
  498. package/data/uni-app-x-docs/native/use/harmonyapi.md +205 -0
  499. package/data/uni-app-x-docs/native/use/harmonyuts.md +62 -0
  500. package/data/uni-app-x-docs/native/use/ios.md +96 -0
  501. package/data/uni-app-x-docs/native/use/iosapi.md +290 -0
  502. package/data/uni-app-x-docs/native/use/iosuts.md +89 -0
  503. package/data/uni-app-x-docs/page.md +503 -0
  504. package/data/uni-app-x-docs/performance.md +181 -0
  505. package/data/uni-app-x-docs/plugin/NOTE.md +7 -0
  506. package/data/uni-app-x-docs/project.md +153 -0
  507. package/data/uni-app-x-docs/readme.md +401 -0
  508. package/data/uni-app-x-docs/release-note-alpha.md +2361 -0
  509. package/data/uni-app-x-docs/release.md +2224 -0
  510. package/data/uni-app-x-docs/sample.md +157 -0
  511. package/data/uni-app-x-docs/select/native-render-and-self-render.md +386 -0
  512. package/data/uni-app-x-docs/select.md +365 -0
  513. package/data/uni-app-x-docs/static/4050-hello-flatten-optimized-device1-r1.png +0 -0
  514. package/data/uni-app-x-docs/static/calendar.jpg +0 -0
  515. package/data/uni-app-x-docs/static/go-to-definition.png +0 -0
  516. package/data/uni-app-x-docs/static/hxconsolepageperformance.png +0 -0
  517. package/data/uni-app-x-docs/static/json2type.png +0 -0
  518. package/data/uni-app-x-docs/static/newproject.png +0 -0
  519. package/data/uni-app-x-docs/static/playground.jpg +0 -0
  520. package/data/uni-app-x-docs/static/project-icon.png +0 -0
  521. package/data/uni-app-x-docs/static/uaxding.png +0 -0
  522. package/data/uni-app-x-docs/static/view-API-type-info.png +0 -0
  523. package/data/uni-app-x-docs/tutorial/android-16kb.md +100 -0
  524. package/data/uni-app-x-docs/tutorial/android-memoryleak.md +553 -0
  525. package/data/uni-app-x-docs/tutorial/app-env.md +84 -0
  526. package/data/uni-app-x-docs/tutorial/app-market.md +58 -0
  527. package/data/uni-app-x-docs/tutorial/app-package.md +196 -0
  528. package/data/uni-app-x-docs/tutorial/app-playground.md +188 -0
  529. package/data/uni-app-x-docs/tutorial/app-update-wgt.md +13 -0
  530. package/data/uni-app-x-docs/tutorial/bug_repair.md +40 -0
  531. package/data/uni-app-x-docs/tutorial/codegap.md +291 -0
  532. package/data/uni-app-x-docs/tutorial/compatibility.md +120 -0
  533. package/data/uni-app-x-docs/tutorial/compliance.md +833 -0
  534. package/data/uni-app-x-docs/tutorial/debug/devtools.md +137 -0
  535. package/data/uni-app-x-docs/tutorial/idref.md +126 -0
  536. package/data/uni-app-x-docs/tutorial/ls-plugin.md +186 -0
  537. package/data/uni-app-x-docs/tutorial/request.md +321 -0
  538. package/data/uni-app-x-docs/tutorial/rules_mcp.md +123 -0
  539. package/data/uni-app-x-docs/tutorial/stickynestlist.md +68 -0
  540. package/data/uni-app-x-docs/tutorial/store.md +161 -0
  541. package/data/uni-app-x-docs/uniapptox.md +145 -0
  542. package/data/uni-app-x-docs/uts/README.md +458 -0
  543. package/data/uni-app-x-docs/uts/_sidebar.md +57 -0
  544. package/data/uni-app-x-docs/uts/buildin-object-api/array.md +981 -0
  545. package/data/uni-app-x-docs/uts/buildin-object-api/arraybuffer.md +257 -0
  546. package/data/uni-app-x-docs/uts/buildin-object-api/console.md +208 -0
  547. package/data/uni-app-x-docs/uts/buildin-object-api/dataview.md +304 -0
  548. package/data/uni-app-x-docs/uts/buildin-object-api/date.md +707 -0
  549. package/data/uni-app-x-docs/uts/buildin-object-api/error.md +31 -0
  550. package/data/uni-app-x-docs/uts/buildin-object-api/float32array.md +485 -0
  551. package/data/uni-app-x-docs/uts/buildin-object-api/float64array.md +473 -0
  552. package/data/uni-app-x-docs/uts/buildin-object-api/global.md +222 -0
  553. package/data/uni-app-x-docs/uts/buildin-object-api/int16array.md +455 -0
  554. package/data/uni-app-x-docs/uts/buildin-object-api/int32array.md +483 -0
  555. package/data/uni-app-x-docs/uts/buildin-object-api/int8array.md +473 -0
  556. package/data/uni-app-x-docs/uts/buildin-object-api/json.md +236 -0
  557. package/data/uni-app-x-docs/uts/buildin-object-api/map.md +187 -0
  558. package/data/uni-app-x-docs/uts/buildin-object-api/math.md +502 -0
  559. package/data/uni-app-x-docs/uts/buildin-object-api/number.md +363 -0
  560. package/data/uni-app-x-docs/uts/buildin-object-api/promise.md +265 -0
  561. package/data/uni-app-x-docs/uts/buildin-object-api/regexp.md +263 -0
  562. package/data/uni-app-x-docs/uts/buildin-object-api/set.md +170 -0
  563. package/data/uni-app-x-docs/uts/buildin-object-api/string.md +723 -0
  564. package/data/uni-app-x-docs/uts/buildin-object-api/textdecoder.md +70 -0
  565. package/data/uni-app-x-docs/uts/buildin-object-api/textencoder.md +41 -0
  566. package/data/uni-app-x-docs/uts/buildin-object-api/timers.md +99 -0
  567. package/data/uni-app-x-docs/uts/buildin-object-api/uint16array.md +483 -0
  568. package/data/uni-app-x-docs/uts/buildin-object-api/uint32array.md +484 -0
  569. package/data/uni-app-x-docs/uts/buildin-object-api/uint8array.md +483 -0
  570. package/data/uni-app-x-docs/uts/buildin-object-api/uint8clampedarray.md +483 -0
  571. package/data/uni-app-x-docs/uts/buildin-object-api/utsjsonobject.md +361 -0
  572. package/data/uni-app-x-docs/uts/class.md +504 -0
  573. package/data/uni-app-x-docs/uts/compiler-known-issues.md +1242 -0
  574. package/data/uni-app-x-docs/uts/conditional.md +209 -0
  575. package/data/uni-app-x-docs/uts/data-type.md +2248 -0
  576. package/data/uni-app-x-docs/uts/enumerability.md +16 -0
  577. package/data/uni-app-x-docs/uts/enumerability_iterable.md +211 -0
  578. package/data/uni-app-x-docs/uts/exception.md +25 -0
  579. package/data/uni-app-x-docs/uts/function.md +359 -0
  580. package/data/uni-app-x-docs/uts/generics.md +251 -0
  581. package/data/uni-app-x-docs/uts/interface.md +37 -0
  582. package/data/uni-app-x-docs/uts/iterable.md +150 -0
  583. package/data/uni-app-x-docs/uts/keywords.md +436 -0
  584. package/data/uni-app-x-docs/uts/literal.md +252 -0
  585. package/data/uni-app-x-docs/uts/loops.md +240 -0
  586. package/data/uni-app-x-docs/uts/module.md +92 -0
  587. package/data/uni-app-x-docs/uts/object.md +156 -0
  588. package/data/uni-app-x-docs/uts/operator.md +304 -0
  589. package/data/uni-app-x-docs/uts/runtime-known-issues.md +99 -0
  590. package/data/uni-app-x-docs/uts/type-aliases.md +43 -0
  591. package/data/uni-app-x-docs/uts/type-compatibility.md +133 -0
  592. package/data/uni-app-x-docs/uts/uts-optimize.md +33 -0
  593. package/data/uni-app-x-docs/uts/uts_diff_ts.md +2292 -0
  594. package/data/uni-app-x-docs/uts/utsactivitycallback.md +1357 -0
  595. package/data/uni-app-x-docs/uts/utsandroid.md +850 -0
  596. package/data/uni-app-x-docs/uts/utsandroidhookproxy.md +17 -0
  597. package/data/uni-app-x-docs/uts/utsharmony.md +219 -0
  598. package/data/uni-app-x-docs/uts/utsios.md +305 -0
  599. package/data/uni-app-x-docs/uts/utsioshookproxy.md +148 -0
  600. package/data/uni-app-x-docs/vapor-benchmark.md +11 -0
  601. package/data/uni-app-x-docs/vue/README.md +588 -0
  602. package/data/uni-app-x-docs/vue/_sidebar.md +10 -0
  603. package/data/uni-app-x-docs/vue/advanced-api.md +138 -0
  604. package/data/uni-app-x-docs/vue/built-in.md +741 -0
  605. package/data/uni-app-x-docs/vue/component.md +704 -0
  606. package/data/uni-app-x-docs/vue/composition-api.md +779 -0
  607. package/data/uni-app-x-docs/vue/data-bind.md +163 -0
  608. package/data/uni-app-x-docs/vue/global-api.md +109 -0
  609. package/data/uni-app-x-docs/vue/modifier.md +202 -0
  610. package/data/uni-app-x-docs/vue/options-api.md +512 -0
  611. package/data/uni-app-x-docs/vue/others.md +20 -0
  612. package/data/uni-app-x-docs/web/README.md +279 -0
  613. package/data/uni-app-x-docs/web/ssr.md +290 -0
  614. package/data/uni-app-x-docs/worktile/NOTE.md +7 -0
  615. package/data/uniappx/404.md +2 -0
  616. package/data/uniappx/_sidebar.md +140 -0
  617. package/data/uniappx/adapt.md +165 -0
  618. package/data/uniappx/ai/NOTE.md +5 -0
  619. package/data/uniappx/api/README.md +98 -0
  620. package/data/uniappx/api/_sidebar.md +165 -0
  621. package/data/uniappx/api/accelerometer.md +322 -0
  622. package/data/uniappx/api/action-sheet.md +192 -0
  623. package/data/uniappx/api/animation-frame.md +125 -0
  624. package/data/uniappx/api/app-route.md +632 -0
  625. package/data/uniappx/api/authentication.md +267 -0
  626. package/data/uniappx/api/base64.md +127 -0
  627. package/data/uniappx/api/bio-auth.md +3 -0
  628. package/data/uniappx/api/calendar.md +400 -0
  629. package/data/uniappx/api/canvas-get-image-data.md +3 -0
  630. package/data/uniappx/api/canvas-put-image-data.md +3 -0
  631. package/data/uniappx/api/canvas-to-temp-file-path.md +62 -0
  632. package/data/uniappx/api/canvasrenderingcontext2d.md +128 -0
  633. package/data/uniappx/api/capture-screen.md +173 -0
  634. package/data/uniappx/api/capturescreen.md +3 -0
  635. package/data/uniappx/api/choose-file.md +174 -0
  636. package/data/uniappx/api/choose-image.md +312 -0
  637. package/data/uniappx/api/choose-location.md +412 -0
  638. package/data/uniappx/api/choose-media.md +272 -0
  639. package/data/uniappx/api/choose-video.md +165 -0
  640. package/data/uniappx/api/clipboard.md +155 -0
  641. package/data/uniappx/api/compass.md +351 -0
  642. package/data/uniappx/api/compress-image.md +147 -0
  643. package/data/uniappx/api/compress-video.md +136 -0
  644. package/data/uniappx/api/connect-event-source.md +225 -0
  645. package/data/uniappx/api/contact.md +153 -0
  646. package/data/uniappx/api/create-camera-context.md +346 -0
  647. package/data/uniappx/api/create-canvas-context-async.md +167 -0
  648. package/data/uniappx/api/create-editor-context-async.md +605 -0
  649. package/data/uniappx/api/create-inner-audio-context.md +704 -0
  650. package/data/uniappx/api/create-intersection-observer.md +195 -0
  651. package/data/uniappx/api/create-interstitial-ad.md +253 -0
  652. package/data/uniappx/api/create-live-player-context.md +185 -0
  653. package/data/uniappx/api/create-live-pusher-context.md +282 -0
  654. package/data/uniappx/api/create-map-context.md +677 -0
  655. package/data/uniappx/api/create-request-permission-listener.md +147 -0
  656. package/data/uniappx/api/create-rewarded-video-ad.md +302 -0
  657. package/data/uniappx/api/create-selector-query.md +609 -0
  658. package/data/uniappx/api/create-video-context.md +190 -0
  659. package/data/uniappx/api/create-webview-context.md +274 -0
  660. package/data/uniappx/api/create-worker.md +607 -0
  661. package/data/uniappx/api/dialog-page.md +377 -0
  662. package/data/uniappx/api/dom/README.md +319 -0
  663. package/data/uniappx/api/dom/cssstyledeclaration.md +341 -0
  664. package/data/uniappx/api/dom/domrect.md +30 -0
  665. package/data/uniappx/api/dom/drawablecontext.md +63 -0
  666. package/data/uniappx/api/dom/element.md +3 -0
  667. package/data/uniappx/api/dom/unicanvaselement.md +29 -0
  668. package/data/uniappx/api/dom/unielement.md +211 -0
  669. package/data/uniappx/api/dom/uniimageelement.md +23 -0
  670. package/data/uniappx/api/dom/uniinputelement.md +25 -0
  671. package/data/uniappx/api/dom/uninativeviewelement.md +18 -0
  672. package/data/uniappx/api/dom/uniresizeobserver.md +20 -0
  673. package/data/uniappx/api/dom/unitextareaelement.md +25 -0
  674. package/data/uniappx/api/dom/unitextelement.md +23 -0
  675. package/data/uniappx/api/dom/univideoelement.md +18 -0
  676. package/data/uniappx/api/dom/uniwebviewelement.md +18 -0
  677. package/data/uniappx/api/download-file.md +226 -0
  678. package/data/uniappx/api/env.md +101 -0
  679. package/data/uniappx/api/event-bus.md +184 -0
  680. package/data/uniappx/api/exit.md +134 -0
  681. package/data/uniappx/api/ext.md +61 -0
  682. package/data/uniappx/api/facial-recognition-meta-info.md +131 -0
  683. package/data/uniappx/api/facial-recognition-verify.md +3 -0
  684. package/data/uniappx/api/file-system-spec.md +223 -0
  685. package/data/uniappx/api/get-accessibility-info.md +113 -0
  686. package/data/uniappx/api/get-app-authorize-setting.md +276 -0
  687. package/data/uniappx/api/get-app-base-info.md +175 -0
  688. package/data/uniappx/api/get-app.md +175 -0
  689. package/data/uniappx/api/get-background-audio-manager.md +509 -0
  690. package/data/uniappx/api/get-battery-info.md +106 -0
  691. package/data/uniappx/api/get-current-pages.md +215 -0
  692. package/data/uniappx/api/get-device-info.md +188 -0
  693. package/data/uniappx/api/get-element-by-id.md +103 -0
  694. package/data/uniappx/api/get-element.md +3 -0
  695. package/data/uniappx/api/get-file-system-manager.md +2351 -0
  696. package/data/uniappx/api/get-image-info.md +143 -0
  697. package/data/uniappx/api/get-launch-options-sync.md +3 -0
  698. package/data/uniappx/api/get-location.md +362 -0
  699. package/data/uniappx/api/get-network-type.md +96 -0
  700. package/data/uniappx/api/get-performance.md +299 -0
  701. package/data/uniappx/api/get-provider.md +3 -0
  702. package/data/uniappx/api/get-recorder-manager.md +408 -0
  703. package/data/uniappx/api/get-system-info.md +527 -0
  704. package/data/uniappx/api/get-system-setting.md +133 -0
  705. package/data/uniappx/api/get-univerify-manager.md +549 -0
  706. package/data/uniappx/api/get-video-info.md +150 -0
  707. package/data/uniappx/api/get-window-info.md +163 -0
  708. package/data/uniappx/api/gyroscope.md +389 -0
  709. package/data/uniappx/api/image.md +40 -0
  710. package/data/uniappx/api/install-apk.md +93 -0
  711. package/data/uniappx/api/interceptor.md +84 -0
  712. package/data/uniappx/api/is-simulator.md +120 -0
  713. package/data/uniappx/api/keyboard.md +194 -0
  714. package/data/uniappx/api/launch.md +200 -0
  715. package/data/uniappx/api/load-font-face.md +206 -0
  716. package/data/uniappx/api/loading.md +186 -0
  717. package/data/uniappx/api/locale.md +74 -0
  718. package/data/uniappx/api/location-change.md +533 -0
  719. package/data/uniappx/api/make-phone-call.md +102 -0
  720. package/data/uniappx/api/memory.md +135 -0
  721. package/data/uniappx/api/modal.md +233 -0
  722. package/data/uniappx/api/navigator-bar-loading.md +122 -0
  723. package/data/uniappx/api/navigator.md +478 -0
  724. package/data/uniappx/api/network-status-change.md +145 -0
  725. package/data/uniappx/api/network-summarize.md +40 -0
  726. package/data/uniappx/api/nodes-info.md +3 -0
  727. package/data/uniappx/api/on-tab-bar-mid-button-tap.md +34 -0
  728. package/data/uniappx/api/open-app-authorize-setting.md +117 -0
  729. package/data/uniappx/api/open-document.md +122 -0
  730. package/data/uniappx/api/open-location.md +154 -0
  731. package/data/uniappx/api/page-scroll-to.md +170 -0
  732. package/data/uniappx/api/path2d.md +48 -0
  733. package/data/uniappx/api/preview-image.md +341 -0
  734. package/data/uniappx/api/privacy.md +232 -0
  735. package/data/uniappx/api/provider.md +329 -0
  736. package/data/uniappx/api/pull-down-refresh.md +154 -0
  737. package/data/uniappx/api/push.md +1 -0
  738. package/data/uniappx/api/report.md +150 -0
  739. package/data/uniappx/api/request-merchant-transfer.md +117 -0
  740. package/data/uniappx/api/request-payment.md +315 -0
  741. package/data/uniappx/api/request-system-permission.md +220 -0
  742. package/data/uniappx/api/request.md +518 -0
  743. package/data/uniappx/api/rpx2px.md +94 -0
  744. package/data/uniappx/api/save-image-to-photos-album.md +115 -0
  745. package/data/uniappx/api/save-video-to-photos-album.md +102 -0
  746. package/data/uniappx/api/scan-code.md +118 -0
  747. package/data/uniappx/api/screen-brightness.md +333 -0
  748. package/data/uniappx/api/set-navigation-bar-color.md +133 -0
  749. package/data/uniappx/api/set-navigation-bar-title.md +117 -0
  750. package/data/uniappx/api/set-tab-bar.md +651 -0
  751. package/data/uniappx/api/set-tabbar.md +3 -0
  752. package/data/uniappx/api/share-with-system.md +139 -0
  753. package/data/uniappx/api/share.md +325 -0
  754. package/data/uniappx/api/show-action-sheet.md +3 -0
  755. package/data/uniappx/api/show-loading.md +3 -0
  756. package/data/uniappx/api/show-modal.md +3 -0
  757. package/data/uniappx/api/show-toast.md +3 -0
  758. package/data/uniappx/api/sign-in.md +358 -0
  759. package/data/uniappx/api/storage.md +719 -0
  760. package/data/uniappx/api/theme-change.md +742 -0
  761. package/data/uniappx/api/theme.md +3 -0
  762. package/data/uniappx/api/toast.md +180 -0
  763. package/data/uniappx/api/uni-push.md +513 -0
  764. package/data/uniappx/api/unicloud/README.md +87 -0
  765. package/data/uniappx/api/unicloud/database.md +1028 -0
  766. package/data/uniappx/api/unicloud/function.md +83 -0
  767. package/data/uniappx/api/unicloud/object.md +138 -0
  768. package/data/uniappx/api/unicloud/sse-channel.md +92 -0
  769. package/data/uniappx/api/unicloud/storage.md +204 -0
  770. package/data/uniappx/api/unicloud/utils.md +153 -0
  771. package/data/uniappx/api/unipage.md +263 -0
  772. package/data/uniappx/api/upload-file.md +233 -0
  773. package/data/uniappx/api/vibrate.md +177 -0
  774. package/data/uniappx/api/virtual-payment.md +517 -0
  775. package/data/uniappx/api/websocket-global.md +3 -0
  776. package/data/uniappx/api/websocket.md +562 -0
  777. package/data/uniappx/api/wide-screen-adaptation.md +433 -0
  778. package/data/uniappx/api/wifi.md +508 -0
  779. package/data/uniappx/api/window.md +88 -0
  780. package/data/uniappx/app-harmony/README.md +74 -0
  781. package/data/uniappx/app-harmony/harmony-vapor.md +3 -0
  782. package/data/uniappx/app-vapor.md +583 -0
  783. package/data/uniappx/benchmark/vapor-benchmark-android.md +483 -0
  784. package/data/uniappx/benchmark/vapor-benchmark-harmony.md +309 -0
  785. package/data/uniappx/benchmark/vapor-benchmark-ios.md +373 -0
  786. package/data/uniappx/collocation/_sidebar.md +15 -0
  787. package/data/uniappx/collocation/app.md +375 -0
  788. package/data/uniappx/collocation/manifest-android.md +1289 -0
  789. package/data/uniappx/collocation/manifest-harmony.md +152 -0
  790. package/data/uniappx/collocation/manifest-ios.md +710 -0
  791. package/data/uniappx/collocation/manifest-modules.md +508 -0
  792. package/data/uniappx/collocation/manifest-splashscreen.md +227 -0
  793. package/data/uniappx/collocation/manifest.md +745 -0
  794. package/data/uniappx/collocation/pagesjson.md +790 -0
  795. package/data/uniappx/collocation/themejson.md +176 -0
  796. package/data/uniappx/compiler/README.md +121 -0
  797. package/data/uniappx/compiler/_sidebar.md +4 -0
  798. package/data/uniappx/component/README.md +206 -0
  799. package/data/uniappx/component/_sidebar.md +118 -0
  800. package/data/uniappx/component/ad-custom.md +29 -0
  801. package/data/uniappx/component/ad.md +124 -0
  802. package/data/uniappx/component/animation-view.md +51 -0
  803. package/data/uniappx/component/aria-component.md +21 -0
  804. package/data/uniappx/component/audio.md +4 -0
  805. package/data/uniappx/component/block.md +26 -0
  806. package/data/uniappx/component/button.md +298 -0
  807. package/data/uniappx/component/camera.md +303 -0
  808. package/data/uniappx/component/canvas.md +230 -0
  809. package/data/uniappx/component/channel-live.md +27 -0
  810. package/data/uniappx/component/channel-video.md +38 -0
  811. package/data/uniappx/component/checkbox-group.md +56 -0
  812. package/data/uniappx/component/checkbox.md +247 -0
  813. package/data/uniappx/component/common.md +637 -0
  814. package/data/uniappx/component/cover-image.md +42 -0
  815. package/data/uniappx/component/cover-view.md +93 -0
  816. package/data/uniappx/component/custom-tab-bar.md +36 -0
  817. package/data/uniappx/component/double-tap-gesture-handler.md +36 -0
  818. package/data/uniappx/component/draggable-sheet.md +31 -0
  819. package/data/uniappx/component/editor.md +329 -0
  820. package/data/uniappx/component/flow-item.md +3 -0
  821. package/data/uniappx/component/force-press-gesture-handler.md +36 -0
  822. package/data/uniappx/component/form.md +378 -0
  823. package/data/uniappx/component/functional-page-navigator.md +43 -0
  824. package/data/uniappx/component/glass-effect-view.md +217 -0
  825. package/data/uniappx/component/grid-builder.md +39 -0
  826. package/data/uniappx/component/grid-view.md +35 -0
  827. package/data/uniappx/component/horizontal-drag-gesture-handler.md +40 -0
  828. package/data/uniappx/component/icon.md +41 -0
  829. package/data/uniappx/component/image.md +264 -0
  830. package/data/uniappx/component/input.md +899 -0
  831. package/data/uniappx/component/keyboard-accessory.md +21 -0
  832. package/data/uniappx/component/label.md +135 -0
  833. package/data/uniappx/component/list-builder.md +36 -0
  834. package/data/uniappx/component/list-item.md +1 -0
  835. package/data/uniappx/component/list-view.md +508 -0
  836. package/data/uniappx/component/live-player.md +267 -0
  837. package/data/uniappx/component/live-pusher.md +343 -0
  838. package/data/uniappx/component/loading.md +309 -0
  839. package/data/uniappx/component/long-press-gesture-handler.md +40 -0
  840. package/data/uniappx/component/map.md +381 -0
  841. package/data/uniappx/component/match-media.md +132 -0
  842. package/data/uniappx/component/movable-area.md +37 -0
  843. package/data/uniappx/component/movable-view.md +157 -0
  844. package/data/uniappx/component/native-component.md +21 -0
  845. package/data/uniappx/component/native-view.md +342 -0
  846. package/data/uniappx/component/navigation-bar.md +44 -0
  847. package/data/uniappx/component/navigator.md +143 -0
  848. package/data/uniappx/component/nested-scroll-body.md +122 -0
  849. package/data/uniappx/component/nested-scroll-header.md +121 -0
  850. package/data/uniappx/component/nested-scroll.md +6 -0
  851. package/data/uniappx/component/official-account.md +21 -0
  852. package/data/uniappx/component/open-container.md +38 -0
  853. package/data/uniappx/component/page-container.md +386 -0
  854. package/data/uniappx/component/page-meta.md +79 -0
  855. package/data/uniappx/component/pan-gesture-handler.md +40 -0
  856. package/data/uniappx/component/picker-view-column.md +3 -0
  857. package/data/uniappx/component/picker-view.md +180 -0
  858. package/data/uniappx/component/picker.md +370 -0
  859. package/data/uniappx/component/progress.md +163 -0
  860. package/data/uniappx/component/radio-group.md +56 -0
  861. package/data/uniappx/component/radio.md +218 -0
  862. package/data/uniappx/component/rich-text.md +244 -0
  863. package/data/uniappx/component/root-portal.md +26 -0
  864. package/data/uniappx/component/scale-gesture-handler.md +45 -0
  865. package/data/uniappx/component/scroll-view.md +556 -0
  866. package/data/uniappx/component/share-element.md +221 -0
  867. package/data/uniappx/component/slider.md +232 -0
  868. package/data/uniappx/component/snapshot.md +30 -0
  869. package/data/uniappx/component/span.md +21 -0
  870. package/data/uniappx/component/sticky-header.md +138 -0
  871. package/data/uniappx/component/sticky-section.md +152 -0
  872. package/data/uniappx/component/sticky.md +6 -0
  873. package/data/uniappx/component/store-home.md +26 -0
  874. package/data/uniappx/component/store-product.md +28 -0
  875. package/data/uniappx/component/swiper-item.md +3 -0
  876. package/data/uniappx/component/swiper.md +344 -0
  877. package/data/uniappx/component/switch.md +183 -0
  878. package/data/uniappx/component/tap-gesture-handler.md +36 -0
  879. package/data/uniappx/component/text.md +384 -0
  880. package/data/uniappx/component/textarea.md +599 -0
  881. package/data/uniappx/component/uni-ui-x/README.md +165 -0
  882. package/data/uniappx/component/uni-ui-x/uni-badge-view.md +260 -0
  883. package/data/uniappx/component/uni-ui-x/uni-collapse-item.md +3 -0
  884. package/data/uniappx/component/uni-ui-x/uni-collapse.md +652 -0
  885. package/data/uniappx/component/uni-ui-x/uni-drag-cell.md +782 -0
  886. package/data/uniappx/component/uni-ui-x/uni-fab-button.md +137 -0
  887. package/data/uniappx/component/uni-ui-x/uni-index-bar.md +224 -0
  888. package/data/uniappx/component/uni-ui-x/uni-link.md +190 -0
  889. package/data/uniappx/component/uni-ui-x/uni-nav-bar.md +173 -0
  890. package/data/uniappx/component/uni-ui-x/uni-number-box.md +234 -0
  891. package/data/uniappx/component/uni-ui-x/uni-rate.md +151 -0
  892. package/data/uniappx/component/uni-ui-x/uni-refresh-box.md +250 -0
  893. package/data/uniappx/component/uni-ui-x/uni-tab-bar.md +3 -0
  894. package/data/uniappx/component/uni-ui-x/uni-tab-content.md +3 -0
  895. package/data/uniappx/component/uni-ui-x/uni-tab-item.md +3 -0
  896. package/data/uniappx/component/uni-ui-x/uni-tab-midbutton.md +3 -0
  897. package/data/uniappx/component/uni-ui-x/uni-tab.md +1203 -0
  898. package/data/uniappx/component/uni-ui-x/uni-time-format.md +213 -0
  899. package/data/uniappx/component/unicloud-db.md +270 -0
  900. package/data/uniappx/component/vertical-drag-gesture-handler.md +40 -0
  901. package/data/uniappx/component/video.md +630 -0
  902. package/data/uniappx/component/view.md +216 -0
  903. package/data/uniappx/component/voip-room.md +43 -0
  904. package/data/uniappx/component/waterflow.md +407 -0
  905. package/data/uniappx/component/web-view.md +449 -0
  906. package/data/uniappx/css/README.md +436 -0
  907. package/data/uniappx/css/_sidebar.md +103 -0
  908. package/data/uniappx/css/align-content.md +338 -0
  909. package/data/uniappx/css/align-items.md +276 -0
  910. package/data/uniappx/css/align-self.md +291 -0
  911. package/data/uniappx/css/animation-composition.md +33 -0
  912. package/data/uniappx/css/animation-delay.md +26 -0
  913. package/data/uniappx/css/animation-direction.md +34 -0
  914. package/data/uniappx/css/animation-duration.md +31 -0
  915. package/data/uniappx/css/animation-fill-mode.md +34 -0
  916. package/data/uniappx/css/animation-iteration-count.md +31 -0
  917. package/data/uniappx/css/animation-name.md +31 -0
  918. package/data/uniappx/css/animation-play-state.md +32 -0
  919. package/data/uniappx/css/animation-range-end.md +26 -0
  920. package/data/uniappx/css/animation-range-start.md +26 -0
  921. package/data/uniappx/css/animation-range.md +34 -0
  922. package/data/uniappx/css/animation-timeline.md +34 -0
  923. package/data/uniappx/css/animation-timing-function.md +45 -0
  924. package/data/uniappx/css/animation.md +36 -0
  925. package/data/uniappx/css/backdrop-filter.md +255 -0
  926. package/data/uniappx/css/background-clip.md +36 -0
  927. package/data/uniappx/css/background-color.md +353 -0
  928. package/data/uniappx/css/background-image.md +152 -0
  929. package/data/uniappx/css/background.md +35 -0
  930. package/data/uniappx/css/border-bottom-color.md +39 -0
  931. package/data/uniappx/css/border-bottom-left-radius.md +33 -0
  932. package/data/uniappx/css/border-bottom-right-radius.md +33 -0
  933. package/data/uniappx/css/border-bottom-style.md +37 -0
  934. package/data/uniappx/css/border-bottom-width.md +44 -0
  935. package/data/uniappx/css/border-bottom.md +201 -0
  936. package/data/uniappx/css/border-color.md +284 -0
  937. package/data/uniappx/css/border-left-color.md +34 -0
  938. package/data/uniappx/css/border-left-style.md +37 -0
  939. package/data/uniappx/css/border-left-width.md +44 -0
  940. package/data/uniappx/css/border-left.md +200 -0
  941. package/data/uniappx/css/border-radius.md +391 -0
  942. package/data/uniappx/css/border-right-color.md +34 -0
  943. package/data/uniappx/css/border-right-style.md +37 -0
  944. package/data/uniappx/css/border-right-width.md +44 -0
  945. package/data/uniappx/css/border-right.md +201 -0
  946. package/data/uniappx/css/border-style.md +271 -0
  947. package/data/uniappx/css/border-top-color.md +34 -0
  948. package/data/uniappx/css/border-top-left-radius.md +33 -0
  949. package/data/uniappx/css/border-top-right-radius.md +33 -0
  950. package/data/uniappx/css/border-top-style.md +37 -0
  951. package/data/uniappx/css/border-top-width.md +44 -0
  952. package/data/uniappx/css/border-top.md +201 -0
  953. package/data/uniappx/css/border-width.md +415 -0
  954. package/data/uniappx/css/border.md +302 -0
  955. package/data/uniappx/css/bottom.md +259 -0
  956. package/data/uniappx/css/box-shadow.md +879 -0
  957. package/data/uniappx/css/box-sizing.md +353 -0
  958. package/data/uniappx/css/color.md +158 -0
  959. package/data/uniappx/css/common/at-rules.md +244 -0
  960. package/data/uniappx/css/common/color.md +40 -0
  961. package/data/uniappx/css/common/function.md +664 -0
  962. package/data/uniappx/css/common/length.md +178 -0
  963. package/data/uniappx/css/common/selector.md +55 -0
  964. package/data/uniappx/css/common/style-isolation.md +215 -0
  965. package/data/uniappx/css/common/variable.md +1 -0
  966. package/data/uniappx/css/direction.md +146 -0
  967. package/data/uniappx/css/display.md +42 -0
  968. package/data/uniappx/css/flex-basis.md +306 -0
  969. package/data/uniappx/css/flex-direction.md +243 -0
  970. package/data/uniappx/css/flex-flow.md +283 -0
  971. package/data/uniappx/css/flex-grow.md +318 -0
  972. package/data/uniappx/css/flex-shrink.md +313 -0
  973. package/data/uniappx/css/flex-wrap.md +259 -0
  974. package/data/uniappx/css/flex.md +216 -0
  975. package/data/uniappx/css/font-family.md +187 -0
  976. package/data/uniappx/css/font-size.md +176 -0
  977. package/data/uniappx/css/font-style.md +139 -0
  978. package/data/uniappx/css/font-weight.md +167 -0
  979. package/data/uniappx/css/height.md +239 -0
  980. package/data/uniappx/css/justify-content.md +286 -0
  981. package/data/uniappx/css/left.md +260 -0
  982. package/data/uniappx/css/letter-spacing.md +149 -0
  983. package/data/uniappx/css/line-height.md +173 -0
  984. package/data/uniappx/css/lines.md +37 -0
  985. package/data/uniappx/css/margin-bottom.md +281 -0
  986. package/data/uniappx/css/margin-left.md +281 -0
  987. package/data/uniappx/css/margin-right.md +278 -0
  988. package/data/uniappx/css/margin-top.md +274 -0
  989. package/data/uniappx/css/margin.md +315 -0
  990. package/data/uniappx/css/max-height.md +242 -0
  991. package/data/uniappx/css/max-width.md +251 -0
  992. package/data/uniappx/css/min-height.md +252 -0
  993. package/data/uniappx/css/min-width.md +243 -0
  994. package/data/uniappx/css/opacity.md +248 -0
  995. package/data/uniappx/css/overflow.md +330 -0
  996. package/data/uniappx/css/padding-bottom.md +241 -0
  997. package/data/uniappx/css/padding-left.md +234 -0
  998. package/data/uniappx/css/padding-right.md +242 -0
  999. package/data/uniappx/css/padding-top.md +234 -0
  1000. package/data/uniappx/css/padding.md +309 -0
  1001. package/data/uniappx/css/pointer-events.md +155 -0
  1002. package/data/uniappx/css/position.md +444 -0
  1003. package/data/uniappx/css/right.md +260 -0
  1004. package/data/uniappx/css/text-align.md +154 -0
  1005. package/data/uniappx/css/text-decoration-color.md +35 -0
  1006. package/data/uniappx/css/text-decoration-line.md +144 -0
  1007. package/data/uniappx/css/text-decoration-style.md +41 -0
  1008. package/data/uniappx/css/text-decoration-thickness.md +39 -0
  1009. package/data/uniappx/css/text-decoration.md +52 -0
  1010. package/data/uniappx/css/text-overflow.md +176 -0
  1011. package/data/uniappx/css/text-shadow.md +146 -0
  1012. package/data/uniappx/css/top.md +258 -0
  1013. package/data/uniappx/css/transform-origin.md +298 -0
  1014. package/data/uniappx/css/transform.md +50 -0
  1015. package/data/uniappx/css/transition-delay.md +253 -0
  1016. package/data/uniappx/css/transition-duration.md +275 -0
  1017. package/data/uniappx/css/transition-property.md +67 -0
  1018. package/data/uniappx/css/transition-timing-function.md +259 -0
  1019. package/data/uniappx/css/transition.md +527 -0
  1020. package/data/uniappx/css/visibility.md +198 -0
  1021. package/data/uniappx/css/white-space.md +162 -0
  1022. package/data/uniappx/css/width.md +300 -0
  1023. package/data/uniappx/css/z-index.md +411 -0
  1024. package/data/uniappx/debug/android-inspector.md +54 -0
  1025. package/data/uniappx/i18n.md +358 -0
  1026. package/data/uniappx/mp/README.md +155 -0
  1027. package/data/uniappx/mp/native-component-and-wxs.md +151 -0
  1028. package/data/uniappx/native/README.md +65 -0
  1029. package/data/uniappx/native/debug/android.md +122 -0
  1030. package/data/uniappx/native/debug/harmony.md +116 -0
  1031. package/data/uniappx/native/debug/ios.md +84 -0
  1032. package/data/uniappx/native/download/android.md +132 -0
  1033. package/data/uniappx/native/download/ios.md +31 -0
  1034. package/data/uniappx/native/modules/android/others.md +1343 -0
  1035. package/data/uniappx/native/modules/android/uni-ad.md +99 -0
  1036. package/data/uniappx/native/modules/android/uni-facialRecognitionVerify.md +69 -0
  1037. package/data/uniappx/native/modules/android/uni-getLocation.md +121 -0
  1038. package/data/uniappx/native/modules/android/uni-map-tencent.md +92 -0
  1039. package/data/uniappx/native/modules/android/uni-oauth.md +57 -0
  1040. package/data/uniappx/native/modules/android/uni-payment.md +110 -0
  1041. package/data/uniappx/native/modules/android/uni-push.md +217 -0
  1042. package/data/uniappx/native/modules/android/uni-share.md +57 -0
  1043. package/data/uniappx/native/modules/android/uni-verify.md +101 -0
  1044. package/data/uniappx/native/modules/android/uni-video.md +125 -0
  1045. package/data/uniappx/native/modules/harmony/facialVerify.md +45 -0
  1046. package/data/uniappx/native/modules/harmony/location.md +43 -0
  1047. package/data/uniappx/native/modules/harmony/map.md +64 -0
  1048. package/data/uniappx/native/modules/harmony/modules.md +23 -0
  1049. package/data/uniappx/native/modules/harmony/oauth.md +47 -0
  1050. package/data/uniappx/native/modules/harmony/pay.md +85 -0
  1051. package/data/uniappx/native/modules/harmony/push.md +74 -0
  1052. package/data/uniappx/native/modules/harmony/verify.md +45 -0
  1053. package/data/uniappx/native/modules/ios/modules.md +943 -0
  1054. package/data/uniappx/native/permission/android_permission_adapter.md +62 -0
  1055. package/data/uniappx/native/use/android.md +521 -0
  1056. package/data/uniappx/native/use/androidcomm.md +104 -0
  1057. package/data/uniappx/native/use/androiduts.md +388 -0
  1058. package/data/uniappx/native/use/harmony.md +99 -0
  1059. package/data/uniappx/native/use/harmonyapi.md +190 -0
  1060. package/data/uniappx/native/use/harmonyuts.md +62 -0
  1061. package/data/uniappx/native/use/ios.md +90 -0
  1062. package/data/uniappx/native/use/iosapi.md +288 -0
  1063. package/data/uniappx/native/use/iosuts.md +87 -0
  1064. package/data/uniappx/page.md +488 -0
  1065. package/data/uniappx/performance.md +175 -0
  1066. package/data/uniappx/plugin/NOTE.md +5 -0
  1067. package/data/uniappx/project.md +148 -0
  1068. package/data/uniappx/readme.md +381 -0
  1069. package/data/uniappx/release-note-alpha.md +2361 -0
  1070. package/data/uniappx/release.md +2224 -0
  1071. package/data/uniappx/sample.md +157 -0
  1072. package/data/uniappx/select/native-render-and-self-render.md +382 -0
  1073. package/data/uniappx/select.md +3 -0
  1074. package/data/uniappx/tutorial/android-16kb.md +91 -0
  1075. package/data/uniappx/tutorial/android-memoryleak.md +542 -0
  1076. package/data/uniappx/tutorial/app-env.md +80 -0
  1077. package/data/uniappx/tutorial/app-market.md +51 -0
  1078. package/data/uniappx/tutorial/app-package.md +195 -0
  1079. package/data/uniappx/tutorial/app-playground.md +188 -0
  1080. package/data/uniappx/tutorial/app-update-wgt.md +9 -0
  1081. package/data/uniappx/tutorial/bug_repair.md +40 -0
  1082. package/data/uniappx/tutorial/codegap.md +223 -0
  1083. package/data/uniappx/tutorial/compatibility.md +119 -0
  1084. package/data/uniappx/tutorial/compliance.md +671 -0
  1085. package/data/uniappx/tutorial/debug/devtools.md +134 -0
  1086. package/data/uniappx/tutorial/idref.md +121 -0
  1087. package/data/uniappx/tutorial/ls-plugin.md +181 -0
  1088. package/data/uniappx/tutorial/request.md +204 -0
  1089. package/data/uniappx/tutorial/rules_mcp.md +121 -0
  1090. package/data/uniappx/tutorial/stickynestlist.md +68 -0
  1091. package/data/uniappx/tutorial/store.md +130 -0
  1092. package/data/uniappx/uniapptox.md +145 -0
  1093. package/data/uniappx/uts/README.md +443 -0
  1094. package/data/uniappx/uts/_sidebar.md +55 -0
  1095. package/data/uniappx/uts/buildin-object-api/array.md +2265 -0
  1096. package/data/uniappx/uts/buildin-object-api/arraybuffer.md +480 -0
  1097. package/data/uniappx/uts/buildin-object-api/console.md +520 -0
  1098. package/data/uniappx/uts/buildin-object-api/dataview.md +853 -0
  1099. package/data/uniappx/uts/buildin-object-api/date.md +1534 -0
  1100. package/data/uniappx/uts/buildin-object-api/error.md +30 -0
  1101. package/data/uniappx/uts/buildin-object-api/float32array.md +581 -0
  1102. package/data/uniappx/uts/buildin-object-api/float64array.md +626 -0
  1103. package/data/uniappx/uts/buildin-object-api/global.md +600 -0
  1104. package/data/uniappx/uts/buildin-object-api/int16array.md +1069 -0
  1105. package/data/uniappx/uts/buildin-object-api/int32array.md +1137 -0
  1106. package/data/uniappx/uts/buildin-object-api/int8array.md +1166 -0
  1107. package/data/uniappx/uts/buildin-object-api/json.md +407 -0
  1108. package/data/uniappx/uts/buildin-object-api/map.md +479 -0
  1109. package/data/uniappx/uts/buildin-object-api/math.md +1525 -0
  1110. package/data/uniappx/uts/buildin-object-api/number.md +852 -0
  1111. package/data/uniappx/uts/buildin-object-api/promise.md +1444 -0
  1112. package/data/uniappx/uts/buildin-object-api/regexp.md +534 -0
  1113. package/data/uniappx/uts/buildin-object-api/set.md +317 -0
  1114. package/data/uniappx/uts/buildin-object-api/string.md +1604 -0
  1115. package/data/uniappx/uts/buildin-object-api/textdecoder.md +133 -0
  1116. package/data/uniappx/uts/buildin-object-api/textencoder.md +60 -0
  1117. package/data/uniappx/uts/buildin-object-api/timers.md +145 -0
  1118. package/data/uniappx/uts/buildin-object-api/uint16array.md +1154 -0
  1119. package/data/uniappx/uts/buildin-object-api/uint32array.md +1165 -0
  1120. package/data/uniappx/uts/buildin-object-api/uint8array.md +1146 -0
  1121. package/data/uniappx/uts/buildin-object-api/uint8clampedarray.md +1147 -0
  1122. package/data/uniappx/uts/buildin-object-api/utsjsonobject.md +1297 -0
  1123. package/data/uniappx/uts/class.md +462 -0
  1124. package/data/uniappx/uts/compiler-known-issues.md +865 -0
  1125. package/data/uniappx/uts/conditional.md +206 -0
  1126. package/data/uniappx/uts/data-type.md +2242 -0
  1127. package/data/uniappx/uts/enumerability.md +15 -0
  1128. package/data/uniappx/uts/enumerability_iterable.md +200 -0
  1129. package/data/uniappx/uts/exception.md +25 -0
  1130. package/data/uniappx/uts/function.md +358 -0
  1131. package/data/uniappx/uts/generics.md +246 -0
  1132. package/data/uniappx/uts/interface.md +35 -0
  1133. package/data/uniappx/uts/iterable.md +137 -0
  1134. package/data/uniappx/uts/keywords.md +393 -0
  1135. package/data/uniappx/uts/literal.md +216 -0
  1136. package/data/uniappx/uts/loops.md +236 -0
  1137. package/data/uniappx/uts/module.md +92 -0
  1138. package/data/uniappx/uts/object.md +155 -0
  1139. package/data/uniappx/uts/operator.md +295 -0
  1140. package/data/uniappx/uts/runtime-known-issues.md +94 -0
  1141. package/data/uniappx/uts/type-aliases.md +43 -0
  1142. package/data/uniappx/uts/type-compatibility.md +133 -0
  1143. package/data/uniappx/uts/uts-optimize.md +33 -0
  1144. package/data/uniappx/uts/uts_diff_ts.md +2443 -0
  1145. package/data/uniappx/uts/utsactivitycallback.md +3099 -0
  1146. package/data/uniappx/uts/utsandroid.md +1461 -0
  1147. package/data/uniappx/uts/utsandroidhookproxy.md +34 -0
  1148. package/data/uniappx/uts/utsharmony.md +348 -0
  1149. package/data/uniappx/uts/utsios.md +466 -0
  1150. package/data/uniappx/uts/utsioshookproxy.md +374 -0
  1151. package/data/uniappx/vapor-benchmark.md +9 -0
  1152. package/data/uniappx/vue/README.md +313 -0
  1153. package/data/uniappx/vue/_sidebar.md +10 -0
  1154. package/data/uniappx/vue/advanced-api.md +253 -0
  1155. package/data/uniappx/vue/built-in.md +2133 -0
  1156. package/data/uniappx/vue/component.md +1134 -0
  1157. package/data/uniappx/vue/composition-api.md +2085 -0
  1158. package/data/uniappx/vue/data-bind.md +463 -0
  1159. package/data/uniappx/vue/global-api.md +307 -0
  1160. package/data/uniappx/vue/modifier.md +249 -0
  1161. package/data/uniappx/vue/options-api.md +1489 -0
  1162. package/data/uniappx/vue/others.md +20 -0
  1163. package/data/uniappx/web/README.md +263 -0
  1164. package/data/uniappx/web/ssr.md +238 -0
  1165. package/data/uniappx/worktile/NOTE.md +5 -0
  1166. package/data/uniappx-doc-index.json +7692 -0
  1167. package/dist/main.mjs +67 -45
  1168. package/package.json +1 -1
@@ -0,0 +1,2351 @@
1
+ ::: sourceCode
2
+ ## uni.getFileSystemManager() @getfilesystemmanager
3
+
4
+ > GitCode: https://gitcode.com/dcloud/uni-api/tree/alpha/uni_modules/uni-fileSystemManager
5
+
6
+ > GitHub: https://github.com/dcloudio/uni-api/tree/alpha/uni_modules/uni-fileSystemManager
7
+
8
+ 获取文件管理器
9
+
10
+ ### getFileSystemManager 兼容性
11
+ | Web | 微信小程序 | Android | iOS | HarmonyOS |
12
+ | :- | :- | :- | :- | :- |
13
+ | <a style="color:unset;" href="https://vote.dcloud.net.cn/#/?name=uni-app%20x">x</a> | 4.41 | 3.9.0 | 4.11 | 4.61 |
14
+
15
+ 文件管理器对象,用于操作应用可访问的本地文件空间,在app平台是应用沙盒目录。
16
+
17
+ 可实现目录和文件的创建、删除、改名或改路径、遍历目录、获取文件信息、读写文件。
18
+
19
+ 注意:
20
+ - `DCloud-`、`DCloud_`、`uni-`、`uni_`开头的目录和文件是保留目录。开发者自用的文件目录需避免使用这些前缀;
21
+
22
+ - 读取文件API受具体设备内存大小限制,为了在老旧设备具备更好的兼容性,请避免一次性读取大文件的情况(建议文件大小不要超过16M);
23
+
24
+ - [ReadFileSuccessResult](./get-file-system-manager.md#readfilesuccessresult-values) 的data参数以前类型是string,Android平台4.31、iOS平台4.61起为了同时支持arraybuffer,类型改成了‘string | ArrayBuffer’,请在使用时手动as为指定类型;
25
+
26
+ - app-ios平台4.11版本之前支持的api仅支持在uvue文件中使用文件管理器对象,uts插件中暂不支持; app-ios平台4.61版本后,所有api都支持在uts插件和uvue文件中使用,具体请查看兼容性;
27
+
28
+ ##### 为了和微信小程序保持一致,`HBuilderX 4.71+` 涉及如下API调整
29
+
30
+ | 相关 API | 升级前 | 升级后 |
31
+ |------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
32
+ | `stat` / `statSync` | - 返回路径是系统绝对路径 | - 返回路径是相对参数path的相对路径 <br> * 微信小程序规则:当 recursive 为 false 时,res.stats 是一个 Stats 对象。当 recursive 为 true 且 path 是一个目录的路径时,res.stats 是一个 Array,数组的每一项是一个对象,每个对象包含 path 和 stats <br> * uniapp-x规则为避免返回值是联合类型,均返回数组,具体优化如下: <br> --- 当 path = 文件路径,返回数组,仅包含本身stats,返回 stats.path= "" <br> --- 当 path = 目录路径 && recursive = false,返回数组,仅包含本身stats,返回 stats.path= "/" <br> --- 当 path = 目录路径 && recursive = true,返回数组,包含本身stats和其递归子文件stats和目录文件stats |
33
+ | `saveFile` / `saveFileSync` | **参数 `filePath`** <br> - 传入nil:默认保存到 `uni.env.USER_DATA_PATH` 目录 <br> - 传入文件路径:如果上一级目录存在,保存到传入的路径,如存在则覆盖;如果上一级目录不存在,上上级目录也不存在,则先递归创建再保存 <br> - 传入目录路径:如果存在,保存到filePath/截取tempFilePath的文件名;如果不存在,先创建再保存 <br> - 传入错误路径:比如无权限的路径,返回 error <br> <br> **返回路径 `savedFilePath`** <br> - 返回绝对路径 | **参数 `filePath`** <br> - 传入nil:默认保存到 `uni.env.CACHE_PATH/uni-store/` 目录 <br> - 传入错误路径:比如无权限的路径,返回 error <br> - 传入文件路径:如果上一级目录存在,保存到传入的路径,如存在则覆盖;如果上一级目录不存在,上上级目录也不存在,则先递归创建再保存 <br> -传入filePath是目录路径且已存在,则返回错误码`1300021` <br> -传入filePath是文件路径且已存在,则覆盖写入 <br>- 判断传入路径尾部是否带斜线,如xxx/path、 xxx/path/,直接视为写入到path文件,如xxx/path/sub.txt 具体的是写入到具体的文件,path是目录 <br> <br> **返回路径 `savedFilePath`** <br> - 使用 `unifile://` 路径, 如果参数filePath=nil, savedFilePath= `unifile://cache/uni-store/xxx`; 否则savedFilePath= `unifile://cache/xxx`/`unifile://usr/xxx`/`unifile://sandbox/xxx` <br> <br> **其他** <br> - 成功保存后删除临时文件 |
34
+ | `getSavedFileList` | 返回 `uni.env.USER_DATA_PATH` 目录中的文件列表, 均绝对路径 | 返回 `unifile://cache/uni-store/`(uni.env.CACHE_PATH/uni-store/) 目录中的文件列表 |
35
+ | `rmdir` / `rmdirSync` | iOS 无法删除空的 `uni.env.USER_DATA_PATH`、`uni.env.CACHE_PATH` 目录(系统限制)<br>Android/Harmony 可删除任意目录 | **删除特殊目录,只删除子,保留本身** <br> - `uni.env.SANDBOX_PATH` <br> - `uni.env.CACHE_PATH` <br> - `uni.env.USER_DATA_PATH` <br> - `uni.env.ANDROID_INTERNAL_SANDBOX_PATH` <br> <br> **其他创建的目录可以删除子和本身** <br> |
36
+ | `copyFile` / `copyFileSync` | **参数 `destPath`** <br> - 传入文件路径:如果上一级目录存在,保存到传入的路径,如存在则覆盖;如果上一级目录不存在,上上级目录也不存在,则先递归创建再保存 <br> - 传入目录路径:如果存在,保存到destPath/截取tempFilePath的文件名;如果不存在,先创建再保存 <br> - 传入错误路径:比如无权限的路径,返回 error <br> | **参数 `destPath`** <br> <br> - 传入错误路径:比如无权限的路径,返回 error <br> - 传入文件路径:如果上一级目录存在,保存到传入的路径,如存在则覆盖;如果上一级目录不存在,上上级目录也不存在,则先递归创建再保存 <br> -传入destPath是目录路径且已存在,则返回错误码`1300021` <br> -传入destPath是文件路径且已存在,则覆盖写入 <br>- 判断传入路径尾部是否带斜线,如xxx/path、 xxx/path/,直接视为写入到path文件,如xxx/path/sub.txt 具体的是写入到具体的文件,path是目录 <br> <br> |
37
+
38
+ ##### iOS 无返回值同步api说明:
39
+ 1. 在uvue中不能依赖无返回值的同步api,因为iOS目前无法在uvue层面捕获失败,仅可用于调试,不能用于运行,try···catch无效,不会进入catch回调;
40
+ 2. 用于调试时:无返回值的同步api可以通过控制台看到具体的失败或成功console log;
41
+ 3. 相关api:writeFileSync、unlinkSync、truncateSync、removeSavedFile、renameSync、rmdirSync、mkdirSync、ftruncateSync、copyFileSync、closeSync、appendFileSync、accessSync
42
+
43
+ ### 返回值
44
+
45
+ | 类型 |
46
+ | :- |
47
+ | [FileSystemManager](#filesystemmanager-values) |
48
+
49
+ #### FileSystemManager 的方法 @filesystemmanager-values
50
+
51
+ #### access(options: AccessOptions): void; @access
52
+ access
53
+ 判断文件/目录是否存在
54
+ ##### access 兼容性
55
+ | Web | 微信小程序 | Android | iOS | HarmonyOS |
56
+ | :- | :- | :- | :- | :- |
57
+ | x | 4.41 | 3.9.0 | 4.11 | 4.61 |
58
+
59
+ ##### 参数
60
+
61
+ | 名称 | 类型 | 必填 | 兼容性 |
62
+ | :- | :- | :- | :-: |
63
+ | options | **AccessOptions** | 是 | Web x(部分支持,见上) |
64
+ | 名称 | 类型 | 必备 | 兼容性 | 描述 |
65
+ | :- | :- | :- | :-: | :- |
66
+ | path | string.URIString | 是 | Web x(部分支持,见上) | 要判断是否存在的文件/目录路径 (本地路径) |
67
+ | success | (res: FileManagerSuccessResult) => void | 否 | Web x(部分支持,见上) | 通用的正确返回结果回调 |
68
+ | fail | (res: [FileSystemManagerFail](#filesystemmanagerfail-values)) => void | 否 | Web x(部分支持,见上) | 通用的错误返回结果回调 |
69
+ | complete | (res: any) => void | 否 | Web x(部分支持,见上) | 通用的结束返回结果回调 |
70
+
71
+ ###### FileSystemManagerFail 的属性值 @filesystemmanagerfail-values
72
+
73
+ | 名称 | 类型 | 必备 | 兼容性 | 描述 |
74
+ | :- | :- | :- | :-: | :- |
75
+ | errCode | number | 是 | Web x(部分支持,见上) | 错误码 |
76
+ | 合法值 | 兼容性 | 描述 |
77
+ | :- | :-: | :- |
78
+ | 1200002 | Web x / Android √ / iOS 4.61 / HarmonyOS 4.61(部分支持,见上) | 类型错误。仅支持 base64 / utf-8 / ascii |
79
+ | 1300002 | Web x / Android √ / iOS 4.11 / HarmonyOS 4.61(部分支持,见上) | 未找到文件 |
80
+ | 1300013 | Web x / Android √ / iOS 4.11 / HarmonyOS 4.61(部分支持,见上) | 无权限 |
81
+ | 1300021 | Web x / Android √ / iOS 4.61 / HarmonyOS 4.61(部分支持,见上) | 是目录 |
82
+ | 1300022 | Web x / Android √ / iOS 4.11 / HarmonyOS 4.61(部分支持,见上) | 参数无效 |
83
+ | 1300066 | Web x / Android √ / iOS 4.11 / HarmonyOS 4.61(部分支持,见上) | 目录非空 |
84
+ | 1301003 | Web x / Android √ / iOS 4.61 / HarmonyOS 4.61(部分支持,见上) | 对目录的非法操作 |
85
+ | 1301005 | Web x / Android √ / iOS 4.11 / HarmonyOS 4.61(部分支持,见上) | 文件已存在 |
86
+ | 1300201 | Web x / Android √ / iOS 4.11 / HarmonyOS 4.61(部分支持,见上) | 系统错误 |
87
+ | 1300202 | Web x / Android √ / iOS 4.61 / HarmonyOS 4.61(部分支持,见上) | 超出文件存储限制的最大尺寸 |
88
+ | 1301111 | Web x / Android 4.13 / iOS x / HarmonyOS 4.61(部分支持,见上) | brotli解压失败 |
89
+ | 1302003 | Web x / Android 4.13 / iOS 4.61 / HarmonyOS 4.61(部分支持,见上) | 标志无效 |
90
+ | 1300009 | Web x / Android 4.13 / iOS 4.61 / HarmonyOS 4.61(部分支持,见上) | 文件描述符错误 |
91
+ | 1300010 | Web x / Android x / iOS x / HarmonyOS 4.61(部分支持,见上) | 重试 |
92
+ | 1300011 | Web x / Android x / iOS 4.61 / HarmonyOS 4.61(部分支持,见上) | 错误的地址 |
93
+ | 1300012 | Web x / Android x / iOS x / HarmonyOS 4.61(部分支持,见上) | 操作阻塞 |
94
+ | 1300015 | Web x / Android x / iOS 4.61 / HarmonyOS 4.61(部分支持,见上) | 未知错误 |
95
+ | 1300014 | Web x / Android x / iOS x / HarmonyOS 4.61(部分支持,见上) | 网络不可达 |
96
+ | 1300016 | Web x / Android x / iOS 4.61 / HarmonyOS 4.61(部分支持,见上) | 不是文件夹 |
97
+ | 1300017 | Web x / Android x / iOS 4.61 / HarmonyOS 4.61(部分支持,见上) | 文本文件繁忙 |
98
+ | 1300018 | Web x / Android x / iOS 4.61 / HarmonyOS 4.61(部分支持,见上) | 文件太大 |
99
+ | 1300019 | Web x / Android x / iOS 4.61 / HarmonyOS 4.61(部分支持,见上) | 只读文件系统 |
100
+ | 1300020 | Web x / Android x / iOS 4.61 / HarmonyOS 4.61(部分支持,见上) | 文件名称太长 |
101
+ | 1300033 | Web x / Android x / iOS x / HarmonyOS 4.61(部分支持,见上) | 过多符号链接 |
102
+ | errSubject | string | 是 | Web x(部分支持,见上) | 统一错误主题(模块)名称 |
103
+ | data | any | 否 | Web x(部分支持,见上) | 错误信息中包含的数据 |
104
+ | cause | Error | 否 | | 源错误信息,可以包含多个错误,详见SourceError |
105
+ | errMsg | string | 是 | Web x(部分支持,见上) | |
106
+
107
+ #### accessSync(path: string): void; @accesssync
108
+ accessSync
109
+ FileSystemManager.access 的同步版本
110
+ ##### accessSync 兼容性
111
+ | Web | 微信小程序 | Android | iOS | HarmonyOS |
112
+ | :- | :- | :- | :- | :- |
113
+ | x | 4.41 | 4.13 | 4.61 | 4.61 |
114
+
115
+ ##### 参数
116
+
117
+ | 名称 | 类型 | 必填 | 兼容性 | 描述 |
118
+ | :- | :- | :- | :-: | :- |
119
+ | path | string | 是 | Web x(部分支持,见上) | 要判断是否存在的文件/目录路径 (本地路径) |
120
+
121
+ #### appendFile(options: AppendFileOptions): void; @appendfile
122
+ appendFile
123
+ 在文件结尾追加内容
124
+ ##### appendFile 兼容性
125
+ | Web | 微信小程序 | Android | iOS | HarmonyOS |
126
+ | :- | :- | :- | :- | :- |
127
+ | x | 4.41 | 4.13 | 4.61 | 4.61 |
128
+
129
+ ##### 参数
130
+
131
+ | 名称 | 类型 | 必填 | 兼容性 |
132
+ | :- | :- | :- | :-: |
133
+ | options | **AppendFileOptions** | 是 | Web x(部分支持,见上) |
134
+ | 名称 | 类型 | 必备 | 兼容性 | 描述 |
135
+ | :- | :- | :- | :-: | :- |
136
+ | filePath | string.URIString | 是 | Web x(部分支持,见上) | 要追加内容的文件路径 (本地路径) |
137
+ | encoding | string | 否 | Web x(部分支持,见上) | 指定写入文件的字符编码<br/>支持:ascii base64 utf-8<br/>只在 data 类型是 String 时有效 |
138
+ @@| 合法值 | 兼容性 | 描述 |
139
+ @@| :- | :-: | :- |
140
+ @@| ascii | Web x(部分支持,见上) | ascii字符编码 |
141
+ @@| base64 | Web x(部分支持,见上) | base64字符编码 |
142
+ @@| utf-8 | Web x(部分支持,见上) | utf-8字符编码,默认值 |
143
+ | data | string \| ArrayBuffer | 是 | Web x / 微信小程序 4.41 / Android 4.31 / iOS 4.61 / HarmonyOS 4.61(部分支持,见上) | 要追加的文本或二进制数据,类型为 String 或 ArrayBuffer,以前类型是string,iOS平台4.61、Android平台4.31及以后支持arraybuffer |
144
+ | success | (res: FileManagerSuccessResult) => void | 否 | Web x(部分支持,见上) | 通用的正确返回结果回调 |
145
+ | fail | (res: [FileSystemManagerFail](#filesystemmanagerfail-values)) => void | 否 | Web x(部分支持,见上) | 通用的错误返回结果回调 |
146
+ | complete | (res: any) => void | 否 | Web x(部分支持,见上) | 通用的结束返回结果回调 |
147
+
148
+ ###### FileSystemManagerFail 的属性值 @filesystemmanagerfail-values
149
+
150
+ | 名称 | 类型 | 必备 | 兼容性 | 描述 |
151
+ | :- | :- | :- | :-: | :- |
152
+ | errCode | number | 是 | Web x(部分支持,见上) | 错误码 |
153
+ | 合法值 | 兼容性 | 描述 |
154
+ | :- | :-: | :- |
155
+ | 1200002 | Web x / Android √ / iOS 4.61 / HarmonyOS 4.61(部分支持,见上) | 类型错误。仅支持 base64 / utf-8 / ascii |
156
+ | 1300002 | Web x / Android √ / iOS 4.11 / HarmonyOS 4.61(部分支持,见上) | 未找到文件 |
157
+ | 1300013 | Web x / Android √ / iOS 4.11 / HarmonyOS 4.61(部分支持,见上) | 无权限 |
158
+ | 1300021 | Web x / Android √ / iOS 4.61 / HarmonyOS 4.61(部分支持,见上) | 是目录 |
159
+ | 1300022 | Web x / Android √ / iOS 4.11 / HarmonyOS 4.61(部分支持,见上) | 参数无效 |
160
+ | 1300066 | Web x / Android √ / iOS 4.11 / HarmonyOS 4.61(部分支持,见上) | 目录非空 |
161
+ | 1301003 | Web x / Android √ / iOS 4.61 / HarmonyOS 4.61(部分支持,见上) | 对目录的非法操作 |
162
+ | 1301005 | Web x / Android √ / iOS 4.11 / HarmonyOS 4.61(部分支持,见上) | 文件已存在 |
163
+ | 1300201 | Web x / Android √ / iOS 4.11 / HarmonyOS 4.61(部分支持,见上) | 系统错误 |
164
+ | 1300202 | Web x / Android √ / iOS 4.61 / HarmonyOS 4.61(部分支持,见上) | 超出文件存储限制的最大尺寸 |
165
+ | 1301111 | Web x / Android 4.13 / iOS x / HarmonyOS 4.61(部分支持,见上) | brotli解压失败 |
166
+ | 1302003 | Web x / Android 4.13 / iOS 4.61 / HarmonyOS 4.61(部分支持,见上) | 标志无效 |
167
+ | 1300009 | Web x / Android 4.13 / iOS 4.61 / HarmonyOS 4.61(部分支持,见上) | 文件描述符错误 |
168
+ | 1300010 | Web x / Android x / iOS x / HarmonyOS 4.61(部分支持,见上) | 重试 |
169
+ | 1300011 | Web x / Android x / iOS 4.61 / HarmonyOS 4.61(部分支持,见上) | 错误的地址 |
170
+ | 1300012 | Web x / Android x / iOS x / HarmonyOS 4.61(部分支持,见上) | 操作阻塞 |
171
+ | 1300015 | Web x / Android x / iOS 4.61 / HarmonyOS 4.61(部分支持,见上) | 未知错误 |
172
+ | 1300014 | Web x / Android x / iOS x / HarmonyOS 4.61(部分支持,见上) | 网络不可达 |
173
+ | 1300016 | Web x / Android x / iOS 4.61 / HarmonyOS 4.61(部分支持,见上) | 不是文件夹 |
174
+ | 1300017 | Web x / Android x / iOS 4.61 / HarmonyOS 4.61(部分支持,见上) | 文本文件繁忙 |
175
+ | 1300018 | Web x / Android x / iOS 4.61 / HarmonyOS 4.61(部分支持,见上) | 文件太大 |
176
+ | 1300019 | Web x / Android x / iOS 4.61 / HarmonyOS 4.61(部分支持,见上) | 只读文件系统 |
177
+ | 1300020 | Web x / Android x / iOS 4.61 / HarmonyOS 4.61(部分支持,见上) | 文件名称太长 |
178
+ | 1300033 | Web x / Android x / iOS x / HarmonyOS 4.61(部分支持,见上) | 过多符号链接 |
179
+ | errSubject | string | 是 | Web x(部分支持,见上) | 统一错误主题(模块)名称 |
180
+ | data | any | 否 | Web x(部分支持,见上) | 错误信息中包含的数据 |
181
+ | cause | Error | 否 | | 源错误信息,可以包含多个错误,详见SourceError |
182
+ | errMsg | string | 是 | Web x(部分支持,见上) | |
183
+
184
+ #### appendFileSync(filePath: string, data: string \| ArrayBuffer, encoding?: string): void; @appendfilesync
185
+ appendFileSync
186
+ FileSystemManager.appendFile 的同步版本
187
+ ##### appendFileSync 兼容性
188
+ | Web | 微信小程序 | Android | iOS | HarmonyOS |
189
+ | :- | :- | :- | :- | :- |
190
+ | x | 4.41 | 4.13 | 4.61 | 4.61 |
191
+
192
+ ##### 参数
193
+
194
+ | 名称 | 类型 | 必填 | 兼容性 | 描述 |
195
+ | :- | :- | :- | :-: | :- |
196
+ | filePath | string | 是 | Web x(部分支持,见上) | 要追加内容的文件路径 (本地路径) |
197
+ | data | string \| ArrayBuffer | 是 | Web x(部分支持,见上) | 要追加的文本或二进制数据,类型为 String 或 ArrayBuffer,Android平台4.31、iOS平台4.61之前前类型是string,Android平台4.31、iOS平台4.61起支持ArrayBuffer |
198
+ | encoding | string | 否 | Web x(部分支持,见上) | 指定写入文件的字符编码支持:ascii base64 utf-8,只在 data 类型是 String 时有效 |
199
+
200
+ #### close(options: CloseOptions): void; @close
201
+ close
202
+ 关闭文件
203
+ ##### close 兼容性
204
+ | Web | 微信小程序 | Android | iOS | HarmonyOS |
205
+ | :- | :- | :- | :- | :- |
206
+ | x | 4.41 | 4.13 | 4.61 | 4.61 |
207
+
208
+ ##### 参数
209
+
210
+ | 名称 | 类型 | 必填 | 兼容性 |
211
+ | :- | :- | :- | :-: |
212
+ | options | **CloseOptions** | 是 | Web x(部分支持,见上) |
213
+ | 名称 | 类型 | 必备 | 兼容性 | 描述 |
214
+ | :- | :- | :- | :-: | :- |
215
+ | fd | string | 是 | Web x(部分支持,见上) | 需要被关闭的文件描述符。fd 通过 FileSystemManager.open 或 FileSystemManager.openSync 接口获得 |
216
+ | success | (res: FileManagerSuccessResult) => void | 否 | Web x(部分支持,见上) | 通用的正确返回结果回调 |
217
+ | fail | (res: [FileSystemManagerFail](#filesystemmanagerfail-values)) => void | 否 | Web x(部分支持,见上) | 通用的错误返回结果回调 |
218
+ | complete | (res: any) => void | 否 | Web x(部分支持,见上) | 通用的结束返回结果回调 |
219
+
220
+ ###### FileSystemManagerFail 的属性值 @filesystemmanagerfail-values
221
+
222
+ | 名称 | 类型 | 必备 | 兼容性 | 描述 |
223
+ | :- | :- | :- | :-: | :- |
224
+ | errCode | number | 是 | Web x(部分支持,见上) | 错误码 |
225
+ | 合法值 | 兼容性 | 描述 |
226
+ | :- | :-: | :- |
227
+ | 1200002 | Web x / Android √ / iOS 4.61 / HarmonyOS 4.61(部分支持,见上) | 类型错误。仅支持 base64 / utf-8 / ascii |
228
+ | 1300002 | Web x / Android √ / iOS 4.11 / HarmonyOS 4.61(部分支持,见上) | 未找到文件 |
229
+ | 1300013 | Web x / Android √ / iOS 4.11 / HarmonyOS 4.61(部分支持,见上) | 无权限 |
230
+ | 1300021 | Web x / Android √ / iOS 4.61 / HarmonyOS 4.61(部分支持,见上) | 是目录 |
231
+ | 1300022 | Web x / Android √ / iOS 4.11 / HarmonyOS 4.61(部分支持,见上) | 参数无效 |
232
+ | 1300066 | Web x / Android √ / iOS 4.11 / HarmonyOS 4.61(部分支持,见上) | 目录非空 |
233
+ | 1301003 | Web x / Android √ / iOS 4.61 / HarmonyOS 4.61(部分支持,见上) | 对目录的非法操作 |
234
+ | 1301005 | Web x / Android √ / iOS 4.11 / HarmonyOS 4.61(部分支持,见上) | 文件已存在 |
235
+ | 1300201 | Web x / Android √ / iOS 4.11 / HarmonyOS 4.61(部分支持,见上) | 系统错误 |
236
+ | 1300202 | Web x / Android √ / iOS 4.61 / HarmonyOS 4.61(部分支持,见上) | 超出文件存储限制的最大尺寸 |
237
+ | 1301111 | Web x / Android 4.13 / iOS x / HarmonyOS 4.61(部分支持,见上) | brotli解压失败 |
238
+ | 1302003 | Web x / Android 4.13 / iOS 4.61 / HarmonyOS 4.61(部分支持,见上) | 标志无效 |
239
+ | 1300009 | Web x / Android 4.13 / iOS 4.61 / HarmonyOS 4.61(部分支持,见上) | 文件描述符错误 |
240
+ | 1300010 | Web x / Android x / iOS x / HarmonyOS 4.61(部分支持,见上) | 重试 |
241
+ | 1300011 | Web x / Android x / iOS 4.61 / HarmonyOS 4.61(部分支持,见上) | 错误的地址 |
242
+ | 1300012 | Web x / Android x / iOS x / HarmonyOS 4.61(部分支持,见上) | 操作阻塞 |
243
+ | 1300015 | Web x / Android x / iOS 4.61 / HarmonyOS 4.61(部分支持,见上) | 未知错误 |
244
+ | 1300014 | Web x / Android x / iOS x / HarmonyOS 4.61(部分支持,见上) | 网络不可达 |
245
+ | 1300016 | Web x / Android x / iOS 4.61 / HarmonyOS 4.61(部分支持,见上) | 不是文件夹 |
246
+ | 1300017 | Web x / Android x / iOS 4.61 / HarmonyOS 4.61(部分支持,见上) | 文本文件繁忙 |
247
+ | 1300018 | Web x / Android x / iOS 4.61 / HarmonyOS 4.61(部分支持,见上) | 文件太大 |
248
+ | 1300019 | Web x / Android x / iOS 4.61 / HarmonyOS 4.61(部分支持,见上) | 只读文件系统 |
249
+ | 1300020 | Web x / Android x / iOS 4.61 / HarmonyOS 4.61(部分支持,见上) | 文件名称太长 |
250
+ | 1300033 | Web x / Android x / iOS x / HarmonyOS 4.61(部分支持,见上) | 过多符号链接 |
251
+ | errSubject | string | 是 | Web x(部分支持,见上) | 统一错误主题(模块)名称 |
252
+ | data | any | 否 | Web x(部分支持,见上) | 错误信息中包含的数据 |
253
+ | cause | Error | 否 | | 源错误信息,可以包含多个错误,详见SourceError |
254
+ | errMsg | string | 是 | Web x(部分支持,见上) | |
255
+
256
+ #### closeSync(options: CloseSyncOptions): void; @closesync
257
+ closeSync
258
+ 同步关闭文件
259
+ ##### closeSync 兼容性
260
+ | Web | 微信小程序 | Android | iOS | HarmonyOS |
261
+ | :- | :- | :- | :- | :- |
262
+ | x | 4.41 | 4.13 | 4.61 | 4.61 |
263
+
264
+ ##### 参数
265
+
266
+ | 名称 | 类型 | 必填 | 兼容性 |
267
+ | :- | :- | :- | :-: |
268
+ | options | **CloseSyncOptions** | 是 | Web x(部分支持,见上) |
269
+ | 名称 | 类型 | 必备 | 兼容性 | 描述 |
270
+ | :- | :- | :- | :-: | :- |
271
+ | fd | string | 是 | Web x(部分支持,见上) | 需要被关闭的文件描述符。fd 通过 FileSystemManager.open 或 FileSystemManager.openSync 接口获得 |
272
+
273
+ #### copyFile(options: CopyFileOptions): void; @copyfile
274
+ copyFile
275
+ 复制文件
276
+ ##### copyFile 兼容性
277
+ | Web | 微信小程序 | Android | iOS | HarmonyOS |
278
+ | :- | :- | :- | :- | :- |
279
+ | x | 4.41 | 4.13 | 4.61 | 4.61 |
280
+
281
+ ##### 参数
282
+
283
+ | 名称 | 类型 | 必填 | 兼容性 |
284
+ | :- | :- | :- | :-: |
285
+ | options | **CopyFileOptions** | 是 | Web x(部分支持,见上) |
286
+ | 名称 | 类型 | 必备 | 兼容性 | 描述 |
287
+ | :- | :- | :- | :-: | :- |
288
+ | srcPath | string.URIString | 是 | Web x(部分支持,见上) | 源文件路径,支持本地路径 |
289
+ | destPath | string.URIString | 是 | Web x(部分支持,见上) | 新文件路径,支持本地路径<br/>- 传入错误路径:比如无权限的路径,返回 error<br/>- 传入文件路径:如果上一级目录存在,保存到传入的路径,如存在则覆盖;如果上一级目录不存在,上上级目录也不存在,则先递归创建再保存<br/>-传入destPath是目录路径且已存在,则返回错误码1300021<br/>-传入destPath是文件路径且已存在,则覆盖写入<br/>- 判断传入路径尾部是否带斜线,如xxx/path、 xxx/path/,直接视为写入到path文件,如xxx/path/sub.txt 具体的是写入到具体的文件,path是目录 |
290
+ | success | (res: FileManagerSuccessResult) => void | 否 | Web x(部分支持,见上) | 通用的正确返回结果回调 |
291
+ | fail | (res: [FileSystemManagerFail](#filesystemmanagerfail-values)) => void | 否 | Web x(部分支持,见上) | 通用的错误返回结果回调 |
292
+ | complete | (res: any) => void | 否 | Web x(部分支持,见上) | 通用的结束返回结果回调 |
293
+
294
+ ###### FileSystemManagerFail 的属性值 @filesystemmanagerfail-values
295
+
296
+ | 名称 | 类型 | 必备 | 兼容性 | 描述 |
297
+ | :- | :- | :- | :-: | :- |
298
+ | errCode | number | 是 | Web x(部分支持,见上) | 错误码 |
299
+ | 合法值 | 兼容性 | 描述 |
300
+ | :- | :-: | :- |
301
+ | 1200002 | Web x / Android √ / iOS 4.61 / HarmonyOS 4.61(部分支持,见上) | 类型错误。仅支持 base64 / utf-8 / ascii |
302
+ | 1300002 | Web x / Android √ / iOS 4.11 / HarmonyOS 4.61(部分支持,见上) | 未找到文件 |
303
+ | 1300013 | Web x / Android √ / iOS 4.11 / HarmonyOS 4.61(部分支持,见上) | 无权限 |
304
+ | 1300021 | Web x / Android √ / iOS 4.61 / HarmonyOS 4.61(部分支持,见上) | 是目录 |
305
+ | 1300022 | Web x / Android √ / iOS 4.11 / HarmonyOS 4.61(部分支持,见上) | 参数无效 |
306
+ | 1300066 | Web x / Android √ / iOS 4.11 / HarmonyOS 4.61(部分支持,见上) | 目录非空 |
307
+ | 1301003 | Web x / Android √ / iOS 4.61 / HarmonyOS 4.61(部分支持,见上) | 对目录的非法操作 |
308
+ | 1301005 | Web x / Android √ / iOS 4.11 / HarmonyOS 4.61(部分支持,见上) | 文件已存在 |
309
+ | 1300201 | Web x / Android √ / iOS 4.11 / HarmonyOS 4.61(部分支持,见上) | 系统错误 |
310
+ | 1300202 | Web x / Android √ / iOS 4.61 / HarmonyOS 4.61(部分支持,见上) | 超出文件存储限制的最大尺寸 |
311
+ | 1301111 | Web x / Android 4.13 / iOS x / HarmonyOS 4.61(部分支持,见上) | brotli解压失败 |
312
+ | 1302003 | Web x / Android 4.13 / iOS 4.61 / HarmonyOS 4.61(部分支持,见上) | 标志无效 |
313
+ | 1300009 | Web x / Android 4.13 / iOS 4.61 / HarmonyOS 4.61(部分支持,见上) | 文件描述符错误 |
314
+ | 1300010 | Web x / Android x / iOS x / HarmonyOS 4.61(部分支持,见上) | 重试 |
315
+ | 1300011 | Web x / Android x / iOS 4.61 / HarmonyOS 4.61(部分支持,见上) | 错误的地址 |
316
+ | 1300012 | Web x / Android x / iOS x / HarmonyOS 4.61(部分支持,见上) | 操作阻塞 |
317
+ | 1300015 | Web x / Android x / iOS 4.61 / HarmonyOS 4.61(部分支持,见上) | 未知错误 |
318
+ | 1300014 | Web x / Android x / iOS x / HarmonyOS 4.61(部分支持,见上) | 网络不可达 |
319
+ | 1300016 | Web x / Android x / iOS 4.61 / HarmonyOS 4.61(部分支持,见上) | 不是文件夹 |
320
+ | 1300017 | Web x / Android x / iOS 4.61 / HarmonyOS 4.61(部分支持,见上) | 文本文件繁忙 |
321
+ | 1300018 | Web x / Android x / iOS 4.61 / HarmonyOS 4.61(部分支持,见上) | 文件太大 |
322
+ | 1300019 | Web x / Android x / iOS 4.61 / HarmonyOS 4.61(部分支持,见上) | 只读文件系统 |
323
+ | 1300020 | Web x / Android x / iOS 4.61 / HarmonyOS 4.61(部分支持,见上) | 文件名称太长 |
324
+ | 1300033 | Web x / Android x / iOS x / HarmonyOS 4.61(部分支持,见上) | 过多符号链接 |
325
+ | errSubject | string | 是 | Web x(部分支持,见上) | 统一错误主题(模块)名称 |
326
+ | data | any | 否 | Web x(部分支持,见上) | 错误信息中包含的数据 |
327
+ | cause | Error | 否 | | 源错误信息,可以包含多个错误,详见SourceError |
328
+ | errMsg | string | 是 | Web x(部分支持,见上) | |
329
+
330
+ #### copyFileSync(srcPath: string, destPath: string): void; @copyfilesync
331
+ copyFileSync
332
+ FileSystemManager.copyFile 的同步版本
333
+ ##### copyFileSync 兼容性
334
+ | Web | 微信小程序 | Android | iOS | HarmonyOS |
335
+ | :- | :- | :- | :- | :- |
336
+ | x | 4.41 | 4.13 | 4.61 | 4.61 |
337
+
338
+ ##### 参数
339
+
340
+ | 名称 | 类型 | 必填 | 兼容性 | 描述 |
341
+ | :- | :- | :- | :-: | :- |
342
+ | srcPath | string | 是 | Web x(部分支持,见上) | 源文件路径,支持本地路径 |
343
+ | destPath | string | 是 | Web x(部分支持,见上) | 新文件路径,支持本地路径 |
344
+
345
+ #### fstat(options: FStatOptions): void; @fstat
346
+ fstat
347
+ 获取文件的状态信息
348
+ ##### fstat 兼容性
349
+ | Web | 微信小程序 | Android | iOS | HarmonyOS |
350
+ | :- | :- | :- | :- | :- |
351
+ | x | 4.41 | 4.13 | 4.61 | 4.61 |
352
+
353
+ ##### 参数
354
+
355
+ | 名称 | 类型 | 必填 | 兼容性 |
356
+ | :- | :- | :- | :-: |
357
+ | options | **FStatOptions** | 是 | Web x(部分支持,见上) |
358
+ | 名称 | 类型 | 必备 | 兼容性 | 描述 |
359
+ | :- | :- | :- | :-: | :- |
360
+ | fd | string | 是 | Web x(部分支持,见上) | 文件描述符。fd 通过 FileSystemManager.open 或 FileSystemManager.openSync 接口获得 |
361
+ | success | (res: [FStatSuccessResult](#fstatsuccessresult-values)) => void | 否 | Web x(部分支持,见上) | 接口调用的回调函数 |
362
+ | fail | (res: [FileSystemManagerFail](#filesystemmanagerfail-values)) => void | 否 | Web x(部分支持,见上) | 通用的错误返回结果回调 |
363
+ | complete | (res: any) => void | 否 | Web x(部分支持,见上) | 通用的结束返回结果回调 |
364
+
365
+ ###### FStatSuccessResult 的属性值 @fstatsuccessresult-values
366
+
367
+ | 名称 | 类型 | 必备 | 兼容性 | 描述 |
368
+ | :- | :- | :- | :-: | :- |
369
+ | stats | [Stats](#stats-values) | 是 | Web x(部分支持,见上) | Stats 对象,包含了文件的状态信息 |
370
+ | 名称 | 类型 | 必备 | 兼容性 | 描述 |
371
+ | :- | :- | :- | :-: | :- |
372
+ | mode | number | 是 | Web x(部分支持,见上) | 文件的类型和存取的权限,对应 POSIX stat.st_mode<br/>注意android中,文件类型只包含是否是目录与文件,<br/>另外在android中这里的权限指的是当前进程对文件或者文件夹是否有读,写,执行的权限,<br/>这里没有与 POSIX stat.st_mode对应的组,其他人等相关权限的数据返回,只有所有者的相关权限 |
373
+ | size | number | 是 | Web x(部分支持,见上) | 文件大小,单位:B,对应 POSIX stat.st_size |
374
+ | lastAccessedTime | number | 是 | Web x(部分支持,见上) | 文件最近一次被存取或被执行的时间,UNIX 时间戳,对应 POSIX stat.st_atime<br/>注意:android中由于系统限制无法获取该数据 |
375
+ | lastModifiedTime | number | 是 | Web x(部分支持,见上) | 文件最后一次被修改的时间,UNIX 时间戳,对应 POSIX stat.st_mtime |
376
+
377
+ ###### Stats 的方法 @stats-values
378
+
379
+ ###### isDirectory(): boolean; @isdirectory
380
+ isDirectory
381
+ 判断当前文件是否一个目录
382
+ ###### isDirectory 兼容性
383
+ | Web | 微信小程序 | Android | iOS | HarmonyOS |
384
+ | :- | :- | :- | :- | :- |
385
+ | x | 4.41 | 4.31 | 4.11 | 4.61 |
386
+
387
+ ###### 返回值
388
+
389
+ | 类型 |
390
+ | :- |
391
+ | boolean |
392
+
393
+
394
+ ###### isFile(): boolean; @isfile
395
+ isFile
396
+ 判断当前文件是否一个普通文件
397
+ ###### isFile 兼容性
398
+ | Web | 微信小程序 | Android | iOS | HarmonyOS |
399
+ | :- | :- | :- | :- | :- |
400
+ | x | 4.41 | 4.31 | 4.11 | 4.61 |
401
+
402
+ ###### 返回值
403
+
404
+ | 类型 |
405
+ | :- |
406
+ | boolean |
407
+
408
+
409
+ ###### FileSystemManagerFail 的属性值 @filesystemmanagerfail-values
410
+
411
+ | 名称 | 类型 | 必备 | 兼容性 | 描述 |
412
+ | :- | :- | :- | :-: | :- |
413
+ | errCode | number | 是 | Web x(部分支持,见上) | 错误码 |
414
+ | 合法值 | 兼容性 | 描述 |
415
+ | :- | :-: | :- |
416
+ | 1200002 | Web x / Android √ / iOS 4.61 / HarmonyOS 4.61(部分支持,见上) | 类型错误。仅支持 base64 / utf-8 / ascii |
417
+ | 1300002 | Web x / Android √ / iOS 4.11 / HarmonyOS 4.61(部分支持,见上) | 未找到文件 |
418
+ | 1300013 | Web x / Android √ / iOS 4.11 / HarmonyOS 4.61(部分支持,见上) | 无权限 |
419
+ | 1300021 | Web x / Android √ / iOS 4.61 / HarmonyOS 4.61(部分支持,见上) | 是目录 |
420
+ | 1300022 | Web x / Android √ / iOS 4.11 / HarmonyOS 4.61(部分支持,见上) | 参数无效 |
421
+ | 1300066 | Web x / Android √ / iOS 4.11 / HarmonyOS 4.61(部分支持,见上) | 目录非空 |
422
+ | 1301003 | Web x / Android √ / iOS 4.61 / HarmonyOS 4.61(部分支持,见上) | 对目录的非法操作 |
423
+ | 1301005 | Web x / Android √ / iOS 4.11 / HarmonyOS 4.61(部分支持,见上) | 文件已存在 |
424
+ | 1300201 | Web x / Android √ / iOS 4.11 / HarmonyOS 4.61(部分支持,见上) | 系统错误 |
425
+ | 1300202 | Web x / Android √ / iOS 4.61 / HarmonyOS 4.61(部分支持,见上) | 超出文件存储限制的最大尺寸 |
426
+ | 1301111 | Web x / Android 4.13 / iOS x / HarmonyOS 4.61(部分支持,见上) | brotli解压失败 |
427
+ | 1302003 | Web x / Android 4.13 / iOS 4.61 / HarmonyOS 4.61(部分支持,见上) | 标志无效 |
428
+ | 1300009 | Web x / Android 4.13 / iOS 4.61 / HarmonyOS 4.61(部分支持,见上) | 文件描述符错误 |
429
+ | 1300010 | Web x / Android x / iOS x / HarmonyOS 4.61(部分支持,见上) | 重试 |
430
+ | 1300011 | Web x / Android x / iOS 4.61 / HarmonyOS 4.61(部分支持,见上) | 错误的地址 |
431
+ | 1300012 | Web x / Android x / iOS x / HarmonyOS 4.61(部分支持,见上) | 操作阻塞 |
432
+ | 1300015 | Web x / Android x / iOS 4.61 / HarmonyOS 4.61(部分支持,见上) | 未知错误 |
433
+ | 1300014 | Web x / Android x / iOS x / HarmonyOS 4.61(部分支持,见上) | 网络不可达 |
434
+ | 1300016 | Web x / Android x / iOS 4.61 / HarmonyOS 4.61(部分支持,见上) | 不是文件夹 |
435
+ | 1300017 | Web x / Android x / iOS 4.61 / HarmonyOS 4.61(部分支持,见上) | 文本文件繁忙 |
436
+ | 1300018 | Web x / Android x / iOS 4.61 / HarmonyOS 4.61(部分支持,见上) | 文件太大 |
437
+ | 1300019 | Web x / Android x / iOS 4.61 / HarmonyOS 4.61(部分支持,见上) | 只读文件系统 |
438
+ | 1300020 | Web x / Android x / iOS 4.61 / HarmonyOS 4.61(部分支持,见上) | 文件名称太长 |
439
+ | 1300033 | Web x / Android x / iOS x / HarmonyOS 4.61(部分支持,见上) | 过多符号链接 |
440
+ | errSubject | string | 是 | Web x(部分支持,见上) | 统一错误主题(模块)名称 |
441
+ | data | any | 否 | Web x(部分支持,见上) | 错误信息中包含的数据 |
442
+ | cause | Error | 否 | | 源错误信息,可以包含多个错误,详见SourceError |
443
+ | errMsg | string | 是 | Web x(部分支持,见上) | |
444
+
445
+ #### fstatSync(options: FStatSyncOptions): Stats; @fstatsync
446
+ fstatSync
447
+ 同步获取文件的状态信息
448
+ ##### fstatSync 兼容性
449
+ | Web | 微信小程序 | Android | iOS | HarmonyOS |
450
+ | :- | :- | :- | :- | :- |
451
+ | x | 4.41 | 4.13 | 4.61 | 4.61 |
452
+
453
+ ##### 参数
454
+
455
+ | 名称 | 类型 | 必填 | 兼容性 |
456
+ | :- | :- | :- | :-: |
457
+ | options | **FStatSyncOptions** | 是 | Web x(部分支持,见上) |
458
+ | 名称 | 类型 | 必备 | 兼容性 | 描述 |
459
+ | :- | :- | :- | :-: | :- |
460
+ | fd | string | 是 | Web x(部分支持,见上) | 文件描述符。fd 通过 FileSystemManager.open 或 FileSystemManager.openSync 接口获得 |
461
+
462
+ ##### 返回值
463
+
464
+ | 类型 |
465
+ | :- |
466
+ | [Stats](#stats-values) |
467
+ | 名称 | 类型 | 必备 | 兼容性 | 描述 |
468
+ | :- | :- | :- | :-: | :- |
469
+ | mode | number | 是 | Web x(部分支持,见上) | 文件的类型和存取的权限,对应 POSIX stat.st_mode<br/>注意android中,文件类型只包含是否是目录与文件,<br/>另外在android中这里的权限指的是当前进程对文件或者文件夹是否有读,写,执行的权限,<br/>这里没有与 POSIX stat.st_mode对应的组,其他人等相关权限的数据返回,只有所有者的相关权限 |
470
+ | size | number | 是 | Web x(部分支持,见上) | 文件大小,单位:B,对应 POSIX stat.st_size |
471
+ | lastAccessedTime | number | 是 | Web x(部分支持,见上) | 文件最近一次被存取或被执行的时间,UNIX 时间戳,对应 POSIX stat.st_atime<br/>注意:android中由于系统限制无法获取该数据 |
472
+ | lastModifiedTime | number | 是 | Web x(部分支持,见上) | 文件最后一次被修改的时间,UNIX 时间戳,对应 POSIX stat.st_mtime |
473
+ ###### Stats 的方法 @stats-values
474
+
475
+ ###### isDirectory(): boolean; @isdirectory
476
+ isDirectory
477
+ 判断当前文件是否一个目录
478
+ ###### isDirectory 兼容性
479
+ | Web | 微信小程序 | Android | iOS | HarmonyOS |
480
+ | :- | :- | :- | :- | :- |
481
+ | x | 4.41 | 4.31 | 4.11 | 4.61 |
482
+
483
+ ###### 返回值
484
+
485
+ | 类型 |
486
+ | :- |
487
+ | boolean |
488
+
489
+
490
+ ###### isFile(): boolean; @isfile
491
+ isFile
492
+ 判断当前文件是否一个普通文件
493
+ ###### isFile 兼容性
494
+ | Web | 微信小程序 | Android | iOS | HarmonyOS |
495
+ | :- | :- | :- | :- | :- |
496
+ | x | 4.41 | 4.31 | 4.11 | 4.61 |
497
+
498
+ ###### 返回值
499
+
500
+ | 类型 |
501
+ | :- |
502
+ | boolean |
503
+
504
+
505
+
506
+ #### ftruncate(options: FTruncateFileOptions): void; @ftruncate
507
+ ftruncate
508
+ 对文件内容进行截断操作
509
+ ##### ftruncate 兼容性
510
+ | Web | 微信小程序 | Android | iOS | HarmonyOS |
511
+ | :- | :- | :- | :- | :- |
512
+ | x | 4.41 | 4.13 | 4.61 | 4.61 |
513
+
514
+ ##### 参数
515
+
516
+ | 名称 | 类型 | 必填 | 兼容性 |
517
+ | :- | :- | :- | :-: |
518
+ | options | **FTruncateFileOptions** | 是 | Web x(部分支持,见上) |
519
+ | 名称 | 类型 | 必备 | 兼容性 | 描述 |
520
+ | :- | :- | :- | :-: | :- |
521
+ | fd | string | 是 | Web x(部分支持,见上) | 文件描述符。fd 通过 FileSystemManager.open 或 FileSystemManager.openSync 接口获得 |
522
+ | length | number | 是 | Web x(部分支持,见上) | 截断位置,默认0。如果 length 小于文件长度(字节),则只有前面 length 个字节会保留在文件中,其余内容会被删除;<br/>如果 length 大于文件长度,不做处理 |
523
+ | success | (res: FileManagerSuccessResult) => void | 否 | Web x(部分支持,见上) | 通用的正确返回结果回调 |
524
+ | fail | (res: [FileSystemManagerFail](#filesystemmanagerfail-values)) => void | 否 | Web x(部分支持,见上) | 通用的错误返回结果回调 |
525
+ | complete | (res: any) => void | 否 | Web x(部分支持,见上) | 通用的结束返回结果回调 |
526
+
527
+ ###### FileSystemManagerFail 的属性值 @filesystemmanagerfail-values
528
+
529
+ | 名称 | 类型 | 必备 | 兼容性 | 描述 |
530
+ | :- | :- | :- | :-: | :- |
531
+ | errCode | number | 是 | Web x(部分支持,见上) | 错误码 |
532
+ | 合法值 | 兼容性 | 描述 |
533
+ | :- | :-: | :- |
534
+ | 1200002 | Web x / Android √ / iOS 4.61 / HarmonyOS 4.61(部分支持,见上) | 类型错误。仅支持 base64 / utf-8 / ascii |
535
+ | 1300002 | Web x / Android √ / iOS 4.11 / HarmonyOS 4.61(部分支持,见上) | 未找到文件 |
536
+ | 1300013 | Web x / Android √ / iOS 4.11 / HarmonyOS 4.61(部分支持,见上) | 无权限 |
537
+ | 1300021 | Web x / Android √ / iOS 4.61 / HarmonyOS 4.61(部分支持,见上) | 是目录 |
538
+ | 1300022 | Web x / Android √ / iOS 4.11 / HarmonyOS 4.61(部分支持,见上) | 参数无效 |
539
+ | 1300066 | Web x / Android √ / iOS 4.11 / HarmonyOS 4.61(部分支持,见上) | 目录非空 |
540
+ | 1301003 | Web x / Android √ / iOS 4.61 / HarmonyOS 4.61(部分支持,见上) | 对目录的非法操作 |
541
+ | 1301005 | Web x / Android √ / iOS 4.11 / HarmonyOS 4.61(部分支持,见上) | 文件已存在 |
542
+ | 1300201 | Web x / Android √ / iOS 4.11 / HarmonyOS 4.61(部分支持,见上) | 系统错误 |
543
+ | 1300202 | Web x / Android √ / iOS 4.61 / HarmonyOS 4.61(部分支持,见上) | 超出文件存储限制的最大尺寸 |
544
+ | 1301111 | Web x / Android 4.13 / iOS x / HarmonyOS 4.61(部分支持,见上) | brotli解压失败 |
545
+ | 1302003 | Web x / Android 4.13 / iOS 4.61 / HarmonyOS 4.61(部分支持,见上) | 标志无效 |
546
+ | 1300009 | Web x / Android 4.13 / iOS 4.61 / HarmonyOS 4.61(部分支持,见上) | 文件描述符错误 |
547
+ | 1300010 | Web x / Android x / iOS x / HarmonyOS 4.61(部分支持,见上) | 重试 |
548
+ | 1300011 | Web x / Android x / iOS 4.61 / HarmonyOS 4.61(部分支持,见上) | 错误的地址 |
549
+ | 1300012 | Web x / Android x / iOS x / HarmonyOS 4.61(部分支持,见上) | 操作阻塞 |
550
+ | 1300015 | Web x / Android x / iOS 4.61 / HarmonyOS 4.61(部分支持,见上) | 未知错误 |
551
+ | 1300014 | Web x / Android x / iOS x / HarmonyOS 4.61(部分支持,见上) | 网络不可达 |
552
+ | 1300016 | Web x / Android x / iOS 4.61 / HarmonyOS 4.61(部分支持,见上) | 不是文件夹 |
553
+ | 1300017 | Web x / Android x / iOS 4.61 / HarmonyOS 4.61(部分支持,见上) | 文本文件繁忙 |
554
+ | 1300018 | Web x / Android x / iOS 4.61 / HarmonyOS 4.61(部分支持,见上) | 文件太大 |
555
+ | 1300019 | Web x / Android x / iOS 4.61 / HarmonyOS 4.61(部分支持,见上) | 只读文件系统 |
556
+ | 1300020 | Web x / Android x / iOS 4.61 / HarmonyOS 4.61(部分支持,见上) | 文件名称太长 |
557
+ | 1300033 | Web x / Android x / iOS x / HarmonyOS 4.61(部分支持,见上) | 过多符号链接 |
558
+ | errSubject | string | 是 | Web x(部分支持,见上) | 统一错误主题(模块)名称 |
559
+ | data | any | 否 | Web x(部分支持,见上) | 错误信息中包含的数据 |
560
+ | cause | Error | 否 | | 源错误信息,可以包含多个错误,详见SourceError |
561
+ | errMsg | string | 是 | Web x(部分支持,见上) | |
562
+
563
+ #### ftruncateSync(options: FTruncateFileSyncOptions): void; @ftruncatesync
564
+ ftruncateSync
565
+ 同步对文件内容进行截断操作
566
+ ##### ftruncateSync 兼容性
567
+ | Web | 微信小程序 | Android | iOS | HarmonyOS |
568
+ | :- | :- | :- | :- | :- |
569
+ | x | 4.41 | 4.13 | 4.61 | 4.61 |
570
+
571
+ ##### 参数
572
+
573
+ | 名称 | 类型 | 必填 | 兼容性 |
574
+ | :- | :- | :- | :-: |
575
+ | options | **FTruncateFileSyncOptions** | 是 | Web x(部分支持,见上) |
576
+ | 名称 | 类型 | 必备 | 兼容性 | 描述 |
577
+ | :- | :- | :- | :-: | :- |
578
+ | fd | string | 是 | Web x(部分支持,见上) | 文件描述符。fd 通过 FileSystemManager.open 或 FileSystemManager.openSync 接口获得 |
579
+ | length | number | 是 | Web x(部分支持,见上) | 截断位置,默认0。如果 length 小于文件长度(字节),则只有前面 length 个字节会保留在文件中,其余内容会被删除;<br/>如果 length 大于文件长度,不做处理 |
580
+
581
+ #### getFileInfo(options: GetFileInfoOptions): void; @getfileinfo
582
+ getFileInfo
583
+ 获取该本地临时文件 或 本地缓存文件 信息
584
+ ##### getFileInfo 兼容性
585
+ | Web | 微信小程序 | Android | iOS | HarmonyOS |
586
+ | :- | :- | :- | :- | :- |
587
+ | x | 4.41 | 3.9.0 | 4.11 | 4.61 |
588
+
589
+ ##### 参数
590
+
591
+ | 名称 | 类型 | 必填 | 兼容性 |
592
+ | :- | :- | :- | :-: |
593
+ | options | **GetFileInfoOptions** | 是 | Web x(部分支持,见上) |
594
+ | 名称 | 类型 | 必备 | 兼容性 | 描述 |
595
+ | :- | :- | :- | :-: | :- |
596
+ | filePath | string.URIString | 是 | Web x(部分支持,见上) | 要读取的文件路径 (本地路径) |
597
+ | digestAlgorithm | string | 否 | Web x(部分支持,见上) | 计算文件摘要的算法 |
598
+ @@| 合法值 | 兼容性 | 描述 |
599
+ @@| :- | :-: | :- |
600
+ @@| md5 | Web x(部分支持,见上) | md5 算法 |
601
+ @@| sha1 | Web x(部分支持,见上) | sha1 算法 |
602
+ | success | (res: [GetFileInfoSuccessResult](#getfileinfosuccessresult-values)) => void | 否 | Web x(部分支持,见上) | 接口调用的回调函数 |
603
+ | fail | (res: [FileSystemManagerFail](#filesystemmanagerfail-values)) => void | 否 | Web x(部分支持,见上) | 通用的错误返回结果回调 |
604
+ | complete | (res: any) => void | 否 | Web x(部分支持,见上) | 通用的结束返回结果回调 |
605
+
606
+ ###### GetFileInfoSuccessResult 的属性值 @getfileinfosuccessresult-values
607
+
608
+ | 名称 | 类型 | 必备 | 兼容性 | 描述 |
609
+ | :- | :- | :- | :-: | :- |
610
+ | digest | string | 是 | Web x(部分支持,见上) | 按照传入的 digestAlgorithm 计算得出的的文件摘要 |
611
+ | size | number | 是 | Web x(部分支持,见上) | 文件大小,以字节为单位 |
612
+
613
+ ###### FileSystemManagerFail 的属性值 @filesystemmanagerfail-values
614
+
615
+ | 名称 | 类型 | 必备 | 兼容性 | 描述 |
616
+ | :- | :- | :- | :-: | :- |
617
+ | errCode | number | 是 | Web x(部分支持,见上) | 错误码 |
618
+ | 合法值 | 兼容性 | 描述 |
619
+ | :- | :-: | :- |
620
+ | 1200002 | Web x / Android √ / iOS 4.61 / HarmonyOS 4.61(部分支持,见上) | 类型错误。仅支持 base64 / utf-8 / ascii |
621
+ | 1300002 | Web x / Android √ / iOS 4.11 / HarmonyOS 4.61(部分支持,见上) | 未找到文件 |
622
+ | 1300013 | Web x / Android √ / iOS 4.11 / HarmonyOS 4.61(部分支持,见上) | 无权限 |
623
+ | 1300021 | Web x / Android √ / iOS 4.61 / HarmonyOS 4.61(部分支持,见上) | 是目录 |
624
+ | 1300022 | Web x / Android √ / iOS 4.11 / HarmonyOS 4.61(部分支持,见上) | 参数无效 |
625
+ | 1300066 | Web x / Android √ / iOS 4.11 / HarmonyOS 4.61(部分支持,见上) | 目录非空 |
626
+ | 1301003 | Web x / Android √ / iOS 4.61 / HarmonyOS 4.61(部分支持,见上) | 对目录的非法操作 |
627
+ | 1301005 | Web x / Android √ / iOS 4.11 / HarmonyOS 4.61(部分支持,见上) | 文件已存在 |
628
+ | 1300201 | Web x / Android √ / iOS 4.11 / HarmonyOS 4.61(部分支持,见上) | 系统错误 |
629
+ | 1300202 | Web x / Android √ / iOS 4.61 / HarmonyOS 4.61(部分支持,见上) | 超出文件存储限制的最大尺寸 |
630
+ | 1301111 | Web x / Android 4.13 / iOS x / HarmonyOS 4.61(部分支持,见上) | brotli解压失败 |
631
+ | 1302003 | Web x / Android 4.13 / iOS 4.61 / HarmonyOS 4.61(部分支持,见上) | 标志无效 |
632
+ | 1300009 | Web x / Android 4.13 / iOS 4.61 / HarmonyOS 4.61(部分支持,见上) | 文件描述符错误 |
633
+ | 1300010 | Web x / Android x / iOS x / HarmonyOS 4.61(部分支持,见上) | 重试 |
634
+ | 1300011 | Web x / Android x / iOS 4.61 / HarmonyOS 4.61(部分支持,见上) | 错误的地址 |
635
+ | 1300012 | Web x / Android x / iOS x / HarmonyOS 4.61(部分支持,见上) | 操作阻塞 |
636
+ | 1300015 | Web x / Android x / iOS 4.61 / HarmonyOS 4.61(部分支持,见上) | 未知错误 |
637
+ | 1300014 | Web x / Android x / iOS x / HarmonyOS 4.61(部分支持,见上) | 网络不可达 |
638
+ | 1300016 | Web x / Android x / iOS 4.61 / HarmonyOS 4.61(部分支持,见上) | 不是文件夹 |
639
+ | 1300017 | Web x / Android x / iOS 4.61 / HarmonyOS 4.61(部分支持,见上) | 文本文件繁忙 |
640
+ | 1300018 | Web x / Android x / iOS 4.61 / HarmonyOS 4.61(部分支持,见上) | 文件太大 |
641
+ | 1300019 | Web x / Android x / iOS 4.61 / HarmonyOS 4.61(部分支持,见上) | 只读文件系统 |
642
+ | 1300020 | Web x / Android x / iOS 4.61 / HarmonyOS 4.61(部分支持,见上) | 文件名称太长 |
643
+ | 1300033 | Web x / Android x / iOS x / HarmonyOS 4.61(部分支持,见上) | 过多符号链接 |
644
+ | errSubject | string | 是 | Web x(部分支持,见上) | 统一错误主题(模块)名称 |
645
+ | data | any | 否 | Web x(部分支持,见上) | 错误信息中包含的数据 |
646
+ | cause | Error | 否 | | 源错误信息,可以包含多个错误,详见SourceError |
647
+ | errMsg | string | 是 | Web x(部分支持,见上) | |
648
+
649
+ #### getSavedFileList(options: GetSavedFileListOptions): void; @getsavedfilelist
650
+ getSavedFileList
651
+ 获取该已保存的本地缓存文件列表
652
+ ##### getSavedFileList 兼容性
653
+ | Web | 微信小程序 | Android | iOS | HarmonyOS |
654
+ | :- | :- | :- | :- | :- |
655
+ | x | 4.41 | 4.13 | 4.61 | 4.61 |
656
+
657
+ ##### 参数
658
+
659
+ | 名称 | 类型 | 必填 | 兼容性 |
660
+ | :- | :- | :- | :-: |
661
+ | options | **GetSavedFileListOptions** | 是 | Web x(部分支持,见上) |
662
+ | 名称 | 类型 | 必备 | 兼容性 | 描述 |
663
+ | :- | :- | :- | :-: | :- |
664
+ | success | (res: [GetSavedFileListResult](#getsavedfilelistresult-values)) => void | 否 | Web x(部分支持,见上) | 接口调用的回调函数 |
665
+ | fail | (res: [FileSystemManagerFail](#filesystemmanagerfail-values)) => void | 否 | Web x(部分支持,见上) | 通用的错误返回结果回调 |
666
+ | complete | (res: any) => void | 否 | Web x(部分支持,见上) | 通用的结束返回结果回调 |
667
+
668
+ ###### GetSavedFileListResult 的属性值 @getsavedfilelistresult-values
669
+
670
+ | 名称 | 类型 | 必备 | 兼容性 | 描述 |
671
+ | :- | :- | :- | :-: | :- |
672
+ | fileList | Array&lt;string&gt; | 是 | Web x(部分支持,见上) | 文件数组。自 `4.71` 起,返回 `unifile://` 协议的路径<br/>返回 `unifile://cache/uni-store/` (uni.env.CACHE_PATH/uni-store/) 目录中的文件列表 |
673
+
674
+ ###### FileSystemManagerFail 的属性值 @filesystemmanagerfail-values
675
+
676
+ | 名称 | 类型 | 必备 | 兼容性 | 描述 |
677
+ | :- | :- | :- | :-: | :- |
678
+ | errCode | number | 是 | Web x(部分支持,见上) | 错误码 |
679
+ | 合法值 | 兼容性 | 描述 |
680
+ | :- | :-: | :- |
681
+ | 1200002 | Web x / Android √ / iOS 4.61 / HarmonyOS 4.61(部分支持,见上) | 类型错误。仅支持 base64 / utf-8 / ascii |
682
+ | 1300002 | Web x / Android √ / iOS 4.11 / HarmonyOS 4.61(部分支持,见上) | 未找到文件 |
683
+ | 1300013 | Web x / Android √ / iOS 4.11 / HarmonyOS 4.61(部分支持,见上) | 无权限 |
684
+ | 1300021 | Web x / Android √ / iOS 4.61 / HarmonyOS 4.61(部分支持,见上) | 是目录 |
685
+ | 1300022 | Web x / Android √ / iOS 4.11 / HarmonyOS 4.61(部分支持,见上) | 参数无效 |
686
+ | 1300066 | Web x / Android √ / iOS 4.11 / HarmonyOS 4.61(部分支持,见上) | 目录非空 |
687
+ | 1301003 | Web x / Android √ / iOS 4.61 / HarmonyOS 4.61(部分支持,见上) | 对目录的非法操作 |
688
+ | 1301005 | Web x / Android √ / iOS 4.11 / HarmonyOS 4.61(部分支持,见上) | 文件已存在 |
689
+ | 1300201 | Web x / Android √ / iOS 4.11 / HarmonyOS 4.61(部分支持,见上) | 系统错误 |
690
+ | 1300202 | Web x / Android √ / iOS 4.61 / HarmonyOS 4.61(部分支持,见上) | 超出文件存储限制的最大尺寸 |
691
+ | 1301111 | Web x / Android 4.13 / iOS x / HarmonyOS 4.61(部分支持,见上) | brotli解压失败 |
692
+ | 1302003 | Web x / Android 4.13 / iOS 4.61 / HarmonyOS 4.61(部分支持,见上) | 标志无效 |
693
+ | 1300009 | Web x / Android 4.13 / iOS 4.61 / HarmonyOS 4.61(部分支持,见上) | 文件描述符错误 |
694
+ | 1300010 | Web x / Android x / iOS x / HarmonyOS 4.61(部分支持,见上) | 重试 |
695
+ | 1300011 | Web x / Android x / iOS 4.61 / HarmonyOS 4.61(部分支持,见上) | 错误的地址 |
696
+ | 1300012 | Web x / Android x / iOS x / HarmonyOS 4.61(部分支持,见上) | 操作阻塞 |
697
+ | 1300015 | Web x / Android x / iOS 4.61 / HarmonyOS 4.61(部分支持,见上) | 未知错误 |
698
+ | 1300014 | Web x / Android x / iOS x / HarmonyOS 4.61(部分支持,见上) | 网络不可达 |
699
+ | 1300016 | Web x / Android x / iOS 4.61 / HarmonyOS 4.61(部分支持,见上) | 不是文件夹 |
700
+ | 1300017 | Web x / Android x / iOS 4.61 / HarmonyOS 4.61(部分支持,见上) | 文本文件繁忙 |
701
+ | 1300018 | Web x / Android x / iOS 4.61 / HarmonyOS 4.61(部分支持,见上) | 文件太大 |
702
+ | 1300019 | Web x / Android x / iOS 4.61 / HarmonyOS 4.61(部分支持,见上) | 只读文件系统 |
703
+ | 1300020 | Web x / Android x / iOS 4.61 / HarmonyOS 4.61(部分支持,见上) | 文件名称太长 |
704
+ | 1300033 | Web x / Android x / iOS x / HarmonyOS 4.61(部分支持,见上) | 过多符号链接 |
705
+ | errSubject | string | 是 | Web x(部分支持,见上) | 统一错误主题(模块)名称 |
706
+ | data | any | 否 | Web x(部分支持,见上) | 错误信息中包含的数据 |
707
+ | cause | Error | 否 | | 源错误信息,可以包含多个错误,详见SourceError |
708
+ | errMsg | string | 是 | Web x(部分支持,见上) | |
709
+
710
+ #### mkdir(options: MkDirOptions): void; @mkdir
711
+ mkdir
712
+ 创建目录
713
+ ##### mkdir 兼容性
714
+ | Web | 微信小程序 | Android | iOS | HarmonyOS |
715
+ | :- | :- | :- | :- | :- |
716
+ | x | 4.41 | 3.9.0 | 4.11 | 4.61 |
717
+
718
+ ##### 参数
719
+
720
+ | 名称 | 类型 | 必填 | 兼容性 |
721
+ | :- | :- | :- | :-: |
722
+ | options | **MkDirOptions** | 是 | Web x(部分支持,见上) |
723
+ | 名称 | 类型 | 必备 | 兼容性 | 描述 |
724
+ | :- | :- | :- | :-: | :- |
725
+ | dirPath | string.URIString | 是 | Web x(部分支持,见上) | 创建的目录路径 (本地路径) |
726
+ | recursive | boolean | 是 | Web x(部分支持,见上) | 是否在递归创建该目录的上级目录后再创建该目录。如果对应的上级目录已经存在,则不创建该上级目录。如 dirPath 为 a/b/c/d 且 recursive 为 true,将创建 a 目录,再在 a 目录下创建 b 目录,以此类推直至创建 a/b/c 目录下的 d 目录。 |
727
+ | success | (res: FileManagerSuccessResult) => void | 否 | Web x(部分支持,见上) | 接口调用的回调函数 |
728
+ | fail | (res: [FileSystemManagerFail](#filesystemmanagerfail-values)) => void | 否 | Web x(部分支持,见上) | 通用的错误返回结果回调 |
729
+ | complete | (res: any) => void | 否 | Web x(部分支持,见上) | 通用的结束返回结果回调 |
730
+
731
+ ###### FileSystemManagerFail 的属性值 @filesystemmanagerfail-values
732
+
733
+ | 名称 | 类型 | 必备 | 兼容性 | 描述 |
734
+ | :- | :- | :- | :-: | :- |
735
+ | errCode | number | 是 | Web x(部分支持,见上) | 错误码 |
736
+ | 合法值 | 兼容性 | 描述 |
737
+ | :- | :-: | :- |
738
+ | 1200002 | Web x / Android √ / iOS 4.61 / HarmonyOS 4.61(部分支持,见上) | 类型错误。仅支持 base64 / utf-8 / ascii |
739
+ | 1300002 | Web x / Android √ / iOS 4.11 / HarmonyOS 4.61(部分支持,见上) | 未找到文件 |
740
+ | 1300013 | Web x / Android √ / iOS 4.11 / HarmonyOS 4.61(部分支持,见上) | 无权限 |
741
+ | 1300021 | Web x / Android √ / iOS 4.61 / HarmonyOS 4.61(部分支持,见上) | 是目录 |
742
+ | 1300022 | Web x / Android √ / iOS 4.11 / HarmonyOS 4.61(部分支持,见上) | 参数无效 |
743
+ | 1300066 | Web x / Android √ / iOS 4.11 / HarmonyOS 4.61(部分支持,见上) | 目录非空 |
744
+ | 1301003 | Web x / Android √ / iOS 4.61 / HarmonyOS 4.61(部分支持,见上) | 对目录的非法操作 |
745
+ | 1301005 | Web x / Android √ / iOS 4.11 / HarmonyOS 4.61(部分支持,见上) | 文件已存在 |
746
+ | 1300201 | Web x / Android √ / iOS 4.11 / HarmonyOS 4.61(部分支持,见上) | 系统错误 |
747
+ | 1300202 | Web x / Android √ / iOS 4.61 / HarmonyOS 4.61(部分支持,见上) | 超出文件存储限制的最大尺寸 |
748
+ | 1301111 | Web x / Android 4.13 / iOS x / HarmonyOS 4.61(部分支持,见上) | brotli解压失败 |
749
+ | 1302003 | Web x / Android 4.13 / iOS 4.61 / HarmonyOS 4.61(部分支持,见上) | 标志无效 |
750
+ | 1300009 | Web x / Android 4.13 / iOS 4.61 / HarmonyOS 4.61(部分支持,见上) | 文件描述符错误 |
751
+ | 1300010 | Web x / Android x / iOS x / HarmonyOS 4.61(部分支持,见上) | 重试 |
752
+ | 1300011 | Web x / Android x / iOS 4.61 / HarmonyOS 4.61(部分支持,见上) | 错误的地址 |
753
+ | 1300012 | Web x / Android x / iOS x / HarmonyOS 4.61(部分支持,见上) | 操作阻塞 |
754
+ | 1300015 | Web x / Android x / iOS 4.61 / HarmonyOS 4.61(部分支持,见上) | 未知错误 |
755
+ | 1300014 | Web x / Android x / iOS x / HarmonyOS 4.61(部分支持,见上) | 网络不可达 |
756
+ | 1300016 | Web x / Android x / iOS 4.61 / HarmonyOS 4.61(部分支持,见上) | 不是文件夹 |
757
+ | 1300017 | Web x / Android x / iOS 4.61 / HarmonyOS 4.61(部分支持,见上) | 文本文件繁忙 |
758
+ | 1300018 | Web x / Android x / iOS 4.61 / HarmonyOS 4.61(部分支持,见上) | 文件太大 |
759
+ | 1300019 | Web x / Android x / iOS 4.61 / HarmonyOS 4.61(部分支持,见上) | 只读文件系统 |
760
+ | 1300020 | Web x / Android x / iOS 4.61 / HarmonyOS 4.61(部分支持,见上) | 文件名称太长 |
761
+ | 1300033 | Web x / Android x / iOS x / HarmonyOS 4.61(部分支持,见上) | 过多符号链接 |
762
+ | errSubject | string | 是 | Web x(部分支持,见上) | 统一错误主题(模块)名称 |
763
+ | data | any | 否 | Web x(部分支持,见上) | 错误信息中包含的数据 |
764
+ | cause | Error | 否 | | 源错误信息,可以包含多个错误,详见SourceError |
765
+ | errMsg | string | 是 | Web x(部分支持,见上) | |
766
+
767
+ #### mkdirSync(dirPath: string, recursive: boolean): void; @mkdirsync
768
+ mkdirSync
769
+ FileSystemManager.mkdir 的同步版本
770
+ ##### mkdirSync 兼容性
771
+ | Web | 微信小程序 | Android | iOS | HarmonyOS |
772
+ | :- | :- | :- | :- | :- |
773
+ | x | 4.41 | 4.13 | 4.61 | 4.61 |
774
+
775
+ ##### 参数
776
+
777
+ | 名称 | 类型 | 必填 | 兼容性 | 描述 |
778
+ | :- | :- | :- | :-: | :- |
779
+ | dirPath | string | 是 | Web x(部分支持,见上) | 创建的目录路径 (本地路径) |
780
+ | recursive | boolean | 是 | Web x(部分支持,见上) | 是否在递归创建该目录的上级目录后再创建该目录。如果对应的上级目录已经存在,则不创建该上级目录。如 dirPath 为 a/b/c/d 且 recursive 为 true,将创建 a 目录,再在 a 目录下创建 b 目录,以此类推直至创建 a/b/c 目录下的 d 目录。 |
781
+
782
+ #### open(options: OpenFileOptions): void; @open
783
+ open
784
+ 打开文件,返回文件描述符
785
+ ##### open 兼容性
786
+ | Web | 微信小程序 | Android | iOS | HarmonyOS |
787
+ | :- | :- | :- | :- | :- |
788
+ | x | 4.41 | 4.13 | 4.61 | 4.61 |
789
+
790
+ ##### 参数
791
+
792
+ | 名称 | 类型 | 必填 | 兼容性 |
793
+ | :- | :- | :- | :-: |
794
+ | options | **OpenFileOptions** | 是 | Web x(部分支持,见上) |
795
+ | 名称 | 类型 | 必备 | 兼容性 | 描述 |
796
+ | :- | :- | :- | :-: | :- |
797
+ | filePath | string.URIString | 是 | Web x(部分支持,见上) | 要追加内容的文件路径 (本地路径) |
798
+ | flag | string | 是 | Web x(部分支持,见上) | 文件系统标志,默认值: 'r' |
799
+ @@| 合法值 | 兼容性 | 描述 |
800
+ @@| :- | :-: | :- |
801
+ @@| a | Web x(部分支持,见上) | 打开文件用于追加。 如果文件不存在,则创建该文件 |
802
+ @@| ax | Web x(部分支持,见上) | 类似于 'a',但如果路径存在,则失败 |
803
+ @@| a+ | Web x(部分支持,见上) | 打开文件用于读取和追加。 如果文件不存在,则创建该文件 |
804
+ @@| ax+ | Web x(部分支持,见上) | 类似于 'a+',但如果路径存在,则失败 |
805
+ @@| r | Web x(部分支持,见上) | 打开文件用于读取。 如果文件不存在,则会发生异常 |
806
+ @@| r+ | Web x(部分支持,见上) | 打开文件用于读取和写入。 如果文件不存在,则会发生异常 |
807
+ @@| w | Web x(部分支持,见上) | 打开文件用于写入。 如果文件不存在则创建文件,如果文件存在则截断文件 |
808
+ @@| wx | Web x(部分支持,见上) | 类似于 'w',但如果路径存在,则失败 |
809
+ @@| w+ | Web x(部分支持,见上) | 打开文件用于读取和写入。 如果文件不存在则创建文件,如果文件存在则截断文件 |
810
+ @@| wx+ | Web x(部分支持,见上) | 类似于 'w+',但如果路径存在,则失败 |
811
+ | success | (res: [OpenFileSuccessResult](#openfilesuccessresult-values)) => void | 否 | Web x(部分支持,见上) | 接口调用的回调函数 |
812
+ | fail | (res: [FileSystemManagerFail](#filesystemmanagerfail-values)) => void | 否 | Web x(部分支持,见上) | 通用的错误返回结果回调 |
813
+ | complete | (res: any) => void | 否 | Web x(部分支持,见上) | 通用的结束返回结果回调 |
814
+
815
+ ###### OpenFileSuccessResult 的属性值 @openfilesuccessresult-values
816
+
817
+ | 名称 | 类型 | 必备 | 兼容性 | 描述 |
818
+ | :- | :- | :- | :-: | :- |
819
+ | fd | string | 是 | Web x(部分支持,见上) | 文件描述符 |
820
+
821
+ ###### FileSystemManagerFail 的属性值 @filesystemmanagerfail-values
822
+
823
+ | 名称 | 类型 | 必备 | 兼容性 | 描述 |
824
+ | :- | :- | :- | :-: | :- |
825
+ | errCode | number | 是 | Web x(部分支持,见上) | 错误码 |
826
+ | 合法值 | 兼容性 | 描述 |
827
+ | :- | :-: | :- |
828
+ | 1200002 | Web x / Android √ / iOS 4.61 / HarmonyOS 4.61(部分支持,见上) | 类型错误。仅支持 base64 / utf-8 / ascii |
829
+ | 1300002 | Web x / Android √ / iOS 4.11 / HarmonyOS 4.61(部分支持,见上) | 未找到文件 |
830
+ | 1300013 | Web x / Android √ / iOS 4.11 / HarmonyOS 4.61(部分支持,见上) | 无权限 |
831
+ | 1300021 | Web x / Android √ / iOS 4.61 / HarmonyOS 4.61(部分支持,见上) | 是目录 |
832
+ | 1300022 | Web x / Android √ / iOS 4.11 / HarmonyOS 4.61(部分支持,见上) | 参数无效 |
833
+ | 1300066 | Web x / Android √ / iOS 4.11 / HarmonyOS 4.61(部分支持,见上) | 目录非空 |
834
+ | 1301003 | Web x / Android √ / iOS 4.61 / HarmonyOS 4.61(部分支持,见上) | 对目录的非法操作 |
835
+ | 1301005 | Web x / Android √ / iOS 4.11 / HarmonyOS 4.61(部分支持,见上) | 文件已存在 |
836
+ | 1300201 | Web x / Android √ / iOS 4.11 / HarmonyOS 4.61(部分支持,见上) | 系统错误 |
837
+ | 1300202 | Web x / Android √ / iOS 4.61 / HarmonyOS 4.61(部分支持,见上) | 超出文件存储限制的最大尺寸 |
838
+ | 1301111 | Web x / Android 4.13 / iOS x / HarmonyOS 4.61(部分支持,见上) | brotli解压失败 |
839
+ | 1302003 | Web x / Android 4.13 / iOS 4.61 / HarmonyOS 4.61(部分支持,见上) | 标志无效 |
840
+ | 1300009 | Web x / Android 4.13 / iOS 4.61 / HarmonyOS 4.61(部分支持,见上) | 文件描述符错误 |
841
+ | 1300010 | Web x / Android x / iOS x / HarmonyOS 4.61(部分支持,见上) | 重试 |
842
+ | 1300011 | Web x / Android x / iOS 4.61 / HarmonyOS 4.61(部分支持,见上) | 错误的地址 |
843
+ | 1300012 | Web x / Android x / iOS x / HarmonyOS 4.61(部分支持,见上) | 操作阻塞 |
844
+ | 1300015 | Web x / Android x / iOS 4.61 / HarmonyOS 4.61(部分支持,见上) | 未知错误 |
845
+ | 1300014 | Web x / Android x / iOS x / HarmonyOS 4.61(部分支持,见上) | 网络不可达 |
846
+ | 1300016 | Web x / Android x / iOS 4.61 / HarmonyOS 4.61(部分支持,见上) | 不是文件夹 |
847
+ | 1300017 | Web x / Android x / iOS 4.61 / HarmonyOS 4.61(部分支持,见上) | 文本文件繁忙 |
848
+ | 1300018 | Web x / Android x / iOS 4.61 / HarmonyOS 4.61(部分支持,见上) | 文件太大 |
849
+ | 1300019 | Web x / Android x / iOS 4.61 / HarmonyOS 4.61(部分支持,见上) | 只读文件系统 |
850
+ | 1300020 | Web x / Android x / iOS 4.61 / HarmonyOS 4.61(部分支持,见上) | 文件名称太长 |
851
+ | 1300033 | Web x / Android x / iOS x / HarmonyOS 4.61(部分支持,见上) | 过多符号链接 |
852
+ | errSubject | string | 是 | Web x(部分支持,见上) | 统一错误主题(模块)名称 |
853
+ | data | any | 否 | Web x(部分支持,见上) | 错误信息中包含的数据 |
854
+ | cause | Error | 否 | | 源错误信息,可以包含多个错误,详见SourceError |
855
+ | errMsg | string | 是 | Web x(部分支持,见上) | |
856
+
857
+ #### openSync(options: OpenFileSyncOptions): string; @opensync
858
+ openSync
859
+ 同步打开文件,返回文件描述符
860
+ ##### openSync 兼容性
861
+ | Web | 微信小程序 | Android | iOS | HarmonyOS |
862
+ | :- | :- | :- | :- | :- |
863
+ | x | 4.41 | 4.13 | 4.61 | 4.61 |
864
+
865
+ ##### 参数
866
+
867
+ | 名称 | 类型 | 必填 | 兼容性 |
868
+ | :- | :- | :- | :-: |
869
+ | options | **OpenFileSyncOptions** | 是 | Web x(部分支持,见上) |
870
+ | 名称 | 类型 | 必备 | 兼容性 | 描述 |
871
+ | :- | :- | :- | :-: | :- |
872
+ | filePath | string.URIString | 是 | Web x(部分支持,见上) | 要追加内容的文件路径 (本地路径) |
873
+ | flag | string | 是 | Web x(部分支持,见上) | 文件系统标志,默认值: 'r' |
874
+ @@| 合法值 | 兼容性 | 描述 |
875
+ @@| :- | :-: | :- |
876
+ @@| a | Web x(部分支持,见上) | 打开文件用于追加。 如果文件不存在,则创建该文件 |
877
+ @@| ax | Web x(部分支持,见上) | 类似于 'a',但如果路径存在,则失败 |
878
+ @@| a+ | Web x(部分支持,见上) | 打开文件用于读取和追加。 如果文件不存在,则创建该文件 |
879
+ @@| ax+ | Web x(部分支持,见上) | 类似于 'a+',但如果路径存在,则失败 |
880
+ @@| r | Web x(部分支持,见上) | 打开文件用于读取。 如果文件不存在,则会发生异常 |
881
+ @@| r+ | Web x(部分支持,见上) | 打开文件用于读取和写入。 如果文件不存在,则会发生异常 |
882
+ @@| w | Web x(部分支持,见上) | 打开文件用于写入。 如果文件不存在则创建文件,如果文件存在则截断文件 |
883
+ @@| wx | Web x(部分支持,见上) | 类似于 'w',但如果路径存在,则失败 |
884
+ @@| w+ | Web x(部分支持,见上) | 打开文件用于读取和写入。 如果文件不存在则创建文件,如果文件存在则截断文件 |
885
+ @@| wx+ | Web x(部分支持,见上) | 类似于 'w+',但如果路径存在,则失败 |
886
+
887
+ ##### 返回值
888
+
889
+ | 类型 |
890
+ | :- |
891
+ | string |
892
+
893
+
894
+ #### readFile(options: ReadFileOptions): void; @readfile
895
+ readFile
896
+ 读取本地文件内容
897
+ ##### readFile 兼容性
898
+ | Web | 微信小程序 | Android | iOS | HarmonyOS |
899
+ | :- | :- | :- | :- | :- |
900
+ | x | 4.41 | 3.9.0 | 4.11 | 4.61 |
901
+
902
+ ##### 参数
903
+
904
+ | 名称 | 类型 | 必填 | 兼容性 |
905
+ | :- | :- | :- | :-: |
906
+ | options | **ReadFileOptions** | 是 | Web x(部分支持,见上) |
907
+ | 名称 | 类型 | 必备 | 兼容性 | 描述 |
908
+ | :- | :- | :- | :-: | :- |
909
+ | encoding | string | 否 | Web x(部分支持,见上) | base64 / utf-8 / ascii,指定读取文件的字符编码,(iOS平台4.61及以后、Android平台4.31及以后)如果不传 encoding,则以 ArrayBuffer 格式读取文件的二进制内容 |
910
+ @@| 合法值 | 兼容性 | 描述 |
911
+ @@| :- | :-: | :- |
912
+ @@| ascii | Web x(部分支持,见上) | ascii 字符编码 |
913
+ @@| base64 | Web x(部分支持,见上) | base64 字符编码 |
914
+ @@| utf-8 | Web x(部分支持,见上) | utf-8 字符编码,默认值 |
915
+ | filePath | string.URIString | 是 | Web x(部分支持,见上) | 文件路径,支持相对地址和绝对地址,app-android平台支持代码包文件目录 |
916
+ | success | (res: [ReadFileSuccessResult](#readfilesuccessresult-values)) => void | 否 | Web x(部分支持,见上) | 接口调用的回调函数 |
917
+ | fail | (res: [FileSystemManagerFail](#filesystemmanagerfail-values)) => void | 否 | Web x(部分支持,见上) | 通用的错误返回结果回调 |
918
+ | complete | (res: any) => void | 否 | Web x(部分支持,见上) | 通用的结束返回结果回调 |
919
+
920
+ ###### ReadFileSuccessResult 的属性值 @readfilesuccessresult-values
921
+
922
+ | 名称 | 类型 | 必备 | 兼容性 | 描述 |
923
+ | :- | :- | :- | :-: | :- |
924
+ | data | string \| ArrayBuffer | 是 | Web x / 微信小程序 4.41 / Android 4.31 / iOS 4.11 / HarmonyOS 4.61(部分支持,见上) | 读取的内容,类型为 String 或 ArrayBuffer,在4.31以前类型是string,Android平台4.31、iOS平台4.61起支持ArrayBuffer |
925
+
926
+ ###### FileSystemManagerFail 的属性值 @filesystemmanagerfail-values
927
+
928
+ | 名称 | 类型 | 必备 | 兼容性 | 描述 |
929
+ | :- | :- | :- | :-: | :- |
930
+ | errCode | number | 是 | Web x(部分支持,见上) | 错误码 |
931
+ | 合法值 | 兼容性 | 描述 |
932
+ | :- | :-: | :- |
933
+ | 1200002 | Web x / Android √ / iOS 4.61 / HarmonyOS 4.61(部分支持,见上) | 类型错误。仅支持 base64 / utf-8 / ascii |
934
+ | 1300002 | Web x / Android √ / iOS 4.11 / HarmonyOS 4.61(部分支持,见上) | 未找到文件 |
935
+ | 1300013 | Web x / Android √ / iOS 4.11 / HarmonyOS 4.61(部分支持,见上) | 无权限 |
936
+ | 1300021 | Web x / Android √ / iOS 4.61 / HarmonyOS 4.61(部分支持,见上) | 是目录 |
937
+ | 1300022 | Web x / Android √ / iOS 4.11 / HarmonyOS 4.61(部分支持,见上) | 参数无效 |
938
+ | 1300066 | Web x / Android √ / iOS 4.11 / HarmonyOS 4.61(部分支持,见上) | 目录非空 |
939
+ | 1301003 | Web x / Android √ / iOS 4.61 / HarmonyOS 4.61(部分支持,见上) | 对目录的非法操作 |
940
+ | 1301005 | Web x / Android √ / iOS 4.11 / HarmonyOS 4.61(部分支持,见上) | 文件已存在 |
941
+ | 1300201 | Web x / Android √ / iOS 4.11 / HarmonyOS 4.61(部分支持,见上) | 系统错误 |
942
+ | 1300202 | Web x / Android √ / iOS 4.61 / HarmonyOS 4.61(部分支持,见上) | 超出文件存储限制的最大尺寸 |
943
+ | 1301111 | Web x / Android 4.13 / iOS x / HarmonyOS 4.61(部分支持,见上) | brotli解压失败 |
944
+ | 1302003 | Web x / Android 4.13 / iOS 4.61 / HarmonyOS 4.61(部分支持,见上) | 标志无效 |
945
+ | 1300009 | Web x / Android 4.13 / iOS 4.61 / HarmonyOS 4.61(部分支持,见上) | 文件描述符错误 |
946
+ | 1300010 | Web x / Android x / iOS x / HarmonyOS 4.61(部分支持,见上) | 重试 |
947
+ | 1300011 | Web x / Android x / iOS 4.61 / HarmonyOS 4.61(部分支持,见上) | 错误的地址 |
948
+ | 1300012 | Web x / Android x / iOS x / HarmonyOS 4.61(部分支持,见上) | 操作阻塞 |
949
+ | 1300015 | Web x / Android x / iOS 4.61 / HarmonyOS 4.61(部分支持,见上) | 未知错误 |
950
+ | 1300014 | Web x / Android x / iOS x / HarmonyOS 4.61(部分支持,见上) | 网络不可达 |
951
+ | 1300016 | Web x / Android x / iOS 4.61 / HarmonyOS 4.61(部分支持,见上) | 不是文件夹 |
952
+ | 1300017 | Web x / Android x / iOS 4.61 / HarmonyOS 4.61(部分支持,见上) | 文本文件繁忙 |
953
+ | 1300018 | Web x / Android x / iOS 4.61 / HarmonyOS 4.61(部分支持,见上) | 文件太大 |
954
+ | 1300019 | Web x / Android x / iOS 4.61 / HarmonyOS 4.61(部分支持,见上) | 只读文件系统 |
955
+ | 1300020 | Web x / Android x / iOS 4.61 / HarmonyOS 4.61(部分支持,见上) | 文件名称太长 |
956
+ | 1300033 | Web x / Android x / iOS x / HarmonyOS 4.61(部分支持,见上) | 过多符号链接 |
957
+ | errSubject | string | 是 | Web x(部分支持,见上) | 统一错误主题(模块)名称 |
958
+ | data | any | 否 | Web x(部分支持,见上) | 错误信息中包含的数据 |
959
+ | cause | Error | 否 | | 源错误信息,可以包含多个错误,详见SourceError |
960
+ | errMsg | string | 是 | Web x(部分支持,见上) | |
961
+
962
+ #### readFileSync(filePath: string, encoding?: string): string \| ArrayBuffer; @readfilesync
963
+ readFileSync
964
+ FileSystemManager.readFile 的同步版本参数
965
+ ##### readFileSync 兼容性
966
+ | Web | 微信小程序 | Android | iOS | HarmonyOS |
967
+ | :- | :- | :- | :- | :- |
968
+ | x | 4.41 | 4.13 | 4.61 | 4.61 |
969
+
970
+ ##### 参数
971
+
972
+ | 名称 | 类型 | 必填 | 兼容性 | 描述 |
973
+ | :- | :- | :- | :-: | :- |
974
+ | filePath | string | 是 | Web x(部分支持,见上) | 文件路径,支持相对地址和绝对地址,app-android平台支持代码包文件目录 |
975
+ | encoding | string | 否 | Web x(部分支持,见上) | base64 / utf-8,指定读取文件的字符编码,(iOS平台4.61及以后、Android平台4.31及以后)如果不传 encoding,则以 ArrayBuffer 格式读取文件的二进制内容 |
976
+
977
+ ##### 返回值
978
+
979
+ | 类型 | 描述 |
980
+ | :- | :- |
981
+ | string \| ArrayBuffer | data文件内容, iOS平台4.61及以后、Android平台4.31及以后支持ArrayBuffer |
982
+
983
+
984
+ #### read(option: ReadOption): void; @read
985
+ read
986
+ 读文件
987
+ ##### read 兼容性
988
+ | Web | 微信小程序 | Android | iOS | HarmonyOS |
989
+ | :- | :- | :- | :- | :- |
990
+ | x | 4.41 | 4.31 | 4.61 | 4.61 |
991
+
992
+ ##### 参数
993
+
994
+ | 名称 | 类型 | 必填 | 兼容性 |
995
+ | :- | :- | :- | :-: |
996
+ | option | **ReadOption** | 是 | Web x(部分支持,见上) |
997
+ | 名称 | 类型 | 必备 | 兼容性 | 描述 |
998
+ | :- | :- | :- | :-: | :- |
999
+ | arrayBuffer | ArrayBuffer | 是 | | 数据写入的缓冲区,必须是 ArrayBuffer 实例 |
1000
+ | fd | string | 是 | Web x(部分支持,见上) | 文件描述符。fd 通过 FileSystemManager.open 或 FileSystemManager.openSync 接口获得 |
1001
+ | length | number | 否 | Web x(部分支持,见上) | 要从文件中读取的字节数,默认0 |
1002
+ | offset | number | 否 | Web x(部分支持,见上) | 缓冲区中的写入偏移量,默认0 |
1003
+ | position | number | 否 | Web x(部分支持,见上) | 文件读取的起始位置,如不传或传 null,则会从当前文件指针的位置读取。如果 position 是正整数,则文件指针位置会保持不变并从 position 读取文件。 |
1004
+ | complete | (res: any) => void | 否 | Web x(部分支持,见上) | 通用的结束返回结果回调 |
1005
+ | fail | (res: [FileSystemManagerFail](#filesystemmanagerfail-values)) => void | 否 | Web x(部分支持,见上) | 通用的错误返回结果回调 |
1006
+ | success | (result: [ReadSuccessCallbackResult](#readsuccesscallbackresult-values)) => void | 否 | Web x(部分支持,见上) | 接口调用成功的回调函数 |
1007
+
1008
+ ###### FileSystemManagerFail 的属性值 @filesystemmanagerfail-values
1009
+
1010
+ | 名称 | 类型 | 必备 | 兼容性 | 描述 |
1011
+ | :- | :- | :- | :-: | :- |
1012
+ | errCode | number | 是 | Web x(部分支持,见上) | 错误码 |
1013
+ | 合法值 | 兼容性 | 描述 |
1014
+ | :- | :-: | :- |
1015
+ | 1200002 | Web x / Android √ / iOS 4.61 / HarmonyOS 4.61(部分支持,见上) | 类型错误。仅支持 base64 / utf-8 / ascii |
1016
+ | 1300002 | Web x / Android √ / iOS 4.11 / HarmonyOS 4.61(部分支持,见上) | 未找到文件 |
1017
+ | 1300013 | Web x / Android √ / iOS 4.11 / HarmonyOS 4.61(部分支持,见上) | 无权限 |
1018
+ | 1300021 | Web x / Android √ / iOS 4.61 / HarmonyOS 4.61(部分支持,见上) | 是目录 |
1019
+ | 1300022 | Web x / Android √ / iOS 4.11 / HarmonyOS 4.61(部分支持,见上) | 参数无效 |
1020
+ | 1300066 | Web x / Android √ / iOS 4.11 / HarmonyOS 4.61(部分支持,见上) | 目录非空 |
1021
+ | 1301003 | Web x / Android √ / iOS 4.61 / HarmonyOS 4.61(部分支持,见上) | 对目录的非法操作 |
1022
+ | 1301005 | Web x / Android √ / iOS 4.11 / HarmonyOS 4.61(部分支持,见上) | 文件已存在 |
1023
+ | 1300201 | Web x / Android √ / iOS 4.11 / HarmonyOS 4.61(部分支持,见上) | 系统错误 |
1024
+ | 1300202 | Web x / Android √ / iOS 4.61 / HarmonyOS 4.61(部分支持,见上) | 超出文件存储限制的最大尺寸 |
1025
+ | 1301111 | Web x / Android 4.13 / iOS x / HarmonyOS 4.61(部分支持,见上) | brotli解压失败 |
1026
+ | 1302003 | Web x / Android 4.13 / iOS 4.61 / HarmonyOS 4.61(部分支持,见上) | 标志无效 |
1027
+ | 1300009 | Web x / Android 4.13 / iOS 4.61 / HarmonyOS 4.61(部分支持,见上) | 文件描述符错误 |
1028
+ | 1300010 | Web x / Android x / iOS x / HarmonyOS 4.61(部分支持,见上) | 重试 |
1029
+ | 1300011 | Web x / Android x / iOS 4.61 / HarmonyOS 4.61(部分支持,见上) | 错误的地址 |
1030
+ | 1300012 | Web x / Android x / iOS x / HarmonyOS 4.61(部分支持,见上) | 操作阻塞 |
1031
+ | 1300015 | Web x / Android x / iOS 4.61 / HarmonyOS 4.61(部分支持,见上) | 未知错误 |
1032
+ | 1300014 | Web x / Android x / iOS x / HarmonyOS 4.61(部分支持,见上) | 网络不可达 |
1033
+ | 1300016 | Web x / Android x / iOS 4.61 / HarmonyOS 4.61(部分支持,见上) | 不是文件夹 |
1034
+ | 1300017 | Web x / Android x / iOS 4.61 / HarmonyOS 4.61(部分支持,见上) | 文本文件繁忙 |
1035
+ | 1300018 | Web x / Android x / iOS 4.61 / HarmonyOS 4.61(部分支持,见上) | 文件太大 |
1036
+ | 1300019 | Web x / Android x / iOS 4.61 / HarmonyOS 4.61(部分支持,见上) | 只读文件系统 |
1037
+ | 1300020 | Web x / Android x / iOS 4.61 / HarmonyOS 4.61(部分支持,见上) | 文件名称太长 |
1038
+ | 1300033 | Web x / Android x / iOS x / HarmonyOS 4.61(部分支持,见上) | 过多符号链接 |
1039
+ | errSubject | string | 是 | Web x(部分支持,见上) | 统一错误主题(模块)名称 |
1040
+ | data | any | 否 | Web x(部分支持,见上) | 错误信息中包含的数据 |
1041
+ | cause | Error | 否 | | 源错误信息,可以包含多个错误,详见SourceError |
1042
+ | errMsg | string | 是 | Web x(部分支持,见上) | |
1043
+
1044
+ ###### ReadSuccessCallbackResult 的属性值 @readsuccesscallbackresult-values
1045
+
1046
+ | 名称 | 类型 | 必备 | 兼容性 | 描述 |
1047
+ | :- | :- | :- | :-: | :- |
1048
+ | arrayBuffer | ArrayBuffer | 是 | Web x / 微信小程序 4.41 / Android 4.31 / iOS 4.61 / HarmonyOS 4.61(部分支持,见上) | 被写入的缓存区的对象,即接口入参的 arrayBuffer |
1049
+ | bytesRead | number | 是 | Web x / 微信小程序 4.41 / Android 4.31 / iOS 4.61 / HarmonyOS 4.61(部分支持,见上) | 实际读取的字节数 |
1050
+
1051
+ #### readSync(option: ReadSyncOption): ReadResult; @readsync
1052
+ readSync
1053
+ 读文件
1054
+ ##### readSync 兼容性
1055
+ | Web | 微信小程序 | Android | iOS | HarmonyOS |
1056
+ | :- | :- | :- | :- | :- |
1057
+ | x | 4.41 | 4.31 | 4.61 | 4.61 |
1058
+
1059
+ ##### 参数
1060
+
1061
+ | 名称 | 类型 | 必填 | 兼容性 |
1062
+ | :- | :- | :- | :-: |
1063
+ | option | **ReadSyncOption** | 是 | Web x(部分支持,见上) |
1064
+ | 名称 | 类型 | 必备 | 兼容性 | 描述 |
1065
+ | :- | :- | :- | :-: | :- |
1066
+ | arrayBuffer | ArrayBuffer | 是 | Web x / 微信小程序 4.41 / Android 4.31 / iOS 4.61 / HarmonyOS 4.61(部分支持,见上) | 数据写入的缓冲区,必须是 ArrayBuffer 实例 |
1067
+ | fd | string | 是 | Web x(部分支持,见上) | 文件描述符。fd 通过 [FileSystemManager.open](https://developers.weixin.qq.com/miniprogram/dev/api/file/FileSystemManager.open.html) 或 [FileSystemManager.openSync](https://developers.weixin.qq.com/miniprogram/dev/api/file/FileSystemManager.openSync.html) 接口获得 |
1068
+ | length | number | 否 | Web x(部分支持,见上) | 要从文件中读取的字节数,默认0 |
1069
+ | offset | number | 否 | Web x(部分支持,见上) | 缓冲区中的写入偏移量,默认0 |
1070
+ | position | number | 否 | Web x(部分支持,见上) | 文件读取的起始位置,如不传或传 null,则会从当前文件指针的位置读取。如果 position 是正整数,则文件指针位置会保持不变并从 position 读取文件。 |
1071
+
1072
+ ##### 返回值
1073
+
1074
+ | 类型 |
1075
+ | :- |
1076
+ | **ReadResult** |
1077
+ | 名称 | 类型 | 必备 | 兼容性 | 描述 |
1078
+ | :- | :- | :- | :-: | :- |
1079
+ | arrayBuffer | ArrayBuffer | 是 | Web x / 微信小程序 4.41 / Android 4.31 / iOS 4.61 / HarmonyOS 4.61(部分支持,见上) | 被写入的缓存区的对象,即接口入参的 arrayBuffer |
1080
+ | bytesRead | number | 是 | Web x / 微信小程序 4.41 / Android 4.31 / iOS 4.61 / HarmonyOS 4.61(部分支持,见上) | 实际读取的字节数 |
1081
+
1082
+ #### readdir(options: ReadDirOptions): void; @readdir
1083
+ readdir
1084
+ 读取目录内文件列表
1085
+ ##### readdir 兼容性
1086
+ | Web | 微信小程序 | Android | iOS | HarmonyOS |
1087
+ | :- | :- | :- | :- | :- |
1088
+ | x | 4.41 | 3.9.0 | 4.11 | 4.61 |
1089
+
1090
+ ##### 参数
1091
+
1092
+ | 名称 | 类型 | 必填 | 兼容性 |
1093
+ | :- | :- | :- | :-: |
1094
+ | options | **ReadDirOptions** | 是 | Web x(部分支持,见上) |
1095
+ | 名称 | 类型 | 必备 | 兼容性 | 描述 |
1096
+ | :- | :- | :- | :-: | :- |
1097
+ | dirPath | string.URIString | 是 | Web x(部分支持,见上) | 要读取的目录路径 (本地路径) |
1098
+ | success | (res: [ReadDirSuccessResult](#readdirsuccessresult-values)) => void | 否 | Web x(部分支持,见上) | 接口调用的回调函数 |
1099
+ | fail | (res: [FileSystemManagerFail](#filesystemmanagerfail-values)) => void | 否 | Web x(部分支持,见上) | 通用的错误返回结果回调 |
1100
+ | complete | (res: any) => void | 否 | Web x(部分支持,见上) | 通用的结束返回结果回调 |
1101
+
1102
+ ###### ReadDirSuccessResult 的属性值 @readdirsuccessresult-values
1103
+
1104
+ | 名称 | 类型 | 必备 | 兼容性 |
1105
+ | :- | :- | :- | :-: |
1106
+ | files | Array&lt;string&gt; | 是 | Web x(部分支持,见上) |
1107
+
1108
+ ###### FileSystemManagerFail 的属性值 @filesystemmanagerfail-values
1109
+
1110
+ | 名称 | 类型 | 必备 | 兼容性 | 描述 |
1111
+ | :- | :- | :- | :-: | :- |
1112
+ | errCode | number | 是 | Web x(部分支持,见上) | 错误码 |
1113
+ | 合法值 | 兼容性 | 描述 |
1114
+ | :- | :-: | :- |
1115
+ | 1200002 | Web x / Android √ / iOS 4.61 / HarmonyOS 4.61(部分支持,见上) | 类型错误。仅支持 base64 / utf-8 / ascii |
1116
+ | 1300002 | Web x / Android √ / iOS 4.11 / HarmonyOS 4.61(部分支持,见上) | 未找到文件 |
1117
+ | 1300013 | Web x / Android √ / iOS 4.11 / HarmonyOS 4.61(部分支持,见上) | 无权限 |
1118
+ | 1300021 | Web x / Android √ / iOS 4.61 / HarmonyOS 4.61(部分支持,见上) | 是目录 |
1119
+ | 1300022 | Web x / Android √ / iOS 4.11 / HarmonyOS 4.61(部分支持,见上) | 参数无效 |
1120
+ | 1300066 | Web x / Android √ / iOS 4.11 / HarmonyOS 4.61(部分支持,见上) | 目录非空 |
1121
+ | 1301003 | Web x / Android √ / iOS 4.61 / HarmonyOS 4.61(部分支持,见上) | 对目录的非法操作 |
1122
+ | 1301005 | Web x / Android √ / iOS 4.11 / HarmonyOS 4.61(部分支持,见上) | 文件已存在 |
1123
+ | 1300201 | Web x / Android √ / iOS 4.11 / HarmonyOS 4.61(部分支持,见上) | 系统错误 |
1124
+ | 1300202 | Web x / Android √ / iOS 4.61 / HarmonyOS 4.61(部分支持,见上) | 超出文件存储限制的最大尺寸 |
1125
+ | 1301111 | Web x / Android 4.13 / iOS x / HarmonyOS 4.61(部分支持,见上) | brotli解压失败 |
1126
+ | 1302003 | Web x / Android 4.13 / iOS 4.61 / HarmonyOS 4.61(部分支持,见上) | 标志无效 |
1127
+ | 1300009 | Web x / Android 4.13 / iOS 4.61 / HarmonyOS 4.61(部分支持,见上) | 文件描述符错误 |
1128
+ | 1300010 | Web x / Android x / iOS x / HarmonyOS 4.61(部分支持,见上) | 重试 |
1129
+ | 1300011 | Web x / Android x / iOS 4.61 / HarmonyOS 4.61(部分支持,见上) | 错误的地址 |
1130
+ | 1300012 | Web x / Android x / iOS x / HarmonyOS 4.61(部分支持,见上) | 操作阻塞 |
1131
+ | 1300015 | Web x / Android x / iOS 4.61 / HarmonyOS 4.61(部分支持,见上) | 未知错误 |
1132
+ | 1300014 | Web x / Android x / iOS x / HarmonyOS 4.61(部分支持,见上) | 网络不可达 |
1133
+ | 1300016 | Web x / Android x / iOS 4.61 / HarmonyOS 4.61(部分支持,见上) | 不是文件夹 |
1134
+ | 1300017 | Web x / Android x / iOS 4.61 / HarmonyOS 4.61(部分支持,见上) | 文本文件繁忙 |
1135
+ | 1300018 | Web x / Android x / iOS 4.61 / HarmonyOS 4.61(部分支持,见上) | 文件太大 |
1136
+ | 1300019 | Web x / Android x / iOS 4.61 / HarmonyOS 4.61(部分支持,见上) | 只读文件系统 |
1137
+ | 1300020 | Web x / Android x / iOS 4.61 / HarmonyOS 4.61(部分支持,见上) | 文件名称太长 |
1138
+ | 1300033 | Web x / Android x / iOS x / HarmonyOS 4.61(部分支持,见上) | 过多符号链接 |
1139
+ | errSubject | string | 是 | Web x(部分支持,见上) | 统一错误主题(模块)名称 |
1140
+ | data | any | 否 | Web x(部分支持,见上) | 错误信息中包含的数据 |
1141
+ | cause | Error | 否 | | 源错误信息,可以包含多个错误,详见SourceError |
1142
+ | errMsg | string | 是 | Web x(部分支持,见上) | |
1143
+
1144
+ #### readdirSync(dirPath: string): string\[] \| null; @readdirsync
1145
+ readdirSync
1146
+ FileSystemManager.readdir 的同步版本
1147
+ ##### readdirSync 兼容性
1148
+ | Web | 微信小程序 | Android | iOS | HarmonyOS |
1149
+ | :- | :- | :- | :- | :- |
1150
+ | x | 4.41 | 4.13 | 4.61 | 4.61 |
1151
+
1152
+ ##### 参数
1153
+
1154
+ | 名称 | 类型 | 必填 | 兼容性 | 描述 |
1155
+ | :- | :- | :- | :-: | :- |
1156
+ | dirPath | string | 是 | Web x(部分支持,见上) | 要读取的目录路径 (本地路径) |
1157
+
1158
+ ##### 返回值
1159
+
1160
+ | 类型 | 必备 |
1161
+ | :- | :- |
1162
+ | Array&lt;string&gt; | 否 |
1163
+
1164
+
1165
+ #### readZipEntry(options: ReadZipEntryOptions): void; @readzipentry
1166
+ readZipEntry
1167
+ 读取压缩包内的文件
1168
+ ##### readZipEntry 兼容性
1169
+ | Web | 微信小程序 | Android | iOS | HarmonyOS |
1170
+ | :- | :- | :- | :- | :- |
1171
+ | x | 4.41 | 4.13 | 4.61 | 4.61 |
1172
+
1173
+ ##### 参数
1174
+
1175
+ | 名称 | 类型 | 必填 | 兼容性 |
1176
+ | :- | :- | :- | :-: |
1177
+ | options | **ReadZipEntryOptions** | 是 | Web x(部分支持,见上) |
1178
+ | 名称 | 类型 | 必备 | 兼容性 | 描述 |
1179
+ | :- | :- | :- | :-: | :- |
1180
+ | filePath | string.URIString | 是 | Web x(部分支持,见上) | 要读取的压缩包的路径 (本地路径),app-android平台支持代码包文件目录 |
1181
+ | encoding | string | 否 | Web x(部分支持,见上) | 统一指定读取文件的字符编码,只在 entries 值为"all"时有效。<br/>4.31及以后版本如果 entries 值为 null 且不传 encoding,则以 ArrayBuffer 格式读取文件的二进制内容 |
1182
+ @@| 合法值 | 兼容性 | 描述 |
1183
+ @@| :- | :-: | :- |
1184
+ @@| ascii | Web x(部分支持,见上) | ascii 字符编码 |
1185
+ @@| base64 | Web x(部分支持,见上) | base64 字符编码 |
1186
+ @@| utf-8 | Web x(部分支持,见上) | utf-8 字符编码,默认值 |
1187
+ | entries | Array&lt;**EntryItem**&gt; | 否 | Web x(部分支持,见上) | 要读取的压缩包内的文件列表(当不传入时表示读取压缩包内所有文件) |
1188
+ @@| 名称 | 类型 | 必备 | 兼容性 | 描述 |
1189
+ @@| :- | :- | :- | :-: | :- |
1190
+ @@| path | string | 是 | Web x(部分支持,见上) | 压缩包内文件路径 |
1191
+ @@| encoding | string | 否 | Web x(部分支持,见上) | 指定写入文件的字符编码<br/>支持:ascii base64 utf-8;4.31及以后版本如果不传 encoding,则以 ArrayBuffer 格式读取文件的二进制内容 |
1192
+ @@@| 合法值 | 兼容性 | 描述 |
1193
+ @@@| :- | :-: | :- |
1194
+ @@@| ascii | Web x(部分支持,见上) | ascii 字符编码 |
1195
+ @@@| base64 | Web x(部分支持,见上) | base64 字符编码 |
1196
+ @@@| utf-8 | Web x(部分支持,见上) | utf-8 字符编码,默认值 |
1197
+ | success | (res: [EntriesResult](#entriesresult-values)) => void | 否 | Web x(部分支持,见上) | 接口调用的回调函数 |
1198
+ | fail | (res: [FileSystemManagerFail](#filesystemmanagerfail-values)) => void | 否 | Web x(部分支持,见上) | 通用的错误返回结果回调 |
1199
+ | complete | (res: any) => void | 否 | Web x(部分支持,见上) | 通用的结束返回结果回调 |
1200
+
1201
+ ###### EntriesResult 的属性值 @entriesresult-values
1202
+
1203
+ | 名称 | 类型 | 必备 | 兼容性 | 描述 |
1204
+ | :- | :- | :- | :-: | :- |
1205
+ | entries | Map\<string, ZipFileItem> | 是 | Web x(部分支持,见上) | 文件路径 |
1206
+ | ~~result~~ | Map\<string, ZipFileItem> | 是 | Web x(部分支持,见上) | **已废弃,使用 entries** |
1207
+
1208
+ ###### FileSystemManagerFail 的属性值 @filesystemmanagerfail-values
1209
+
1210
+ | 名称 | 类型 | 必备 | 兼容性 | 描述 |
1211
+ | :- | :- | :- | :-: | :- |
1212
+ | errCode | number | 是 | Web x(部分支持,见上) | 错误码 |
1213
+ | 合法值 | 兼容性 | 描述 |
1214
+ | :- | :-: | :- |
1215
+ | 1200002 | Web x / Android √ / iOS 4.61 / HarmonyOS 4.61(部分支持,见上) | 类型错误。仅支持 base64 / utf-8 / ascii |
1216
+ | 1300002 | Web x / Android √ / iOS 4.11 / HarmonyOS 4.61(部分支持,见上) | 未找到文件 |
1217
+ | 1300013 | Web x / Android √ / iOS 4.11 / HarmonyOS 4.61(部分支持,见上) | 无权限 |
1218
+ | 1300021 | Web x / Android √ / iOS 4.61 / HarmonyOS 4.61(部分支持,见上) | 是目录 |
1219
+ | 1300022 | Web x / Android √ / iOS 4.11 / HarmonyOS 4.61(部分支持,见上) | 参数无效 |
1220
+ | 1300066 | Web x / Android √ / iOS 4.11 / HarmonyOS 4.61(部分支持,见上) | 目录非空 |
1221
+ | 1301003 | Web x / Android √ / iOS 4.61 / HarmonyOS 4.61(部分支持,见上) | 对目录的非法操作 |
1222
+ | 1301005 | Web x / Android √ / iOS 4.11 / HarmonyOS 4.61(部分支持,见上) | 文件已存在 |
1223
+ | 1300201 | Web x / Android √ / iOS 4.11 / HarmonyOS 4.61(部分支持,见上) | 系统错误 |
1224
+ | 1300202 | Web x / Android √ / iOS 4.61 / HarmonyOS 4.61(部分支持,见上) | 超出文件存储限制的最大尺寸 |
1225
+ | 1301111 | Web x / Android 4.13 / iOS x / HarmonyOS 4.61(部分支持,见上) | brotli解压失败 |
1226
+ | 1302003 | Web x / Android 4.13 / iOS 4.61 / HarmonyOS 4.61(部分支持,见上) | 标志无效 |
1227
+ | 1300009 | Web x / Android 4.13 / iOS 4.61 / HarmonyOS 4.61(部分支持,见上) | 文件描述符错误 |
1228
+ | 1300010 | Web x / Android x / iOS x / HarmonyOS 4.61(部分支持,见上) | 重试 |
1229
+ | 1300011 | Web x / Android x / iOS 4.61 / HarmonyOS 4.61(部分支持,见上) | 错误的地址 |
1230
+ | 1300012 | Web x / Android x / iOS x / HarmonyOS 4.61(部分支持,见上) | 操作阻塞 |
1231
+ | 1300015 | Web x / Android x / iOS 4.61 / HarmonyOS 4.61(部分支持,见上) | 未知错误 |
1232
+ | 1300014 | Web x / Android x / iOS x / HarmonyOS 4.61(部分支持,见上) | 网络不可达 |
1233
+ | 1300016 | Web x / Android x / iOS 4.61 / HarmonyOS 4.61(部分支持,见上) | 不是文件夹 |
1234
+ | 1300017 | Web x / Android x / iOS 4.61 / HarmonyOS 4.61(部分支持,见上) | 文本文件繁忙 |
1235
+ | 1300018 | Web x / Android x / iOS 4.61 / HarmonyOS 4.61(部分支持,见上) | 文件太大 |
1236
+ | 1300019 | Web x / Android x / iOS 4.61 / HarmonyOS 4.61(部分支持,见上) | 只读文件系统 |
1237
+ | 1300020 | Web x / Android x / iOS 4.61 / HarmonyOS 4.61(部分支持,见上) | 文件名称太长 |
1238
+ | 1300033 | Web x / Android x / iOS x / HarmonyOS 4.61(部分支持,见上) | 过多符号链接 |
1239
+ | errSubject | string | 是 | Web x(部分支持,见上) | 统一错误主题(模块)名称 |
1240
+ | data | any | 否 | Web x(部分支持,见上) | 错误信息中包含的数据 |
1241
+ | cause | Error | 否 | | 源错误信息,可以包含多个错误,详见SourceError |
1242
+ | errMsg | string | 是 | Web x(部分支持,见上) | |
1243
+
1244
+ #### rmdir(options: RmDirOptions): void; @rmdir
1245
+ rmdir
1246
+ 删除目录
1247
+ ##### rmdir 兼容性
1248
+ | Web | 微信小程序 | Android | iOS | HarmonyOS |
1249
+ | :- | :- | :- | :- | :- |
1250
+ | x | 4.41 | 3.9.0 | 4.11 | 4.61 |
1251
+
1252
+ ##### 参数
1253
+
1254
+ | 名称 | 类型 | 必填 | 兼容性 |
1255
+ | :- | :- | :- | :-: |
1256
+ | options | **RmDirOptions** | 是 | Web x(部分支持,见上) |
1257
+ | 名称 | 类型 | 必备 | 兼容性 | 描述 |
1258
+ | :- | :- | :- | :-: | :- |
1259
+ | dirPath | string.URIString | 是 | Web x(部分支持,见上) | 要删除的目录路径 (本地路径)<br/>删除特殊目录,只删除子,保留本身<br/>- uni.env.SANDBOX_PATH<br/>- uni.env.CACHE_PATH<br/>- uni.env.USER_DATA_PATH<br/>- uni.env.ANDROID_INTERNAL_SANDBOX_PATH<br/>其他创建的目录可以删除子和本身 |
1260
+ | recursive | boolean | 是 | Web x(部分支持,见上) | 是否递归删除目录。如果为 true,则删除该目录和该目录下的所有子目录以及文件。 |
1261
+ | success | (res: FileManagerSuccessResult) => void | 否 | Web x(部分支持,见上) | 接口调用的回调函数 |
1262
+ | fail | (res: [FileSystemManagerFail](#filesystemmanagerfail-values)) => void | 否 | Web x(部分支持,见上) | 通用的错误返回结果回调 |
1263
+ | complete | (res: any) => void | 否 | Web x(部分支持,见上) | 通用的结束返回结果回调 |
1264
+
1265
+ ###### FileSystemManagerFail 的属性值 @filesystemmanagerfail-values
1266
+
1267
+ | 名称 | 类型 | 必备 | 兼容性 | 描述 |
1268
+ | :- | :- | :- | :-: | :- |
1269
+ | errCode | number | 是 | Web x(部分支持,见上) | 错误码 |
1270
+ | 合法值 | 兼容性 | 描述 |
1271
+ | :- | :-: | :- |
1272
+ | 1200002 | Web x / Android √ / iOS 4.61 / HarmonyOS 4.61(部分支持,见上) | 类型错误。仅支持 base64 / utf-8 / ascii |
1273
+ | 1300002 | Web x / Android √ / iOS 4.11 / HarmonyOS 4.61(部分支持,见上) | 未找到文件 |
1274
+ | 1300013 | Web x / Android √ / iOS 4.11 / HarmonyOS 4.61(部分支持,见上) | 无权限 |
1275
+ | 1300021 | Web x / Android √ / iOS 4.61 / HarmonyOS 4.61(部分支持,见上) | 是目录 |
1276
+ | 1300022 | Web x / Android √ / iOS 4.11 / HarmonyOS 4.61(部分支持,见上) | 参数无效 |
1277
+ | 1300066 | Web x / Android √ / iOS 4.11 / HarmonyOS 4.61(部分支持,见上) | 目录非空 |
1278
+ | 1301003 | Web x / Android √ / iOS 4.61 / HarmonyOS 4.61(部分支持,见上) | 对目录的非法操作 |
1279
+ | 1301005 | Web x / Android √ / iOS 4.11 / HarmonyOS 4.61(部分支持,见上) | 文件已存在 |
1280
+ | 1300201 | Web x / Android √ / iOS 4.11 / HarmonyOS 4.61(部分支持,见上) | 系统错误 |
1281
+ | 1300202 | Web x / Android √ / iOS 4.61 / HarmonyOS 4.61(部分支持,见上) | 超出文件存储限制的最大尺寸 |
1282
+ | 1301111 | Web x / Android 4.13 / iOS x / HarmonyOS 4.61(部分支持,见上) | brotli解压失败 |
1283
+ | 1302003 | Web x / Android 4.13 / iOS 4.61 / HarmonyOS 4.61(部分支持,见上) | 标志无效 |
1284
+ | 1300009 | Web x / Android 4.13 / iOS 4.61 / HarmonyOS 4.61(部分支持,见上) | 文件描述符错误 |
1285
+ | 1300010 | Web x / Android x / iOS x / HarmonyOS 4.61(部分支持,见上) | 重试 |
1286
+ | 1300011 | Web x / Android x / iOS 4.61 / HarmonyOS 4.61(部分支持,见上) | 错误的地址 |
1287
+ | 1300012 | Web x / Android x / iOS x / HarmonyOS 4.61(部分支持,见上) | 操作阻塞 |
1288
+ | 1300015 | Web x / Android x / iOS 4.61 / HarmonyOS 4.61(部分支持,见上) | 未知错误 |
1289
+ | 1300014 | Web x / Android x / iOS x / HarmonyOS 4.61(部分支持,见上) | 网络不可达 |
1290
+ | 1300016 | Web x / Android x / iOS 4.61 / HarmonyOS 4.61(部分支持,见上) | 不是文件夹 |
1291
+ | 1300017 | Web x / Android x / iOS 4.61 / HarmonyOS 4.61(部分支持,见上) | 文本文件繁忙 |
1292
+ | 1300018 | Web x / Android x / iOS 4.61 / HarmonyOS 4.61(部分支持,见上) | 文件太大 |
1293
+ | 1300019 | Web x / Android x / iOS 4.61 / HarmonyOS 4.61(部分支持,见上) | 只读文件系统 |
1294
+ | 1300020 | Web x / Android x / iOS 4.61 / HarmonyOS 4.61(部分支持,见上) | 文件名称太长 |
1295
+ | 1300033 | Web x / Android x / iOS x / HarmonyOS 4.61(部分支持,见上) | 过多符号链接 |
1296
+ | errSubject | string | 是 | Web x(部分支持,见上) | 统一错误主题(模块)名称 |
1297
+ | data | any | 否 | Web x(部分支持,见上) | 错误信息中包含的数据 |
1298
+ | cause | Error | 否 | | 源错误信息,可以包含多个错误,详见SourceError |
1299
+ | errMsg | string | 是 | Web x(部分支持,见上) | |
1300
+
1301
+ #### rmdirSync(dirPath: string, recursive: boolean): void; @rmdirsync
1302
+ rmdirSync
1303
+ FileSystemManager.rmdir 的同步版本
1304
+ ##### rmdirSync 兼容性
1305
+ | Web | 微信小程序 | Android | iOS | HarmonyOS |
1306
+ | :- | :- | :- | :- | :- |
1307
+ | x | 4.41 | 4.13 | 4.61 | 4.61 |
1308
+
1309
+ ##### 参数
1310
+
1311
+ | 名称 | 类型 | 必填 | 兼容性 | 描述 |
1312
+ | :- | :- | :- | :-: | :- |
1313
+ | dirPath | string | 是 | Web x(部分支持,见上) | 要删除的目录路径 (本地路径) |
1314
+ | recursive | boolean | 是 | Web x(部分支持,见上) | 是否递归删除目录。如果为 true,则删除该目录和该目录下的所有子目录以及文件。 |
1315
+
1316
+ #### rename(options: RenameOptions): void; @rename
1317
+ rename
1318
+ 重命名文件。可以把文件从 oldPath 移动到 newPath
1319
+ ##### rename 兼容性
1320
+ | Web | 微信小程序 | Android | iOS | HarmonyOS |
1321
+ | :- | :- | :- | :- | :- |
1322
+ | x | 4.41 | 3.9.0 | 4.11 | 4.61 |
1323
+
1324
+ ##### 参数
1325
+
1326
+ | 名称 | 类型 | 必填 | 兼容性 |
1327
+ | :- | :- | :- | :-: |
1328
+ | options | **RenameOptions** | 是 | Web x(部分支持,见上) |
1329
+ | 名称 | 类型 | 必备 | 兼容性 | 描述 |
1330
+ | :- | :- | :- | :-: | :- |
1331
+ | oldPath | string.URIString | 是 | Web x(部分支持,见上) | 源文件路径,支持本地路径 |
1332
+ | newPath | string.URIString | 是 | Web x(部分支持,见上) | 新文件路径,支持本地路径 |
1333
+ | success | (res: FileManagerSuccessResult) => void | 否 | Web x(部分支持,见上) | 通用的正确返回结果回调 |
1334
+ | fail | (res: [FileSystemManagerFail](#filesystemmanagerfail-values)) => void | 否 | Web x(部分支持,见上) | 通用的错误返回结果回调 |
1335
+ | complete | (res: any) => void | 否 | Web x(部分支持,见上) | 通用的结束返回结果回调 |
1336
+
1337
+ ###### FileSystemManagerFail 的属性值 @filesystemmanagerfail-values
1338
+
1339
+ | 名称 | 类型 | 必备 | 兼容性 | 描述 |
1340
+ | :- | :- | :- | :-: | :- |
1341
+ | errCode | number | 是 | Web x(部分支持,见上) | 错误码 |
1342
+ | 合法值 | 兼容性 | 描述 |
1343
+ | :- | :-: | :- |
1344
+ | 1200002 | Web x / Android √ / iOS 4.61 / HarmonyOS 4.61(部分支持,见上) | 类型错误。仅支持 base64 / utf-8 / ascii |
1345
+ | 1300002 | Web x / Android √ / iOS 4.11 / HarmonyOS 4.61(部分支持,见上) | 未找到文件 |
1346
+ | 1300013 | Web x / Android √ / iOS 4.11 / HarmonyOS 4.61(部分支持,见上) | 无权限 |
1347
+ | 1300021 | Web x / Android √ / iOS 4.61 / HarmonyOS 4.61(部分支持,见上) | 是目录 |
1348
+ | 1300022 | Web x / Android √ / iOS 4.11 / HarmonyOS 4.61(部分支持,见上) | 参数无效 |
1349
+ | 1300066 | Web x / Android √ / iOS 4.11 / HarmonyOS 4.61(部分支持,见上) | 目录非空 |
1350
+ | 1301003 | Web x / Android √ / iOS 4.61 / HarmonyOS 4.61(部分支持,见上) | 对目录的非法操作 |
1351
+ | 1301005 | Web x / Android √ / iOS 4.11 / HarmonyOS 4.61(部分支持,见上) | 文件已存在 |
1352
+ | 1300201 | Web x / Android √ / iOS 4.11 / HarmonyOS 4.61(部分支持,见上) | 系统错误 |
1353
+ | 1300202 | Web x / Android √ / iOS 4.61 / HarmonyOS 4.61(部分支持,见上) | 超出文件存储限制的最大尺寸 |
1354
+ | 1301111 | Web x / Android 4.13 / iOS x / HarmonyOS 4.61(部分支持,见上) | brotli解压失败 |
1355
+ | 1302003 | Web x / Android 4.13 / iOS 4.61 / HarmonyOS 4.61(部分支持,见上) | 标志无效 |
1356
+ | 1300009 | Web x / Android 4.13 / iOS 4.61 / HarmonyOS 4.61(部分支持,见上) | 文件描述符错误 |
1357
+ | 1300010 | Web x / Android x / iOS x / HarmonyOS 4.61(部分支持,见上) | 重试 |
1358
+ | 1300011 | Web x / Android x / iOS 4.61 / HarmonyOS 4.61(部分支持,见上) | 错误的地址 |
1359
+ | 1300012 | Web x / Android x / iOS x / HarmonyOS 4.61(部分支持,见上) | 操作阻塞 |
1360
+ | 1300015 | Web x / Android x / iOS 4.61 / HarmonyOS 4.61(部分支持,见上) | 未知错误 |
1361
+ | 1300014 | Web x / Android x / iOS x / HarmonyOS 4.61(部分支持,见上) | 网络不可达 |
1362
+ | 1300016 | Web x / Android x / iOS 4.61 / HarmonyOS 4.61(部分支持,见上) | 不是文件夹 |
1363
+ | 1300017 | Web x / Android x / iOS 4.61 / HarmonyOS 4.61(部分支持,见上) | 文本文件繁忙 |
1364
+ | 1300018 | Web x / Android x / iOS 4.61 / HarmonyOS 4.61(部分支持,见上) | 文件太大 |
1365
+ | 1300019 | Web x / Android x / iOS 4.61 / HarmonyOS 4.61(部分支持,见上) | 只读文件系统 |
1366
+ | 1300020 | Web x / Android x / iOS 4.61 / HarmonyOS 4.61(部分支持,见上) | 文件名称太长 |
1367
+ | 1300033 | Web x / Android x / iOS x / HarmonyOS 4.61(部分支持,见上) | 过多符号链接 |
1368
+ | errSubject | string | 是 | Web x(部分支持,见上) | 统一错误主题(模块)名称 |
1369
+ | data | any | 否 | Web x(部分支持,见上) | 错误信息中包含的数据 |
1370
+ | cause | Error | 否 | | 源错误信息,可以包含多个错误,详见SourceError |
1371
+ | errMsg | string | 是 | Web x(部分支持,见上) | |
1372
+
1373
+ #### renameSync(oldPath: string, newPath: string): void; @renamesync
1374
+ renameSync
1375
+ FileSystemManager.rename 的同步版本
1376
+ ##### renameSync 兼容性
1377
+ | Web | 微信小程序 | Android | iOS | HarmonyOS |
1378
+ | :- | :- | :- | :- | :- |
1379
+ | x | 4.41 | 4.13 | 4.61 | 4.61 |
1380
+
1381
+ ##### 参数
1382
+
1383
+ | 名称 | 类型 | 必填 | 兼容性 | 描述 |
1384
+ | :- | :- | :- | :-: | :- |
1385
+ | oldPath | string | 是 | Web x(部分支持,见上) | 源文件路径,支持本地路径 |
1386
+ | newPath | string | 是 | Web x(部分支持,见上) | 新文件路径,支持本地路径 |
1387
+
1388
+ #### removeSavedFile(options: RemoveSavedFileOptions): void; @removesavedfile
1389
+ removeSavedFile
1390
+ 删除该小程序下已保存的本地缓存文件
1391
+ ##### removeSavedFile 兼容性
1392
+ | Web | 微信小程序 | Android | iOS | HarmonyOS |
1393
+ | :- | :- | :- | :- | :- |
1394
+ | x | 4.41 | 4.13 | 4.61 | 4.61 |
1395
+
1396
+ ##### 参数
1397
+
1398
+ | 名称 | 类型 | 必填 | 兼容性 |
1399
+ | :- | :- | :- | :-: |
1400
+ | options | **RemoveSavedFileOptions** | 是 | Web x(部分支持,见上) |
1401
+ | 名称 | 类型 | 必备 | 兼容性 | 描述 |
1402
+ | :- | :- | :- | :-: | :- |
1403
+ | filePath | string.URIString | 是 | Web x(部分支持,见上) | 需要删除的文件路径 (本地路径) |
1404
+ | success | (res: FileManagerSuccessResult) => void | 否 | Web x(部分支持,见上) | 通用的正确返回结果回调 |
1405
+ | fail | (res: [FileSystemManagerFail](#filesystemmanagerfail-values)) => void | 否 | Web x(部分支持,见上) | 通用的错误返回结果回调 |
1406
+ | complete | (res: any) => void | 否 | Web x(部分支持,见上) | 通用的结束返回结果回调 |
1407
+
1408
+ ###### FileSystemManagerFail 的属性值 @filesystemmanagerfail-values
1409
+
1410
+ | 名称 | 类型 | 必备 | 兼容性 | 描述 |
1411
+ | :- | :- | :- | :-: | :- |
1412
+ | errCode | number | 是 | Web x(部分支持,见上) | 错误码 |
1413
+ | 合法值 | 兼容性 | 描述 |
1414
+ | :- | :-: | :- |
1415
+ | 1200002 | Web x / Android √ / iOS 4.61 / HarmonyOS 4.61(部分支持,见上) | 类型错误。仅支持 base64 / utf-8 / ascii |
1416
+ | 1300002 | Web x / Android √ / iOS 4.11 / HarmonyOS 4.61(部分支持,见上) | 未找到文件 |
1417
+ | 1300013 | Web x / Android √ / iOS 4.11 / HarmonyOS 4.61(部分支持,见上) | 无权限 |
1418
+ | 1300021 | Web x / Android √ / iOS 4.61 / HarmonyOS 4.61(部分支持,见上) | 是目录 |
1419
+ | 1300022 | Web x / Android √ / iOS 4.11 / HarmonyOS 4.61(部分支持,见上) | 参数无效 |
1420
+ | 1300066 | Web x / Android √ / iOS 4.11 / HarmonyOS 4.61(部分支持,见上) | 目录非空 |
1421
+ | 1301003 | Web x / Android √ / iOS 4.61 / HarmonyOS 4.61(部分支持,见上) | 对目录的非法操作 |
1422
+ | 1301005 | Web x / Android √ / iOS 4.11 / HarmonyOS 4.61(部分支持,见上) | 文件已存在 |
1423
+ | 1300201 | Web x / Android √ / iOS 4.11 / HarmonyOS 4.61(部分支持,见上) | 系统错误 |
1424
+ | 1300202 | Web x / Android √ / iOS 4.61 / HarmonyOS 4.61(部分支持,见上) | 超出文件存储限制的最大尺寸 |
1425
+ | 1301111 | Web x / Android 4.13 / iOS x / HarmonyOS 4.61(部分支持,见上) | brotli解压失败 |
1426
+ | 1302003 | Web x / Android 4.13 / iOS 4.61 / HarmonyOS 4.61(部分支持,见上) | 标志无效 |
1427
+ | 1300009 | Web x / Android 4.13 / iOS 4.61 / HarmonyOS 4.61(部分支持,见上) | 文件描述符错误 |
1428
+ | 1300010 | Web x / Android x / iOS x / HarmonyOS 4.61(部分支持,见上) | 重试 |
1429
+ | 1300011 | Web x / Android x / iOS 4.61 / HarmonyOS 4.61(部分支持,见上) | 错误的地址 |
1430
+ | 1300012 | Web x / Android x / iOS x / HarmonyOS 4.61(部分支持,见上) | 操作阻塞 |
1431
+ | 1300015 | Web x / Android x / iOS 4.61 / HarmonyOS 4.61(部分支持,见上) | 未知错误 |
1432
+ | 1300014 | Web x / Android x / iOS x / HarmonyOS 4.61(部分支持,见上) | 网络不可达 |
1433
+ | 1300016 | Web x / Android x / iOS 4.61 / HarmonyOS 4.61(部分支持,见上) | 不是文件夹 |
1434
+ | 1300017 | Web x / Android x / iOS 4.61 / HarmonyOS 4.61(部分支持,见上) | 文本文件繁忙 |
1435
+ | 1300018 | Web x / Android x / iOS 4.61 / HarmonyOS 4.61(部分支持,见上) | 文件太大 |
1436
+ | 1300019 | Web x / Android x / iOS 4.61 / HarmonyOS 4.61(部分支持,见上) | 只读文件系统 |
1437
+ | 1300020 | Web x / Android x / iOS 4.61 / HarmonyOS 4.61(部分支持,见上) | 文件名称太长 |
1438
+ | 1300033 | Web x / Android x / iOS x / HarmonyOS 4.61(部分支持,见上) | 过多符号链接 |
1439
+ | errSubject | string | 是 | Web x(部分支持,见上) | 统一错误主题(模块)名称 |
1440
+ | data | any | 否 | Web x(部分支持,见上) | 错误信息中包含的数据 |
1441
+ | cause | Error | 否 | | 源错误信息,可以包含多个错误,详见SourceError |
1442
+ | errMsg | string | 是 | Web x(部分支持,见上) | |
1443
+
1444
+ #### readCompressedFile(options: ReadCompressedFileOptions): void; @readcompressedfile
1445
+ readCompressedFile
1446
+ 读取指定压缩类型的本地文件内容
1447
+ ##### readCompressedFile 兼容性
1448
+ | Web | 微信小程序 | Android | iOS | HarmonyOS |
1449
+ | :- | :- | :- | :- | :- |
1450
+ | x | 4.41 | 4.13 | 4.61 | x |
1451
+
1452
+ ##### 参数
1453
+
1454
+ | 名称 | 类型 | 必填 | 兼容性 |
1455
+ | :- | :- | :- | :-: |
1456
+ | options | **ReadCompressedFileOptions** | 是 | Web x(部分支持,见上) |
1457
+ | 名称 | 类型 | 必备 | 兼容性 | 描述 |
1458
+ | :- | :- | :- | :-: | :- |
1459
+ | filePath | string.URIString | 是 | Web x(部分支持,见上) | 要读取的文件的路径 (本地用户文件或代码包文件),app-android平台支持代码包文件目录 |
1460
+ | compressionAlgorithm | string | 是 | Web x(部分支持,见上) | 文件压缩类型,目前仅支持 'br'。 |
1461
+ | success | (res: [ReadCompressedFileResult](#readcompressedfileresult-values)) => void | 否 | Web x(部分支持,见上) | 接口调用的回调函数 |
1462
+ | fail | (res: [FileSystemManagerFail](#filesystemmanagerfail-values)) => void | 否 | Web x(部分支持,见上) | 通用的错误返回结果回调 |
1463
+ | complete | (res: any) => void | 否 | Web x(部分支持,见上) | 通用的结束返回结果回调 |
1464
+
1465
+ ###### ReadCompressedFileResult 的属性值 @readcompressedfileresult-values
1466
+
1467
+ | 名称 | 类型 | 必备 | 兼容性 |
1468
+ | :- | :- | :- | :-: |
1469
+ | data | string | 是 | Web x(部分支持,见上) |
1470
+
1471
+ ###### FileSystemManagerFail 的属性值 @filesystemmanagerfail-values
1472
+
1473
+ | 名称 | 类型 | 必备 | 兼容性 | 描述 |
1474
+ | :- | :- | :- | :-: | :- |
1475
+ | errCode | number | 是 | Web x(部分支持,见上) | 错误码 |
1476
+ | 合法值 | 兼容性 | 描述 |
1477
+ | :- | :-: | :- |
1478
+ | 1200002 | Web x / Android √ / iOS 4.61 / HarmonyOS 4.61(部分支持,见上) | 类型错误。仅支持 base64 / utf-8 / ascii |
1479
+ | 1300002 | Web x / Android √ / iOS 4.11 / HarmonyOS 4.61(部分支持,见上) | 未找到文件 |
1480
+ | 1300013 | Web x / Android √ / iOS 4.11 / HarmonyOS 4.61(部分支持,见上) | 无权限 |
1481
+ | 1300021 | Web x / Android √ / iOS 4.61 / HarmonyOS 4.61(部分支持,见上) | 是目录 |
1482
+ | 1300022 | Web x / Android √ / iOS 4.11 / HarmonyOS 4.61(部分支持,见上) | 参数无效 |
1483
+ | 1300066 | Web x / Android √ / iOS 4.11 / HarmonyOS 4.61(部分支持,见上) | 目录非空 |
1484
+ | 1301003 | Web x / Android √ / iOS 4.61 / HarmonyOS 4.61(部分支持,见上) | 对目录的非法操作 |
1485
+ | 1301005 | Web x / Android √ / iOS 4.11 / HarmonyOS 4.61(部分支持,见上) | 文件已存在 |
1486
+ | 1300201 | Web x / Android √ / iOS 4.11 / HarmonyOS 4.61(部分支持,见上) | 系统错误 |
1487
+ | 1300202 | Web x / Android √ / iOS 4.61 / HarmonyOS 4.61(部分支持,见上) | 超出文件存储限制的最大尺寸 |
1488
+ | 1301111 | Web x / Android 4.13 / iOS x / HarmonyOS 4.61(部分支持,见上) | brotli解压失败 |
1489
+ | 1302003 | Web x / Android 4.13 / iOS 4.61 / HarmonyOS 4.61(部分支持,见上) | 标志无效 |
1490
+ | 1300009 | Web x / Android 4.13 / iOS 4.61 / HarmonyOS 4.61(部分支持,见上) | 文件描述符错误 |
1491
+ | 1300010 | Web x / Android x / iOS x / HarmonyOS 4.61(部分支持,见上) | 重试 |
1492
+ | 1300011 | Web x / Android x / iOS 4.61 / HarmonyOS 4.61(部分支持,见上) | 错误的地址 |
1493
+ | 1300012 | Web x / Android x / iOS x / HarmonyOS 4.61(部分支持,见上) | 操作阻塞 |
1494
+ | 1300015 | Web x / Android x / iOS 4.61 / HarmonyOS 4.61(部分支持,见上) | 未知错误 |
1495
+ | 1300014 | Web x / Android x / iOS x / HarmonyOS 4.61(部分支持,见上) | 网络不可达 |
1496
+ | 1300016 | Web x / Android x / iOS 4.61 / HarmonyOS 4.61(部分支持,见上) | 不是文件夹 |
1497
+ | 1300017 | Web x / Android x / iOS 4.61 / HarmonyOS 4.61(部分支持,见上) | 文本文件繁忙 |
1498
+ | 1300018 | Web x / Android x / iOS 4.61 / HarmonyOS 4.61(部分支持,见上) | 文件太大 |
1499
+ | 1300019 | Web x / Android x / iOS 4.61 / HarmonyOS 4.61(部分支持,见上) | 只读文件系统 |
1500
+ | 1300020 | Web x / Android x / iOS 4.61 / HarmonyOS 4.61(部分支持,见上) | 文件名称太长 |
1501
+ | 1300033 | Web x / Android x / iOS x / HarmonyOS 4.61(部分支持,见上) | 过多符号链接 |
1502
+ | errSubject | string | 是 | Web x(部分支持,见上) | 统一错误主题(模块)名称 |
1503
+ | data | any | 否 | Web x(部分支持,见上) | 错误信息中包含的数据 |
1504
+ | cause | Error | 否 | | 源错误信息,可以包含多个错误,详见SourceError |
1505
+ | errMsg | string | 是 | Web x(部分支持,见上) | |
1506
+
1507
+ #### readCompressedFileSync(filePath: string, compressionAlgorithm: string): string @readcompressedfilesync
1508
+ readCompressedFileSync
1509
+ 同步读取指定压缩类型的本地文件内容
1510
+ ##### readCompressedFileSync 兼容性
1511
+ | Web | 微信小程序 | Android | iOS | HarmonyOS |
1512
+ | :- | :- | :- | :- | :- |
1513
+ | x | 4.41 | 4.13 | 4.61 | x |
1514
+
1515
+ ##### 参数
1516
+
1517
+ | 名称 | 类型 | 必填 | 兼容性 | 描述 |
1518
+ | :- | :- | :- | :-: | :- |
1519
+ | filePath | string | 是 | Web x(部分支持,见上) | 要读取的文件的路径 (本地用户文件或代码包文件),app-android平台支持代码包文件目录 |
1520
+ | compressionAlgorithm | string | 是 | Web x(部分支持,见上) | 文件压缩类型,目前仅支持 'br'。 |
1521
+
1522
+ ##### 返回值
1523
+
1524
+ | 类型 |
1525
+ | :- |
1526
+ | string |
1527
+
1528
+
1529
+ #### saveFile(options: SaveFileOptions): void; @savefile
1530
+ saveFile
1531
+ 保存临时文件到本地。此接口会移动临时文件,因此调用成功后,tempFilePath 将不可用。
1532
+ ##### saveFile 兼容性
1533
+ | Web | 微信小程序 | Android | iOS | HarmonyOS |
1534
+ | :- | :- | :- | :- | :- |
1535
+ | x | 4.41 | 4.13 | 4.61 | 4.61 |
1536
+
1537
+ ##### 参数
1538
+
1539
+ | 名称 | 类型 | 必填 | 兼容性 |
1540
+ | :- | :- | :- | :-: |
1541
+ | options | **SaveFileOptions** | 是 | Web x(部分支持,见上) |
1542
+ | 名称 | 类型 | 必备 | 兼容性 | 描述 |
1543
+ | :- | :- | :- | :-: | :- |
1544
+ | tempFilePath | string.URIString | 是 | Web x(部分支持,见上) | 临时存储文件路径 (本地路径) |
1545
+ | filePath | string.URIString | 否 | Web x(部分支持,见上) | - 传入nil:默认保存到 uni.env.CACHE_PATH/uni-store/ 目录<br/>- 传入错误路径:比如无权限的路径,返回 error<br/>- 传入文件路径:如果上一级目录存在,保存到传入的路径,如存在则覆盖;如果上一级目录不存在,上上级目录也不存在,则先递归创建再保存<br/>- 传入filePath是目录路径且已存在,则返回错误码1300021<br/>- 传入filePath是文件路径且已存在,则覆盖写入<br/>- 判断传入路径尾部是否带斜线,如xxx/path、 xxx/path/,直接视为写入到path文件,如xxx/path/sub.txt 具体的是写入到具体的文件,path是目录 |
1546
+ | success | (res: [SaveFileSuccessResult](#savefilesuccessresult-values)) => void | 否 | Web x(部分支持,见上) | 接口调用的回调函数 |
1547
+ | fail | (res: [FileSystemManagerFail](#filesystemmanagerfail-values)) => void | 否 | Web x(部分支持,见上) | 通用的错误返回结果回调 |
1548
+ | complete | (res: any) => void | 否 | Web x(部分支持,见上) | 通用的结束返回结果回调 |
1549
+
1550
+ ###### SaveFileSuccessResult 的属性值 @savefilesuccessresult-values
1551
+
1552
+ | 名称 | 类型 | 必备 | 兼容性 | 描述 |
1553
+ | :- | :- | :- | :-: | :- |
1554
+ | savedFilePath | string | 是 | Web x(部分支持,见上) | 存储后的文件路径 (本地路径)。自 `4.71` 起,返回 `unifile://` 协议的路径<br/>参数filePath=nil, savedFilePath= unifile://cache/uni-store/xxx<br/>否则savedFilePath= unifile://cache/xxx/unifile://usr/xxx/unifile://sandbox/xxx |
1555
+
1556
+ ###### FileSystemManagerFail 的属性值 @filesystemmanagerfail-values
1557
+
1558
+ | 名称 | 类型 | 必备 | 兼容性 | 描述 |
1559
+ | :- | :- | :- | :-: | :- |
1560
+ | errCode | number | 是 | Web x(部分支持,见上) | 错误码 |
1561
+ | 合法值 | 兼容性 | 描述 |
1562
+ | :- | :-: | :- |
1563
+ | 1200002 | Web x / Android √ / iOS 4.61 / HarmonyOS 4.61(部分支持,见上) | 类型错误。仅支持 base64 / utf-8 / ascii |
1564
+ | 1300002 | Web x / Android √ / iOS 4.11 / HarmonyOS 4.61(部分支持,见上) | 未找到文件 |
1565
+ | 1300013 | Web x / Android √ / iOS 4.11 / HarmonyOS 4.61(部分支持,见上) | 无权限 |
1566
+ | 1300021 | Web x / Android √ / iOS 4.61 / HarmonyOS 4.61(部分支持,见上) | 是目录 |
1567
+ | 1300022 | Web x / Android √ / iOS 4.11 / HarmonyOS 4.61(部分支持,见上) | 参数无效 |
1568
+ | 1300066 | Web x / Android √ / iOS 4.11 / HarmonyOS 4.61(部分支持,见上) | 目录非空 |
1569
+ | 1301003 | Web x / Android √ / iOS 4.61 / HarmonyOS 4.61(部分支持,见上) | 对目录的非法操作 |
1570
+ | 1301005 | Web x / Android √ / iOS 4.11 / HarmonyOS 4.61(部分支持,见上) | 文件已存在 |
1571
+ | 1300201 | Web x / Android √ / iOS 4.11 / HarmonyOS 4.61(部分支持,见上) | 系统错误 |
1572
+ | 1300202 | Web x / Android √ / iOS 4.61 / HarmonyOS 4.61(部分支持,见上) | 超出文件存储限制的最大尺寸 |
1573
+ | 1301111 | Web x / Android 4.13 / iOS x / HarmonyOS 4.61(部分支持,见上) | brotli解压失败 |
1574
+ | 1302003 | Web x / Android 4.13 / iOS 4.61 / HarmonyOS 4.61(部分支持,见上) | 标志无效 |
1575
+ | 1300009 | Web x / Android 4.13 / iOS 4.61 / HarmonyOS 4.61(部分支持,见上) | 文件描述符错误 |
1576
+ | 1300010 | Web x / Android x / iOS x / HarmonyOS 4.61(部分支持,见上) | 重试 |
1577
+ | 1300011 | Web x / Android x / iOS 4.61 / HarmonyOS 4.61(部分支持,见上) | 错误的地址 |
1578
+ | 1300012 | Web x / Android x / iOS x / HarmonyOS 4.61(部分支持,见上) | 操作阻塞 |
1579
+ | 1300015 | Web x / Android x / iOS 4.61 / HarmonyOS 4.61(部分支持,见上) | 未知错误 |
1580
+ | 1300014 | Web x / Android x / iOS x / HarmonyOS 4.61(部分支持,见上) | 网络不可达 |
1581
+ | 1300016 | Web x / Android x / iOS 4.61 / HarmonyOS 4.61(部分支持,见上) | 不是文件夹 |
1582
+ | 1300017 | Web x / Android x / iOS 4.61 / HarmonyOS 4.61(部分支持,见上) | 文本文件繁忙 |
1583
+ | 1300018 | Web x / Android x / iOS 4.61 / HarmonyOS 4.61(部分支持,见上) | 文件太大 |
1584
+ | 1300019 | Web x / Android x / iOS 4.61 / HarmonyOS 4.61(部分支持,见上) | 只读文件系统 |
1585
+ | 1300020 | Web x / Android x / iOS 4.61 / HarmonyOS 4.61(部分支持,见上) | 文件名称太长 |
1586
+ | 1300033 | Web x / Android x / iOS x / HarmonyOS 4.61(部分支持,见上) | 过多符号链接 |
1587
+ | errSubject | string | 是 | Web x(部分支持,见上) | 统一错误主题(模块)名称 |
1588
+ | data | any | 否 | Web x(部分支持,见上) | 错误信息中包含的数据 |
1589
+ | cause | Error | 否 | | 源错误信息,可以包含多个错误,详见SourceError |
1590
+ | errMsg | string | 是 | Web x(部分支持,见上) | |
1591
+
1592
+ #### saveFileSync(tempFilePath: string, filePath: string): string; @savefilesync
1593
+ saveFileSync
1594
+ FileSystemManager.saveFile 的同步版本。自 `4.71` 起,返回 `unifile://` 协议的路径
1595
+ ##### saveFileSync 兼容性
1596
+ | Web | 微信小程序 | Android | iOS | HarmonyOS |
1597
+ | :- | :- | :- | :- | :- |
1598
+ | x | 4.41 | 4.13 | 4.61 | 4.61 |
1599
+
1600
+ ##### 参数
1601
+
1602
+ | 名称 | 类型 | 必填 | 兼容性 | 描述 |
1603
+ | :- | :- | :- | :-: | :- |
1604
+ | tempFilePath | string | 是 | Web x(部分支持,见上) | 临时存储文件路径 (本地路径) |
1605
+ | filePath | string | 否 | Web x(部分支持,见上) | 要存储的文件路径 (本地路径),文件已经存在时会直接覆盖 传入不存在的路径\ - App 端自动创建并保存 - 微信小程序会报错 |
1606
+
1607
+ ##### 返回值
1608
+
1609
+ | 类型 |
1610
+ | :- |
1611
+ | string |
1612
+
1613
+
1614
+ #### stat(options: StatOptions): void; @stat
1615
+ stat
1616
+ 获取文件 Stats 对象
1617
+ ##### stat 兼容性
1618
+ | Web | 微信小程序 | Android | iOS | HarmonyOS |
1619
+ | :- | :- | :- | :- | :- |
1620
+ | x | 4.41 | 3.9.0 | 4.11 | 4.61 |
1621
+
1622
+ ##### 参数
1623
+
1624
+ | 名称 | 类型 | 必填 | 兼容性 |
1625
+ | :- | :- | :- | :-: |
1626
+ | options | **StatOptions** | 是 | Web x(部分支持,见上) |
1627
+ | 名称 | 类型 | 必备 | 兼容性 | 描述 |
1628
+ | :- | :- | :- | :-: | :- |
1629
+ | path | string.URIString | 是 | Web x(部分支持,见上) | 文件/目录路径 (本地路径) |
1630
+ | recursive | boolean | 是 | Web x(部分支持,见上) | 是否递归获取目录下的每个文件的 Stats 信息 |
1631
+ | success | (res: [StatSuccessResult](#statsuccessresult-values)) => void | 否 | Web x(部分支持,见上) | 接口调用的回调函数 |
1632
+ | fail | (res: [FileSystemManagerFail](#filesystemmanagerfail-values)) => void | 否 | Web x(部分支持,见上) | 通用的错误返回结果回调 |
1633
+ | complete | (res: any) => void | 否 | Web x(部分支持,见上) | 通用的结束返回结果回调 |
1634
+
1635
+ ###### StatSuccessResult 的属性值 @statsuccessresult-values
1636
+
1637
+ | 名称 | 类型 | 必备 | 兼容性 | 描述 |
1638
+ | :- | :- | :- | :-: | :- |
1639
+ | stats | Array&lt;**FileStats**&gt; | 是 | Web x(部分支持,见上) | 微信小程序规则:当 recursive 为 false 时,res.stats 是一个 Stats 对象。当 recursive 为 true 且 path 是一个目录的路径时,res.stats 是一个 Array,数组的每一项是一个对象,每个对象包含 path 和 stats<br/>uniapp-x规则为避免返回值是联合类型,均返回数组,具体优化如下:<br/>-—— 当 path = 文件路径,返回数组,仅包含本身stats,返回 stats.path= ""<br/>-—— 当 path = 目录路径 && recursive = false,返回数组,仅包含本身stats,返回 stats.path= "/"<br/>-—— 当 path = 目录路径 && recursive = true,返回数组,包含本身stats和其递归子文件stats和目录文件stats |
1640
+ | 名称 | 类型 | 必备 | 兼容性 | 描述 |
1641
+ | :- | :- | :- | :-: | :- |
1642
+ | path | string | 是 | Web x(部分支持,见上) | 文件/目录路径(相对于传入路径) |
1643
+ | stats | [Stats](#stats-values) | 是 | Web x(部分支持,见上) | Stats 对象,即描述文件状态的对象 |
1644
+ @@| 名称 | 类型 | 必备 | 兼容性 | 描述 |
1645
+ @@| :- | :- | :- | :-: | :- |
1646
+ @@| mode | number | 是 | Web x(部分支持,见上) | 文件的类型和存取的权限,对应 POSIX stat.st_mode<br/>注意android中,文件类型只包含是否是目录与文件,<br/>另外在android中这里的权限指的是当前进程对文件或者文件夹是否有读,写,执行的权限,<br/>这里没有与 POSIX stat.st_mode对应的组,其他人等相关权限的数据返回,只有所有者的相关权限 |
1647
+ @@| size | number | 是 | Web x(部分支持,见上) | 文件大小,单位:B,对应 POSIX stat.st_size |
1648
+ @@| lastAccessedTime | number | 是 | Web x(部分支持,见上) | 文件最近一次被存取或被执行的时间,UNIX 时间戳,对应 POSIX stat.st_atime<br/>注意:android中由于系统限制无法获取该数据 |
1649
+ @@| lastModifiedTime | number | 是 | Web x(部分支持,见上) | 文件最后一次被修改的时间,UNIX 时间戳,对应 POSIX stat.st_mtime |
1650
+
1651
+ ###### Stats 的方法 @stats-values
1652
+
1653
+ ###### isDirectory(): boolean; @isdirectory
1654
+ isDirectory
1655
+ 判断当前文件是否一个目录
1656
+ ###### isDirectory 兼容性
1657
+ | Web | 微信小程序 | Android | iOS | HarmonyOS |
1658
+ | :- | :- | :- | :- | :- |
1659
+ | x | 4.41 | 4.31 | 4.11 | 4.61 |
1660
+
1661
+ ###### 返回值
1662
+
1663
+ | 类型 |
1664
+ | :- |
1665
+ | boolean |
1666
+
1667
+
1668
+ ###### isFile(): boolean; @isfile
1669
+ isFile
1670
+ 判断当前文件是否一个普通文件
1671
+ ###### isFile 兼容性
1672
+ | Web | 微信小程序 | Android | iOS | HarmonyOS |
1673
+ | :- | :- | :- | :- | :- |
1674
+ | x | 4.41 | 4.31 | 4.11 | 4.61 |
1675
+
1676
+ ###### 返回值
1677
+
1678
+ | 类型 |
1679
+ | :- |
1680
+ | boolean |
1681
+
1682
+
1683
+ ###### FileSystemManagerFail 的属性值 @filesystemmanagerfail-values
1684
+
1685
+ | 名称 | 类型 | 必备 | 兼容性 | 描述 |
1686
+ | :- | :- | :- | :-: | :- |
1687
+ | errCode | number | 是 | Web x(部分支持,见上) | 错误码 |
1688
+ | 合法值 | 兼容性 | 描述 |
1689
+ | :- | :-: | :- |
1690
+ | 1200002 | Web x / Android √ / iOS 4.61 / HarmonyOS 4.61(部分支持,见上) | 类型错误。仅支持 base64 / utf-8 / ascii |
1691
+ | 1300002 | Web x / Android √ / iOS 4.11 / HarmonyOS 4.61(部分支持,见上) | 未找到文件 |
1692
+ | 1300013 | Web x / Android √ / iOS 4.11 / HarmonyOS 4.61(部分支持,见上) | 无权限 |
1693
+ | 1300021 | Web x / Android √ / iOS 4.61 / HarmonyOS 4.61(部分支持,见上) | 是目录 |
1694
+ | 1300022 | Web x / Android √ / iOS 4.11 / HarmonyOS 4.61(部分支持,见上) | 参数无效 |
1695
+ | 1300066 | Web x / Android √ / iOS 4.11 / HarmonyOS 4.61(部分支持,见上) | 目录非空 |
1696
+ | 1301003 | Web x / Android √ / iOS 4.61 / HarmonyOS 4.61(部分支持,见上) | 对目录的非法操作 |
1697
+ | 1301005 | Web x / Android √ / iOS 4.11 / HarmonyOS 4.61(部分支持,见上) | 文件已存在 |
1698
+ | 1300201 | Web x / Android √ / iOS 4.11 / HarmonyOS 4.61(部分支持,见上) | 系统错误 |
1699
+ | 1300202 | Web x / Android √ / iOS 4.61 / HarmonyOS 4.61(部分支持,见上) | 超出文件存储限制的最大尺寸 |
1700
+ | 1301111 | Web x / Android 4.13 / iOS x / HarmonyOS 4.61(部分支持,见上) | brotli解压失败 |
1701
+ | 1302003 | Web x / Android 4.13 / iOS 4.61 / HarmonyOS 4.61(部分支持,见上) | 标志无效 |
1702
+ | 1300009 | Web x / Android 4.13 / iOS 4.61 / HarmonyOS 4.61(部分支持,见上) | 文件描述符错误 |
1703
+ | 1300010 | Web x / Android x / iOS x / HarmonyOS 4.61(部分支持,见上) | 重试 |
1704
+ | 1300011 | Web x / Android x / iOS 4.61 / HarmonyOS 4.61(部分支持,见上) | 错误的地址 |
1705
+ | 1300012 | Web x / Android x / iOS x / HarmonyOS 4.61(部分支持,见上) | 操作阻塞 |
1706
+ | 1300015 | Web x / Android x / iOS 4.61 / HarmonyOS 4.61(部分支持,见上) | 未知错误 |
1707
+ | 1300014 | Web x / Android x / iOS x / HarmonyOS 4.61(部分支持,见上) | 网络不可达 |
1708
+ | 1300016 | Web x / Android x / iOS 4.61 / HarmonyOS 4.61(部分支持,见上) | 不是文件夹 |
1709
+ | 1300017 | Web x / Android x / iOS 4.61 / HarmonyOS 4.61(部分支持,见上) | 文本文件繁忙 |
1710
+ | 1300018 | Web x / Android x / iOS 4.61 / HarmonyOS 4.61(部分支持,见上) | 文件太大 |
1711
+ | 1300019 | Web x / Android x / iOS 4.61 / HarmonyOS 4.61(部分支持,见上) | 只读文件系统 |
1712
+ | 1300020 | Web x / Android x / iOS 4.61 / HarmonyOS 4.61(部分支持,见上) | 文件名称太长 |
1713
+ | 1300033 | Web x / Android x / iOS x / HarmonyOS 4.61(部分支持,见上) | 过多符号链接 |
1714
+ | errSubject | string | 是 | Web x(部分支持,见上) | 统一错误主题(模块)名称 |
1715
+ | data | any | 否 | Web x(部分支持,见上) | 错误信息中包含的数据 |
1716
+ | cause | Error | 否 | | 源错误信息,可以包含多个错误,详见SourceError |
1717
+ | errMsg | string | 是 | Web x(部分支持,见上) | |
1718
+
1719
+ #### statSync(path : string, recursive : boolean) : FileStats\[]; @statsync
1720
+ statSync
1721
+ FileSystemManager.stat 的同步版本
1722
+ ##### statSync 兼容性
1723
+ | Web | 微信小程序 | Android | iOS | HarmonyOS |
1724
+ | :- | :- | :- | :- | :- |
1725
+ | x | 4.41 | 4.13 | 4.61 | 4.61 |
1726
+
1727
+ ##### 参数
1728
+
1729
+ | 名称 | 类型 | 必填 | 兼容性 | 描述 |
1730
+ | :- | :- | :- | :-: | :- |
1731
+ | path | string | 是 | Web x(部分支持,见上) | 文件/目录路径 (本地路径) |
1732
+ | recursive | boolean | 是 | Web x(部分支持,见上) | 是否递归获取目录下的每个文件的 Stats 信息 |
1733
+
1734
+ ##### 返回值
1735
+
1736
+ | 类型 |
1737
+ | :- |
1738
+ | Array&lt;**FileStats**&gt; |
1739
+ | 名称 | 类型 | 必备 | 兼容性 | 描述 |
1740
+ | :- | :- | :- | :-: | :- |
1741
+ | path | string | 是 | Web x(部分支持,见上) | 文件/目录路径(相对于传入路径) |
1742
+ | stats | [Stats](#stats-values) | 是 | Web x(部分支持,见上) | Stats 对象,即描述文件状态的对象 |
1743
+ @@| 名称 | 类型 | 必备 | 兼容性 | 描述 |
1744
+ @@| :- | :- | :- | :-: | :- |
1745
+ @@| mode | number | 是 | Web x(部分支持,见上) | 文件的类型和存取的权限,对应 POSIX stat.st_mode<br/>注意android中,文件类型只包含是否是目录与文件,<br/>另外在android中这里的权限指的是当前进程对文件或者文件夹是否有读,写,执行的权限,<br/>这里没有与 POSIX stat.st_mode对应的组,其他人等相关权限的数据返回,只有所有者的相关权限 |
1746
+ @@| size | number | 是 | Web x(部分支持,见上) | 文件大小,单位:B,对应 POSIX stat.st_size |
1747
+ @@| lastAccessedTime | number | 是 | Web x(部分支持,见上) | 文件最近一次被存取或被执行的时间,UNIX 时间戳,对应 POSIX stat.st_atime<br/>注意:android中由于系统限制无法获取该数据 |
1748
+ @@| lastModifiedTime | number | 是 | Web x(部分支持,见上) | 文件最后一次被修改的时间,UNIX 时间戳,对应 POSIX stat.st_mtime |
1749
+ ###### Stats 的方法 @stats-values
1750
+
1751
+ ###### isDirectory(): boolean; @isdirectory
1752
+ isDirectory
1753
+ 判断当前文件是否一个目录
1754
+ ###### isDirectory 兼容性
1755
+ | Web | 微信小程序 | Android | iOS | HarmonyOS |
1756
+ | :- | :- | :- | :- | :- |
1757
+ | x | 4.41 | 4.31 | 4.11 | 4.61 |
1758
+
1759
+ ###### 返回值
1760
+
1761
+ | 类型 |
1762
+ | :- |
1763
+ | boolean |
1764
+
1765
+
1766
+ ###### isFile(): boolean; @isfile
1767
+ isFile
1768
+ 判断当前文件是否一个普通文件
1769
+ ###### isFile 兼容性
1770
+ | Web | 微信小程序 | Android | iOS | HarmonyOS |
1771
+ | :- | :- | :- | :- | :- |
1772
+ | x | 4.41 | 4.31 | 4.11 | 4.61 |
1773
+
1774
+ ###### 返回值
1775
+
1776
+ | 类型 |
1777
+ | :- |
1778
+ | boolean |
1779
+
1780
+
1781
+
1782
+ #### truncate(options: TruncateFileOptions): void; @truncate
1783
+ truncate
1784
+ 对文件内容进行截断操作
1785
+ ##### truncate 兼容性
1786
+ | Web | 微信小程序 | Android | iOS | HarmonyOS |
1787
+ | :- | :- | :- | :- | :- |
1788
+ | x | 4.41 | 4.13 | 4.61 | 4.61 |
1789
+
1790
+ ##### 参数
1791
+
1792
+ | 名称 | 类型 | 必填 | 兼容性 |
1793
+ | :- | :- | :- | :-: |
1794
+ | options | **TruncateFileOptions** | 是 | Web x(部分支持,见上) |
1795
+ | 名称 | 类型 | 必备 | 兼容性 | 描述 |
1796
+ | :- | :- | :- | :-: | :- |
1797
+ | filePath | string.URIString | 是 | Web x(部分支持,见上) | 要截断的文件路径 (本地路径) |
1798
+ | length | number | 是 | Web x(部分支持,见上) | 截断位置,默认0。如果 length 小于文件长度(字节),则只有前面 length 个字节会保留在文件中,其余内容会被删除;<br/>如果 length 大于文件长度,不做处理 |
1799
+ | success | (res: FileManagerSuccessResult) => void | 否 | Web x(部分支持,见上) | 通用的正确返回结果回调 |
1800
+ | fail | (res: [FileSystemManagerFail](#filesystemmanagerfail-values)) => void | 否 | Web x(部分支持,见上) | 通用的错误返回结果回调 |
1801
+ | complete | (res: any) => void | 否 | Web x(部分支持,见上) | 通用的结束返回结果回调 |
1802
+
1803
+ ###### FileSystemManagerFail 的属性值 @filesystemmanagerfail-values
1804
+
1805
+ | 名称 | 类型 | 必备 | 兼容性 | 描述 |
1806
+ | :- | :- | :- | :-: | :- |
1807
+ | errCode | number | 是 | Web x(部分支持,见上) | 错误码 |
1808
+ | 合法值 | 兼容性 | 描述 |
1809
+ | :- | :-: | :- |
1810
+ | 1200002 | Web x / Android √ / iOS 4.61 / HarmonyOS 4.61(部分支持,见上) | 类型错误。仅支持 base64 / utf-8 / ascii |
1811
+ | 1300002 | Web x / Android √ / iOS 4.11 / HarmonyOS 4.61(部分支持,见上) | 未找到文件 |
1812
+ | 1300013 | Web x / Android √ / iOS 4.11 / HarmonyOS 4.61(部分支持,见上) | 无权限 |
1813
+ | 1300021 | Web x / Android √ / iOS 4.61 / HarmonyOS 4.61(部分支持,见上) | 是目录 |
1814
+ | 1300022 | Web x / Android √ / iOS 4.11 / HarmonyOS 4.61(部分支持,见上) | 参数无效 |
1815
+ | 1300066 | Web x / Android √ / iOS 4.11 / HarmonyOS 4.61(部分支持,见上) | 目录非空 |
1816
+ | 1301003 | Web x / Android √ / iOS 4.61 / HarmonyOS 4.61(部分支持,见上) | 对目录的非法操作 |
1817
+ | 1301005 | Web x / Android √ / iOS 4.11 / HarmonyOS 4.61(部分支持,见上) | 文件已存在 |
1818
+ | 1300201 | Web x / Android √ / iOS 4.11 / HarmonyOS 4.61(部分支持,见上) | 系统错误 |
1819
+ | 1300202 | Web x / Android √ / iOS 4.61 / HarmonyOS 4.61(部分支持,见上) | 超出文件存储限制的最大尺寸 |
1820
+ | 1301111 | Web x / Android 4.13 / iOS x / HarmonyOS 4.61(部分支持,见上) | brotli解压失败 |
1821
+ | 1302003 | Web x / Android 4.13 / iOS 4.61 / HarmonyOS 4.61(部分支持,见上) | 标志无效 |
1822
+ | 1300009 | Web x / Android 4.13 / iOS 4.61 / HarmonyOS 4.61(部分支持,见上) | 文件描述符错误 |
1823
+ | 1300010 | Web x / Android x / iOS x / HarmonyOS 4.61(部分支持,见上) | 重试 |
1824
+ | 1300011 | Web x / Android x / iOS 4.61 / HarmonyOS 4.61(部分支持,见上) | 错误的地址 |
1825
+ | 1300012 | Web x / Android x / iOS x / HarmonyOS 4.61(部分支持,见上) | 操作阻塞 |
1826
+ | 1300015 | Web x / Android x / iOS 4.61 / HarmonyOS 4.61(部分支持,见上) | 未知错误 |
1827
+ | 1300014 | Web x / Android x / iOS x / HarmonyOS 4.61(部分支持,见上) | 网络不可达 |
1828
+ | 1300016 | Web x / Android x / iOS 4.61 / HarmonyOS 4.61(部分支持,见上) | 不是文件夹 |
1829
+ | 1300017 | Web x / Android x / iOS 4.61 / HarmonyOS 4.61(部分支持,见上) | 文本文件繁忙 |
1830
+ | 1300018 | Web x / Android x / iOS 4.61 / HarmonyOS 4.61(部分支持,见上) | 文件太大 |
1831
+ | 1300019 | Web x / Android x / iOS 4.61 / HarmonyOS 4.61(部分支持,见上) | 只读文件系统 |
1832
+ | 1300020 | Web x / Android x / iOS 4.61 / HarmonyOS 4.61(部分支持,见上) | 文件名称太长 |
1833
+ | 1300033 | Web x / Android x / iOS x / HarmonyOS 4.61(部分支持,见上) | 过多符号链接 |
1834
+ | errSubject | string | 是 | Web x(部分支持,见上) | 统一错误主题(模块)名称 |
1835
+ | data | any | 否 | Web x(部分支持,见上) | 错误信息中包含的数据 |
1836
+ | cause | Error | 否 | | 源错误信息,可以包含多个错误,详见SourceError |
1837
+ | errMsg | string | 是 | Web x(部分支持,见上) | |
1838
+
1839
+ #### truncateSync(filePath: string, length?: number): void; @truncatesync
1840
+ truncateSync
1841
+ 对文件内容进行截断操作 (truncate 的同步版本)
1842
+ ##### truncateSync 兼容性
1843
+ | Web | 微信小程序 | Android | iOS | HarmonyOS |
1844
+ | :- | :- | :- | :- | :- |
1845
+ | x | 4.41 | 4.13 | 4.61 | 4.61 |
1846
+
1847
+ ##### 参数
1848
+
1849
+ | 名称 | 类型 | 必填 | 兼容性 | 描述 |
1850
+ | :- | :- | :- | :-: | :- |
1851
+ | filePath | string | 是 | Web x(部分支持,见上) | 要截断的文件路径 (本地路径) |
1852
+ | length | number | 否 | Web x(部分支持,见上) | 截断位置,默认0。如果 length 小于文件长度(字节),则只有前面 length 个字节会保留在文件中,其余内容会被删除;如果 length 大于文件长度,不做处理 |
1853
+
1854
+ #### unlink(options: UnLinkOptions): void; @unlink
1855
+ unlink
1856
+ 删除文件
1857
+ ##### unlink 兼容性
1858
+ | Web | 微信小程序 | Android | iOS | HarmonyOS |
1859
+ | :- | :- | :- | :- | :- |
1860
+ | x | 4.41 | 3.9.0 | 4.11 | 4.61 |
1861
+
1862
+ ##### 参数
1863
+
1864
+ | 名称 | 类型 | 必填 | 兼容性 |
1865
+ | :- | :- | :- | :-: |
1866
+ | options | **UnLinkOptions** | 是 | Web x(部分支持,见上) |
1867
+ | 名称 | 类型 | 必备 | 兼容性 | 描述 |
1868
+ | :- | :- | :- | :-: | :- |
1869
+ | filePath | string.URIString | 是 | Web x(部分支持,见上) | 文件路径,只支持绝对地址 |
1870
+ | success | (res: FileManagerSuccessResult) => void | 否 | Web x(部分支持,见上) | 接口调用的回调函数 |
1871
+ | fail | (res: [FileSystemManagerFail](#filesystemmanagerfail-values)) => void | 否 | Web x(部分支持,见上) | 通用的错误返回结果回调 |
1872
+ | complete | (res: any) => void | 否 | Web x(部分支持,见上) | 通用的结束返回结果回调 |
1873
+
1874
+ ###### FileSystemManagerFail 的属性值 @filesystemmanagerfail-values
1875
+
1876
+ | 名称 | 类型 | 必备 | 兼容性 | 描述 |
1877
+ | :- | :- | :- | :-: | :- |
1878
+ | errCode | number | 是 | Web x(部分支持,见上) | 错误码 |
1879
+ | 合法值 | 兼容性 | 描述 |
1880
+ | :- | :-: | :- |
1881
+ | 1200002 | Web x / Android √ / iOS 4.61 / HarmonyOS 4.61(部分支持,见上) | 类型错误。仅支持 base64 / utf-8 / ascii |
1882
+ | 1300002 | Web x / Android √ / iOS 4.11 / HarmonyOS 4.61(部分支持,见上) | 未找到文件 |
1883
+ | 1300013 | Web x / Android √ / iOS 4.11 / HarmonyOS 4.61(部分支持,见上) | 无权限 |
1884
+ | 1300021 | Web x / Android √ / iOS 4.61 / HarmonyOS 4.61(部分支持,见上) | 是目录 |
1885
+ | 1300022 | Web x / Android √ / iOS 4.11 / HarmonyOS 4.61(部分支持,见上) | 参数无效 |
1886
+ | 1300066 | Web x / Android √ / iOS 4.11 / HarmonyOS 4.61(部分支持,见上) | 目录非空 |
1887
+ | 1301003 | Web x / Android √ / iOS 4.61 / HarmonyOS 4.61(部分支持,见上) | 对目录的非法操作 |
1888
+ | 1301005 | Web x / Android √ / iOS 4.11 / HarmonyOS 4.61(部分支持,见上) | 文件已存在 |
1889
+ | 1300201 | Web x / Android √ / iOS 4.11 / HarmonyOS 4.61(部分支持,见上) | 系统错误 |
1890
+ | 1300202 | Web x / Android √ / iOS 4.61 / HarmonyOS 4.61(部分支持,见上) | 超出文件存储限制的最大尺寸 |
1891
+ | 1301111 | Web x / Android 4.13 / iOS x / HarmonyOS 4.61(部分支持,见上) | brotli解压失败 |
1892
+ | 1302003 | Web x / Android 4.13 / iOS 4.61 / HarmonyOS 4.61(部分支持,见上) | 标志无效 |
1893
+ | 1300009 | Web x / Android 4.13 / iOS 4.61 / HarmonyOS 4.61(部分支持,见上) | 文件描述符错误 |
1894
+ | 1300010 | Web x / Android x / iOS x / HarmonyOS 4.61(部分支持,见上) | 重试 |
1895
+ | 1300011 | Web x / Android x / iOS 4.61 / HarmonyOS 4.61(部分支持,见上) | 错误的地址 |
1896
+ | 1300012 | Web x / Android x / iOS x / HarmonyOS 4.61(部分支持,见上) | 操作阻塞 |
1897
+ | 1300015 | Web x / Android x / iOS 4.61 / HarmonyOS 4.61(部分支持,见上) | 未知错误 |
1898
+ | 1300014 | Web x / Android x / iOS x / HarmonyOS 4.61(部分支持,见上) | 网络不可达 |
1899
+ | 1300016 | Web x / Android x / iOS 4.61 / HarmonyOS 4.61(部分支持,见上) | 不是文件夹 |
1900
+ | 1300017 | Web x / Android x / iOS 4.61 / HarmonyOS 4.61(部分支持,见上) | 文本文件繁忙 |
1901
+ | 1300018 | Web x / Android x / iOS 4.61 / HarmonyOS 4.61(部分支持,见上) | 文件太大 |
1902
+ | 1300019 | Web x / Android x / iOS 4.61 / HarmonyOS 4.61(部分支持,见上) | 只读文件系统 |
1903
+ | 1300020 | Web x / Android x / iOS 4.61 / HarmonyOS 4.61(部分支持,见上) | 文件名称太长 |
1904
+ | 1300033 | Web x / Android x / iOS x / HarmonyOS 4.61(部分支持,见上) | 过多符号链接 |
1905
+ | errSubject | string | 是 | Web x(部分支持,见上) | 统一错误主题(模块)名称 |
1906
+ | data | any | 否 | Web x(部分支持,见上) | 错误信息中包含的数据 |
1907
+ | cause | Error | 否 | | 源错误信息,可以包含多个错误,详见SourceError |
1908
+ | errMsg | string | 是 | Web x(部分支持,见上) | |
1909
+
1910
+ #### unlinkSync(filePath: string): void; @unlinksync
1911
+ unlinkSync
1912
+ FileSystemManager.unlink 的同步版本
1913
+ ##### unlinkSync 兼容性
1914
+ | Web | 微信小程序 | Android | iOS | HarmonyOS |
1915
+ | :- | :- | :- | :- | :- |
1916
+ | x | 4.41 | 4.13 | 4.61 | 4.61 |
1917
+
1918
+ ##### 参数
1919
+
1920
+ | 名称 | 类型 | 必填 | 兼容性 | 描述 |
1921
+ | :- | :- | :- | :-: | :- |
1922
+ | filePath | string | 是 | Web x(部分支持,见上) | 文件路径,只支持绝对地址 |
1923
+
1924
+ #### unzip(options: UnzipFileOptions): void; @unzip
1925
+ unzip
1926
+ 解压文件
1927
+ ##### unzip 兼容性
1928
+ | Web | 微信小程序 | Android | iOS | HarmonyOS |
1929
+ | :- | :- | :- | :- | :- |
1930
+ | x | 4.41 | 4.13 | 4.61 | 4.61 |
1931
+
1932
+ ##### 参数
1933
+
1934
+ | 名称 | 类型 | 必填 | 兼容性 |
1935
+ | :- | :- | :- | :-: |
1936
+ | options | **UnzipFileOptions** | 是 | Web x(部分支持,见上) |
1937
+ | 名称 | 类型 | 必备 | 兼容性 | 描述 |
1938
+ | :- | :- | :- | :-: | :- |
1939
+ | zipFilePath | string | 是 | Web x(部分支持,见上) | 源文件路径,支持本地路径, 只可以是 zip 压缩文件 |
1940
+ | targetPath | string | 是 | Web x(部分支持,见上) | 目标目录路径, 支持本地路径 |
1941
+ | success | (res: FileManagerSuccessResult) => void | 否 | Web x(部分支持,见上) | 通用的正确返回结果回调 |
1942
+ | fail | (res: [FileSystemManagerFail](#filesystemmanagerfail-values)) => void | 否 | Web x(部分支持,见上) | 通用的错误返回结果回调 |
1943
+ | complete | (res: any) => void | 否 | Web x(部分支持,见上) | 通用的结束返回结果回调 |
1944
+
1945
+ ###### FileSystemManagerFail 的属性值 @filesystemmanagerfail-values
1946
+
1947
+ | 名称 | 类型 | 必备 | 兼容性 | 描述 |
1948
+ | :- | :- | :- | :-: | :- |
1949
+ | errCode | number | 是 | Web x(部分支持,见上) | 错误码 |
1950
+ | 合法值 | 兼容性 | 描述 |
1951
+ | :- | :-: | :- |
1952
+ | 1200002 | Web x / Android √ / iOS 4.61 / HarmonyOS 4.61(部分支持,见上) | 类型错误。仅支持 base64 / utf-8 / ascii |
1953
+ | 1300002 | Web x / Android √ / iOS 4.11 / HarmonyOS 4.61(部分支持,见上) | 未找到文件 |
1954
+ | 1300013 | Web x / Android √ / iOS 4.11 / HarmonyOS 4.61(部分支持,见上) | 无权限 |
1955
+ | 1300021 | Web x / Android √ / iOS 4.61 / HarmonyOS 4.61(部分支持,见上) | 是目录 |
1956
+ | 1300022 | Web x / Android √ / iOS 4.11 / HarmonyOS 4.61(部分支持,见上) | 参数无效 |
1957
+ | 1300066 | Web x / Android √ / iOS 4.11 / HarmonyOS 4.61(部分支持,见上) | 目录非空 |
1958
+ | 1301003 | Web x / Android √ / iOS 4.61 / HarmonyOS 4.61(部分支持,见上) | 对目录的非法操作 |
1959
+ | 1301005 | Web x / Android √ / iOS 4.11 / HarmonyOS 4.61(部分支持,见上) | 文件已存在 |
1960
+ | 1300201 | Web x / Android √ / iOS 4.11 / HarmonyOS 4.61(部分支持,见上) | 系统错误 |
1961
+ | 1300202 | Web x / Android √ / iOS 4.61 / HarmonyOS 4.61(部分支持,见上) | 超出文件存储限制的最大尺寸 |
1962
+ | 1301111 | Web x / Android 4.13 / iOS x / HarmonyOS 4.61(部分支持,见上) | brotli解压失败 |
1963
+ | 1302003 | Web x / Android 4.13 / iOS 4.61 / HarmonyOS 4.61(部分支持,见上) | 标志无效 |
1964
+ | 1300009 | Web x / Android 4.13 / iOS 4.61 / HarmonyOS 4.61(部分支持,见上) | 文件描述符错误 |
1965
+ | 1300010 | Web x / Android x / iOS x / HarmonyOS 4.61(部分支持,见上) | 重试 |
1966
+ | 1300011 | Web x / Android x / iOS 4.61 / HarmonyOS 4.61(部分支持,见上) | 错误的地址 |
1967
+ | 1300012 | Web x / Android x / iOS x / HarmonyOS 4.61(部分支持,见上) | 操作阻塞 |
1968
+ | 1300015 | Web x / Android x / iOS 4.61 / HarmonyOS 4.61(部分支持,见上) | 未知错误 |
1969
+ | 1300014 | Web x / Android x / iOS x / HarmonyOS 4.61(部分支持,见上) | 网络不可达 |
1970
+ | 1300016 | Web x / Android x / iOS 4.61 / HarmonyOS 4.61(部分支持,见上) | 不是文件夹 |
1971
+ | 1300017 | Web x / Android x / iOS 4.61 / HarmonyOS 4.61(部分支持,见上) | 文本文件繁忙 |
1972
+ | 1300018 | Web x / Android x / iOS 4.61 / HarmonyOS 4.61(部分支持,见上) | 文件太大 |
1973
+ | 1300019 | Web x / Android x / iOS 4.61 / HarmonyOS 4.61(部分支持,见上) | 只读文件系统 |
1974
+ | 1300020 | Web x / Android x / iOS 4.61 / HarmonyOS 4.61(部分支持,见上) | 文件名称太长 |
1975
+ | 1300033 | Web x / Android x / iOS x / HarmonyOS 4.61(部分支持,见上) | 过多符号链接 |
1976
+ | errSubject | string | 是 | Web x(部分支持,见上) | 统一错误主题(模块)名称 |
1977
+ | data | any | 否 | Web x(部分支持,见上) | 错误信息中包含的数据 |
1978
+ | cause | Error | 否 | | 源错误信息,可以包含多个错误,详见SourceError |
1979
+ | errMsg | string | 是 | Web x(部分支持,见上) | |
1980
+
1981
+ #### writeFile(options: WriteFileOptions): void; @writefile
1982
+ writeFile
1983
+ 写文件
1984
+ ##### writeFile 兼容性
1985
+ | Web | 微信小程序 | Android | iOS | HarmonyOS |
1986
+ | :- | :- | :- | :- | :- |
1987
+ | x | 4.41 | 3.9.0 | 4.11 | 4.61 |
1988
+
1989
+ ##### 参数
1990
+
1991
+ | 名称 | 类型 | 必填 | 兼容性 |
1992
+ | :- | :- | :- | :-: |
1993
+ | options | **WriteFileOptions** | 是 | Web x(部分支持,见上) |
1994
+ | 名称 | 类型 | 必备 | 兼容性 | 描述 |
1995
+ | :- | :- | :- | :-: | :- |
1996
+ | filePath | string.URIString | 是 | Web x(部分支持,见上) | 文件路径,只支持绝对地址 |
1997
+ | encoding | string | 否 | Web x(部分支持,见上) | 指定写入文件的字符编码,<br/>支持:ascii base64 utf-8,默认值是 utf-8,仅在 data 类型是 String 时有效 |
1998
+ @@| 合法值 | 兼容性 | 描述 |
1999
+ @@| :- | :-: | :- |
2000
+ @@| ascii | Web x(部分支持,见上) | ascii 编码格式 |
2001
+ @@| base64 | Web x(部分支持,见上) | base64 编码格式 |
2002
+ @@| utf-8 | Web x(部分支持,见上) | utf-8 编码格式,默认值 |
2003
+ | data | string \| ArrayBuffer | 是 | Web x / 微信小程序 4.41 / Android 4.31 / iOS 4.11 / HarmonyOS 4.61(部分支持,见上) | 写入的内容,类型为 String 或 ArrayBuffer,之前类型是string,iOS平台4.61及以后、Android平台4.31及以后支持ArrayBuffer类型 |
2004
+ | success | (res: FileManagerSuccessResult) => void | 否 | Web x(部分支持,见上) | 通用的正确返回结果回调 |
2005
+ | fail | (res: [FileSystemManagerFail](#filesystemmanagerfail-values)) => void | 否 | Web x(部分支持,见上) | 通用的错误返回结果回调 |
2006
+ | complete | (res: any) => void | 否 | Web x(部分支持,见上) | 通用的结束返回结果回调 |
2007
+
2008
+ ###### FileSystemManagerFail 的属性值 @filesystemmanagerfail-values
2009
+
2010
+ | 名称 | 类型 | 必备 | 兼容性 | 描述 |
2011
+ | :- | :- | :- | :-: | :- |
2012
+ | errCode | number | 是 | Web x(部分支持,见上) | 错误码 |
2013
+ | 合法值 | 兼容性 | 描述 |
2014
+ | :- | :-: | :- |
2015
+ | 1200002 | Web x / Android √ / iOS 4.61 / HarmonyOS 4.61(部分支持,见上) | 类型错误。仅支持 base64 / utf-8 / ascii |
2016
+ | 1300002 | Web x / Android √ / iOS 4.11 / HarmonyOS 4.61(部分支持,见上) | 未找到文件 |
2017
+ | 1300013 | Web x / Android √ / iOS 4.11 / HarmonyOS 4.61(部分支持,见上) | 无权限 |
2018
+ | 1300021 | Web x / Android √ / iOS 4.61 / HarmonyOS 4.61(部分支持,见上) | 是目录 |
2019
+ | 1300022 | Web x / Android √ / iOS 4.11 / HarmonyOS 4.61(部分支持,见上) | 参数无效 |
2020
+ | 1300066 | Web x / Android √ / iOS 4.11 / HarmonyOS 4.61(部分支持,见上) | 目录非空 |
2021
+ | 1301003 | Web x / Android √ / iOS 4.61 / HarmonyOS 4.61(部分支持,见上) | 对目录的非法操作 |
2022
+ | 1301005 | Web x / Android √ / iOS 4.11 / HarmonyOS 4.61(部分支持,见上) | 文件已存在 |
2023
+ | 1300201 | Web x / Android √ / iOS 4.11 / HarmonyOS 4.61(部分支持,见上) | 系统错误 |
2024
+ | 1300202 | Web x / Android √ / iOS 4.61 / HarmonyOS 4.61(部分支持,见上) | 超出文件存储限制的最大尺寸 |
2025
+ | 1301111 | Web x / Android 4.13 / iOS x / HarmonyOS 4.61(部分支持,见上) | brotli解压失败 |
2026
+ | 1302003 | Web x / Android 4.13 / iOS 4.61 / HarmonyOS 4.61(部分支持,见上) | 标志无效 |
2027
+ | 1300009 | Web x / Android 4.13 / iOS 4.61 / HarmonyOS 4.61(部分支持,见上) | 文件描述符错误 |
2028
+ | 1300010 | Web x / Android x / iOS x / HarmonyOS 4.61(部分支持,见上) | 重试 |
2029
+ | 1300011 | Web x / Android x / iOS 4.61 / HarmonyOS 4.61(部分支持,见上) | 错误的地址 |
2030
+ | 1300012 | Web x / Android x / iOS x / HarmonyOS 4.61(部分支持,见上) | 操作阻塞 |
2031
+ | 1300015 | Web x / Android x / iOS 4.61 / HarmonyOS 4.61(部分支持,见上) | 未知错误 |
2032
+ | 1300014 | Web x / Android x / iOS x / HarmonyOS 4.61(部分支持,见上) | 网络不可达 |
2033
+ | 1300016 | Web x / Android x / iOS 4.61 / HarmonyOS 4.61(部分支持,见上) | 不是文件夹 |
2034
+ | 1300017 | Web x / Android x / iOS 4.61 / HarmonyOS 4.61(部分支持,见上) | 文本文件繁忙 |
2035
+ | 1300018 | Web x / Android x / iOS 4.61 / HarmonyOS 4.61(部分支持,见上) | 文件太大 |
2036
+ | 1300019 | Web x / Android x / iOS 4.61 / HarmonyOS 4.61(部分支持,见上) | 只读文件系统 |
2037
+ | 1300020 | Web x / Android x / iOS 4.61 / HarmonyOS 4.61(部分支持,见上) | 文件名称太长 |
2038
+ | 1300033 | Web x / Android x / iOS x / HarmonyOS 4.61(部分支持,见上) | 过多符号链接 |
2039
+ | errSubject | string | 是 | Web x(部分支持,见上) | 统一错误主题(模块)名称 |
2040
+ | data | any | 否 | Web x(部分支持,见上) | 错误信息中包含的数据 |
2041
+ | cause | Error | 否 | | 源错误信息,可以包含多个错误,详见SourceError |
2042
+ | errMsg | string | 是 | Web x(部分支持,见上) | |
2043
+
2044
+ #### writeFileSync(filePath: string, data: string \| ArrayBuffer, encoding?: string): void; @writefilesync
2045
+ writeFileSync
2046
+ FileSystemManager.writeFile 的同步版本
2047
+ ##### writeFileSync 兼容性
2048
+ | Web | 微信小程序 | Android | iOS | HarmonyOS |
2049
+ | :- | :- | :- | :- | :- |
2050
+ | x | 4.41 | 4.13 | 4.61 | 4.51 |
2051
+
2052
+ ##### 参数
2053
+
2054
+ | 名称 | 类型 | 必填 | 兼容性 | 描述 |
2055
+ | :- | :- | :- | :-: | :- |
2056
+ | filePath | string | 是 | Web x(部分支持,见上) | 文件路径,只支持绝对地址 |
2057
+ | data | string \| ArrayBuffer | 是 | Web x(部分支持,见上) | 要写入的文本或二进制数据,Android平台4.31、iOS平台4.61及以后版本支持ArrayBuffer |
2058
+ | encoding | string | 否 | Web x(部分支持,见上) | 指定写入文件的字符编码,支持:ascii base64 utf-8, 默认值是utf-8, 仅在 data 类型是 String 时有效 |
2059
+
2060
+ #### write(options: WriteOptions): void; @write
2061
+ write
2062
+ 写入文件
2063
+ ##### write 兼容性
2064
+ | Web | 微信小程序 | Android | iOS | HarmonyOS |
2065
+ | :- | :- | :- | :- | :- |
2066
+ | x | 4.41 | 4.13 | 4.61 | 4.61 |
2067
+
2068
+ ##### 参数
2069
+
2070
+ | 名称 | 类型 | 必填 | 兼容性 |
2071
+ | :- | :- | :- | :-: |
2072
+ | options | **WriteOptions** | 是 | Web x(部分支持,见上) |
2073
+ | 名称 | 类型 | 必备 | 默认值 | 兼容性 | 描述 |
2074
+ | :- | :- | :- | :- | :-: | :- |
2075
+ | fd | string | 是 | | Web x(部分支持,见上) | 文件描述符。fd 通过 FileSystemManager.open 或 FileSystemManager.openSync 接口获得 |
2076
+ | data | string \| ArrayBuffer | 是 | | Web x / 微信小程序 4.41 / Android 4.31 / iOS 4.61 / HarmonyOS 4.61(部分支持,见上) | 写入的内容,类型为 String 或 ArrayBuffer,以前类型是string,iOS平台4.61、Android平台4.31及以后支持ArrayBuffer |
2077
+ | offset | number | 否 | 0 | Web x / 微信小程序 4.41 / Android 4.31 / iOS 4.61 / HarmonyOS 4.61(部分支持,见上) | Android平台4.31及以后版本新增,只在 data 类型是 ArrayBuffer 时有效,决定 ArrayBuffer 中要被写入的部位,即 ArrayBuffer 中的索引,默认0 |
2078
+ | length | number | 否 | | Web x / 微信小程序 4.41 / Android 4.31 / iOS 4.61 / HarmonyOS 4.61(部分支持,见上) | Android平台4.31及以后版本新增,只在 data 类型是 ArrayBuffer 时有效,指定要写入的字节数,默认为 ArrayBuffer 从0开始偏移 offset 个字节后剩余的字节数 |
2079
+ | position | number | 否 | | Web x / 微信小程序 4.41 / Android 4.31 / iOS x / HarmonyOS 4.61(部分支持,见上) | Andorid平台4.31及以后版本新增,指定文件开头的偏移量,即数据要被写入的位置。当 position 不传或者传入非 Number 类型的值时,数据会被写入当前指针所在位置。 |
2080
+ | encoding | string | 否 | | Web x(部分支持,见上) | 只在 data 类型是 String 时有效,指定写入文件的字符编码,默认为 utf8<br/>支持:ascii base64 utf-8 |
2081
+ @@| 合法值 | 兼容性 | 描述 |
2082
+ @@| :- | :-: | :- |
2083
+ @@| ascii | Web x(部分支持,见上) | ascii 字符编码 |
2084
+ @@| base64 | Web x(部分支持,见上) | base64 字符编码 |
2085
+ @@| utf-8 | Web x(部分支持,见上) | utf-8 字符编码,默认值 |
2086
+ | success | (res: [WriteResult](#writeresult-values)) => void | 否 | | Web x(部分支持,见上) | 接口调用的回调函数 |
2087
+ | fail | (res: [FileSystemManagerFail](#filesystemmanagerfail-values)) => void | 否 | | Web x(部分支持,见上) | 通用的错误返回结果回调 |
2088
+ | complete | (res: any) => void | 否 | | Web x(部分支持,见上) | 通用的结束返回结果回调 |
2089
+
2090
+ ###### WriteResult 的属性值 @writeresult-values
2091
+
2092
+ | 名称 | 类型 | 必备 | 兼容性 | 描述 |
2093
+ | :- | :- | :- | :-: | :- |
2094
+ | bytesWritten | number | 是 | Web x(部分支持,见上) | 实际被写入到文件中的字节数(注意,被写入的字节数不一定与被写入的字符串字符数相同) |
2095
+
2096
+ ###### FileSystemManagerFail 的属性值 @filesystemmanagerfail-values
2097
+
2098
+ | 名称 | 类型 | 必备 | 兼容性 | 描述 |
2099
+ | :- | :- | :- | :-: | :- |
2100
+ | errCode | number | 是 | Web x(部分支持,见上) | 错误码 |
2101
+ | 合法值 | 兼容性 | 描述 |
2102
+ | :- | :-: | :- |
2103
+ | 1200002 | Web x / Android √ / iOS 4.61 / HarmonyOS 4.61(部分支持,见上) | 类型错误。仅支持 base64 / utf-8 / ascii |
2104
+ | 1300002 | Web x / Android √ / iOS 4.11 / HarmonyOS 4.61(部分支持,见上) | 未找到文件 |
2105
+ | 1300013 | Web x / Android √ / iOS 4.11 / HarmonyOS 4.61(部分支持,见上) | 无权限 |
2106
+ | 1300021 | Web x / Android √ / iOS 4.61 / HarmonyOS 4.61(部分支持,见上) | 是目录 |
2107
+ | 1300022 | Web x / Android √ / iOS 4.11 / HarmonyOS 4.61(部分支持,见上) | 参数无效 |
2108
+ | 1300066 | Web x / Android √ / iOS 4.11 / HarmonyOS 4.61(部分支持,见上) | 目录非空 |
2109
+ | 1301003 | Web x / Android √ / iOS 4.61 / HarmonyOS 4.61(部分支持,见上) | 对目录的非法操作 |
2110
+ | 1301005 | Web x / Android √ / iOS 4.11 / HarmonyOS 4.61(部分支持,见上) | 文件已存在 |
2111
+ | 1300201 | Web x / Android √ / iOS 4.11 / HarmonyOS 4.61(部分支持,见上) | 系统错误 |
2112
+ | 1300202 | Web x / Android √ / iOS 4.61 / HarmonyOS 4.61(部分支持,见上) | 超出文件存储限制的最大尺寸 |
2113
+ | 1301111 | Web x / Android 4.13 / iOS x / HarmonyOS 4.61(部分支持,见上) | brotli解压失败 |
2114
+ | 1302003 | Web x / Android 4.13 / iOS 4.61 / HarmonyOS 4.61(部分支持,见上) | 标志无效 |
2115
+ | 1300009 | Web x / Android 4.13 / iOS 4.61 / HarmonyOS 4.61(部分支持,见上) | 文件描述符错误 |
2116
+ | 1300010 | Web x / Android x / iOS x / HarmonyOS 4.61(部分支持,见上) | 重试 |
2117
+ | 1300011 | Web x / Android x / iOS 4.61 / HarmonyOS 4.61(部分支持,见上) | 错误的地址 |
2118
+ | 1300012 | Web x / Android x / iOS x / HarmonyOS 4.61(部分支持,见上) | 操作阻塞 |
2119
+ | 1300015 | Web x / Android x / iOS 4.61 / HarmonyOS 4.61(部分支持,见上) | 未知错误 |
2120
+ | 1300014 | Web x / Android x / iOS x / HarmonyOS 4.61(部分支持,见上) | 网络不可达 |
2121
+ | 1300016 | Web x / Android x / iOS 4.61 / HarmonyOS 4.61(部分支持,见上) | 不是文件夹 |
2122
+ | 1300017 | Web x / Android x / iOS 4.61 / HarmonyOS 4.61(部分支持,见上) | 文本文件繁忙 |
2123
+ | 1300018 | Web x / Android x / iOS 4.61 / HarmonyOS 4.61(部分支持,见上) | 文件太大 |
2124
+ | 1300019 | Web x / Android x / iOS 4.61 / HarmonyOS 4.61(部分支持,见上) | 只读文件系统 |
2125
+ | 1300020 | Web x / Android x / iOS 4.61 / HarmonyOS 4.61(部分支持,见上) | 文件名称太长 |
2126
+ | 1300033 | Web x / Android x / iOS x / HarmonyOS 4.61(部分支持,见上) | 过多符号链接 |
2127
+ | errSubject | string | 是 | Web x(部分支持,见上) | 统一错误主题(模块)名称 |
2128
+ | data | any | 否 | Web x(部分支持,见上) | 错误信息中包含的数据 |
2129
+ | cause | Error | 否 | | 源错误信息,可以包含多个错误,详见SourceError |
2130
+ | errMsg | string | 是 | Web x(部分支持,见上) | |
2131
+
2132
+ #### writeSync(options: WriteSyncOptions): WriteResult; @writesync
2133
+ writeSync
2134
+ 同步写入文件
2135
+ ##### writeSync 兼容性
2136
+ | Web | 微信小程序 | Android | iOS | HarmonyOS |
2137
+ | :- | :- | :- | :- | :- |
2138
+ | x | 4.41 | 4.13 | 4.61 | 4.61 |
2139
+
2140
+ ##### 参数
2141
+
2142
+ | 名称 | 类型 | 必填 | 兼容性 |
2143
+ | :- | :- | :- | :-: |
2144
+ | options | **WriteSyncOptions** | 是 | Web x(部分支持,见上) |
2145
+ | 名称 | 类型 | 必备 | 兼容性 | 描述 |
2146
+ | :- | :- | :- | :-: | :- |
2147
+ | fd | string | 是 | Web x(部分支持,见上) | 文件描述符。fd 通过 FileSystemManager.open 或 FileSystemManager.openSync 接口获得 |
2148
+ | data | string \| ArrayBuffer | 是 | Web x / 微信小程序 4.41 / Android 4.31 / iOS 4.61 / HarmonyOS 4.61(部分支持,见上) | 写入的内容,类型为 String 或 ArrayBuffer,以前类型是string,Android平台4.31、iOS平台4.61起支持ArrayBuffer类型 |
2149
+ | encoding | string | 否 | Web x(部分支持,见上) | 只在 data 类型是 String 时有效,指定写入文件的字符编码,默认为 utf8<br/>支持:ascii base64 utf-8 |
2150
+ @@| 合法值 | 兼容性 | 描述 |
2151
+ @@| :- | :-: | :- |
2152
+ @@| ascii | Web x(部分支持,见上) | ascii 字符编码 |
2153
+ @@| base64 | Web x(部分支持,见上) | base64 字符编码 |
2154
+ @@| utf-8 | Web x(部分支持,见上) | utf-8 字符编码,默认值 |
2155
+ | length | number | 否 | Web x / 微信小程序 4.41 / Android 4.31 / iOS x / HarmonyOS 4.61(部分支持,见上) | 只在 data 类型是 ArrayBuffer 时有效,指定要写入的字节数,默认为 arrayBuffer 从0开始偏移 offset 个字节后剩余的字节数 ,4.31及以后版本新增 |
2156
+ | offset | number | 否 | Web x / 微信小程序 4.41 / Android 4.31 / iOS x / HarmonyOS 4.61(部分支持,见上) | 只在 data 类型是 ArrayBuffer 时有效,决定 arrayBuffer 中要被写入的部位,即 arrayBuffer 中的索引,默认0,4.31及以后版本新增 |
2157
+ | position | number | 否 | Web x / 微信小程序 4.41 / Android 4.31 / iOS x / HarmonyOS 4.61(部分支持,见上) | 指定文件开头的偏移量,即数据要被写入的位置。当 position 不传或者传入非 Number 类型的值时,数据会被写入当前指针所在位置。4.31及以后版本新增 |
2158
+
2159
+ ##### 返回值
2160
+
2161
+ | 类型 |
2162
+ | :- |
2163
+ | **WriteResult** |
2164
+ | 名称 | 类型 | 必备 | 兼容性 | 描述 |
2165
+ | :- | :- | :- | :-: | :- |
2166
+ | bytesWritten | number | 是 | Web x(部分支持,见上) | 实际被写入到文件中的字节数(注意,被写入的字节数不一定与被写入的字符串字符数相同) |
2167
+
2168
+ ### 特殊说明
2169
+
2170
+ - app-ios平台4.11版本之前支持的api仅支持在uvue文件中使用文件管理器对象,uts插件中暂不支持; 4.61版本后,所有api都支持在uts插件和uvue文件中使用,具体请查看兼容性
2171
+
2172
+ - app-android平台API不支持代码包文件目录
2173
+
2174
+ - app-android平台content:/\/ 路径文件是只读的
2175
+
2176
+ ### 参见
2177
+ - [相关 Bug](https://issues.dcloud.net.cn/?mid=api.file.getFileSystemManager)
2178
+ - [参见uni-app相关文档](https://uniapp.dcloud.net.cn/api/file/getFileSystemManager.html#getfilesystemmanager)
2179
+ - [微信小程序文档](https://developers.weixin.qq.com/miniprogram/dev/api/file/FileSystemManager.html)
2180
+ - [支付宝小程序文档](https://open.alipay.com/portal/zhichi/search?keyword=getFileSystemManager&pageIndex=1&pageSize=10&source=doc_top&type=all)
2181
+ - [百度小程序文档](https://smartprogram.baidu.com/forum/search?query=getFileSystemManager&scope=devdocs&source=docs)
2182
+ - [抖音小程序文档](https://developer.open-douyin.com/search-page?keyword=getFileSystemManager&secondType=all&type=1)
2183
+ - [飞书小程序文档](https://open.feishu.cn/search?from=header&page=1&pageSize=10&q=getFileSystemManager&topicFilter=)
2184
+ - [钉钉小程序文档](https://open.dingtalk.com/search?keyword=getFileSystemManager)
2185
+ - [QQ小程序文档](https://q.qq.com/wiki/develop/miniprogram/frame/)
2186
+ - [快手小程序文档](https://developers.kuaishou.com/page?keyword=getFileSystemManager&from=docs)
2187
+ - [京东小程序文档](https://mp-docs.jd.com/doc/dev/framework/-1)
2188
+ - [华为快应用文档](https://developer.huawei.com/consumer/cn/doc/quickApp-References/webview-frame-overview-0000001124793625)
2189
+ - [360小程序文档](https://mp.360.cn/doc/miniprogram/dev/#/b770a184ff1f06c6b3393a0fd1132380)
2190
+
2191
+ ### 示例
2192
+
2193
+ 示例为[hello uni-app x alpha分支](https://gitcode.com/dcloud/hello-uni-app-x/blob/prod_alpha/pages/API/get-file-system-manager/get-file-system-manager.uvue),与最新HBuilderX Alpha版同步。与最新正式版同步的master分支示例[另见](https://gitcode.com/dcloud/hello-uni-app-x/blob/master//pages/API/get-file-system-manager/get-file-system-manager.uvue)
2194
+ >
2195
+ > 该 API 不支持 Web,请运行 hello uni-app x 到 App 平台体验
2196
+
2197
+ ::: preview
2198
+ > appRedirect https://hellouniappx.dcloud.net.cn/appredirect.html?path=pages/API/get-file-system-manager/get-file-system-manager
2199
+ ```uvue
2200
+ <template>
2201
+
2202
+ <page-intro content="本页演示文件系统 API:递归获取目录、创建文件夹、读写/复制/重命名/删除文件、同步与异步接口等,操作结果在日志区展示。"></page-intro>
2203
+ <text>显示简易操作日志(可滚动查看),详细日志需真机运行查看</text><button size="mini" @click="data.log=''">清空日志</button>
2204
+ <scroll-view style="max-height: 300px;">
2205
+ <text style="margin: 2px; padding: 2px; border: 1px solid #000000;">{{ data.log }}</text>
2206
+ </scroll-view>
2207
+ <scroll-view style="flex: 1;">
2208
+
2209
+
2210
+ <text style="margin: 2px; padding: 2px; border: 1px solid #000000;">{{ data.log }}</text>
2211
+
2212
+ <button class="btnstyle" type="primary" @tap="statFileInfoTest"
2213
+ id="btn-stat-file">递归获取目录files的Stats对象{{data.statFile}}</button>
2214
+ <button class="btnstyle" type="primary" @tap="mkdirTest" id="btn-mkdir">创建文件夹{{data.mkdirFile}}</button>
2215
+ <button class="btnstyle" type="primary" @tap="writeFileTest" id="btn-write-file">覆盖写入文件{{data.writeFile}}</button>
2216
+ <button class="btnstyle" type="primary" @tap="readDirTest" id="btn-read-dir">读取文件夹{{data.readDir}}</button>
2217
+ <button class="btnstyle" type="primary" @tap="readFileTest" id="btn-read-file">读取文件{{data.readFile}}</button>
2218
+ <button class="btnstyle" type="primary" @tap="copyFileTest"
2219
+ id="btn-copy-file">复制文件{{data.copyFromFile}}到{{data.copyToFile}}</button>
2220
+ <button class="btnstyle" type="primary" @tap="renameFileTest"
2221
+ id="btn-rename-file">重命名文件{{data.renameFromFile}}到{{data.renameToFile}}</button>
2222
+ <button class="btnstyle" type="primary" @tap="accessFileTest"
2223
+ id="btn-access-file">判断文件{{data.accessFile}}是否存在</button>
2224
+ <button class="btnstyle" type="primary" @tap="getFileInfoTest"
2225
+ id="btn-get-file-info">获取文件信息{{data.getFileInfoFile}}</button>
2226
+ <button class="btnstyle" type="primary" @tap="unlinkTest" id="btn-unlink-file">删除文件{{data.unlinkFile}}</button>
2227
+ <button class="btnstyle" type="primary" @tap="unlinkAllFileTest"
2228
+ id="btn-clear-file">删除文件夹{{data.rmDirFile}}下的所有文件</button>
2229
+ <button class="btnstyle" type="primary" @tap="rmdirTest" id="btn-remove-dir">删除文件夹{{data.rmDirFile}}</button>
2230
+
2231
+ <button class="btnstyle" type="primary" @tap="statFileInfoSyncTest"
2232
+ id="btn-stat-file-sync">同步递归获取目录files的Stats对象{{data.statFile}}</button>
2233
+ <button class="btnstyle" type="primary" @tap="appendFileTest"
2234
+ id="btn-append-file">在文件{{data.readFile}}结尾追加内容</button>
2235
+ <button class="btnstyle" type="primary" @tap="appendFileSyncTest"
2236
+ id="btn-append-file-sync">同步在文件{{data.readFile}}结尾追加内容</button>
2237
+ <button class="btnstyle" type="primary" @tap="writeFileSyncTest"
2238
+ id="btn-write-file-sync">同步覆盖写入文件{{data.writeFile}}</button>
2239
+ <button class="btnstyle" type="primary" @tap="readFileSyncTest"
2240
+ id="btn-read-file-sync">同步读取文件{{data.readFile}}</button>
2241
+ <button class="btnstyle" type="primary" @tap="unlinkSyncTest"
2242
+ id="btn-unlink-file-sync">同步删除文件{{data.unlinkFile}}</button>
2243
+ <button class="btnstyle" type="primary" @tap="mkdirSyncTest" id="btn-mkdir-sync">同步创建文件夹{{data.mkdirFile}}</button>
2244
+ <button class="btnstyle" type="primary" @tap="rmdirSyncTest"
2245
+ id="btn-remove-dir-sync">同步删除文件夹{{data.rmDirFile}}</button>
2246
+ <button class="btnstyle" type="primary" @tap="readDirSyncTest"
2247
+ id="btn-read-dir-sync">同步读取文件夹{{data.readDir}}</button>
2248
+ <button class="btnstyle" type="primary" @tap="accessFileSyncTest"
2249
+ id="btn-access-file-sync">同步判断文件{{data.accessFile}}是否存在</button>
2250
+ <button class="btnstyle" type="primary" @tap="renameFileSync"
2251
+ id="btn-rename-file-sync">同步重命名文件{{data.renameFromFile}}到{{data.renameToFile}}</button>
2252
+ <button class="btnstyle" type="primary" @tap="copyFileSyncTest"
2253
+ id="btn-copy-file-sync">同步复制文件{{data.copyFromFile}}到{{data.copyToFile}}</button>
2254
+ <button class="btnstyle" type="primary" @tap="removeSavedFileTest" id="btn-remove-saved-file">删除已保存的本地文件</button>
2255
+ <button class="btnstyle" type="primary" @tap="getSavedFileListTest"
2256
+ id="btn-getsaved-filelist">获取该已保存的本地缓存文件列表</button>
2257
+ <button class="btnstyle" type="primary" @tap="truncateFileTest"
2258
+ id="btn-truncate-file">对文件{{data.writeFile}}内容进行截断操作</button>
2259
+ <button class="btnstyle" type="primary" @tap="openFileTest" id="btn-open-file">打开文件{{data.readFile}},返回描述符</button>
2260
+ <button class="btnstyle" type="primary" @tap="openFileSyncTest('r',true)"
2261
+ id="btn-open-file-sync">同步打开文件{{data.readFile}},返回描述符</button>
2262
+ <button class="btnstyle" type="primary" @tap="closeTest" id="btn-close-file">通过文件描述符关闭文件{{data.readFile}}</button>
2263
+ <button class="btnstyle" type="primary" @tap="closeSyncTest"
2264
+ id="btn-close-file-sync">通过文件描述符同步关闭文件{{data.readFile}}</button>
2265
+ <button class="btnstyle" type="primary" @tap="writeTest" id="btn-write">通过文件描述符写入文件{{data.readFile}}</button>
2266
+ <button class="btnstyle" type="primary" @tap="writeSyncTest"
2267
+ id="btn-write-sync">同步通过文件描述符写入文件{{data.readFile}}</button>
2268
+ <button class="btnstyle" type="primary" @tap="fstatTest"
2269
+ id="btn-fstat-file">通过文件描述符获取{{data.statFile}}的状态信息</button>
2270
+ <button class="btnstyle" type="primary" @tap="fstatSyncTest"
2271
+ id="btn-fstat-file-sync">同步通过文件描述符获取{{data.statFile}}的状态信息</button>
2272
+ <button class="btnstyle" type="primary" @tap="ftruncateFileTest"
2273
+ id="btn-ftruncate-file">通过文件描述符对文件{{data.writeFile}}内容进行截断</button>
2274
+ <button class="btnstyle" type="primary" @tap="ftruncateFileSyncTest"
2275
+ id="btn-ftruncate-file-sync">同步通过文件描述符对文件{{data.writeFile}}内容进行截断</button>
2276
+ <button class="btnstyle" type="primary" @tap="testWriteReadFileBuffer" id="btn-writereadfile-buffer">写入/读取
2277
+ ArrayBuffer</button>
2278
+ <button class="btnstyle" type="primary" @tap="testWriteReadBuffer" id="btn-writeread-buffer">通过文件描述符写入/读取
2279
+ ArrayBuffer</button>
2280
+ <button class="btnstyle" type="primary" @tap="testWriteReadSyncBuffer" id="btn-writereadsync-buffer">通过文件描述符同步写入/读取
2281
+ ArrayBuffer</button>
2282
+ <button class="btnstyle" type="primary" @tap="testAppendFileBuffer" id="btn-appendfile-buffer">在文件末尾追加
2283
+ ArrayBuffer</button>
2284
+ <button class="btnstyle" type="primary" @tap="testAppendFileBufferSync" id="btn-appendfilesync-buffer">同步在文件末尾追加
2285
+ ArrayBuffer</button>
2286
+
2287
+
2288
+ <button class="btnstyle" type="primary" @tap="copyStaticToFilesTest"
2289
+ id="btn-copyStatic-file">从static目录复制文件到a目录</button>
2290
+ <button class="btnstyle" type="primary" @tap="saveFileTest" id="btn-save-file">保存临时文件到本地, filePath=null</button>
2291
+ <button class="btnstyle" type="primary" @tap="saveFileTest1" id="btn-save-file1">保存临时文件到本地,
2292
+ filePath=xxx/path.txt</button>
2293
+ <button class="btnstyle" type="primary" @tap="saveFileTest2" id="btn-save-file2">保存临时文件到本地,
2294
+ filePath=xxx/path</button>
2295
+ <button class="btnstyle" type="primary" @tap="saveFileTest3" id="btn-save-file3">保存临时文件到本地,
2296
+ filePath=xxx/path/</button>
2297
+
2298
+ <button class="btnstyle" type="primary" @tap="saveFileAndReadFileTest" id="btn-save-file-read-file">saveFile成功后验证是否可以readFile</button>
2299
+ <button class="btnstyle" type="primary" @tap="saveFileSyncTest" id="btn-save-file-sync">同步保存临时文件到本地</button>
2300
+ <button class="btnstyle" type="primary" @tap="unzipFileTest" id="btn-unzip-file-sync">解压文件</button>
2301
+ <button class="btnstyle" type="primary" @tap="truncateFileSyncTest"
2302
+ id="btn-truncate-file-sync">同步对文件{{data.writeFile}}内容进行截断操作</button>
2303
+ <button class="btnstyle" type="primary" @tap="readCompressedFileTest"
2304
+ id="btn-compressed-file">读取指定压缩类型的本地文件内容</button>
2305
+ <button class="btnstyle" type="primary" @tap="readCompressedFileSyncTest"
2306
+ id="btn-compressed-file-sync">同步读取指定压缩类型的本地文件内容</button>
2307
+ <button class="btnstyle" type="primary" @tap="readZipEntry" id="btn-readzip-entry">读取压缩包内的文件</button>
2308
+ <button class="btnstyle" type="primary" @tap="testWriteReadFileSyncBuffer" id="btn-writereadfilesync-buffer">同步写入/读取
2309
+ ArrayBuffer</button>
2310
+ <button class="btnstyle" type="primary" @tap="testReadFileEncoding('base64')">readFile(content://base64)</button>
2311
+ <button class="btnstyle" type="primary" @tap="testReadFileEncoding('utf-8')">readFile(content://utf-8)</button>
2312
+ <button class="btnstyle" type="primary" @tap="testReadFileEncoding('ascii')">readFile(content://ascii)</button>
2313
+ <button class="btnstyle" type="primary" @tap="testReadFileArrayBuffer()">readFile(content://arraybuffer)</button>
2314
+ <button class="btnstyle" type="primary"
2315
+ @tap="testReadFileSyncEncoding('base64')">readFileSync(content://base64)</button>
2316
+ <button class="btnstyle" type="primary"
2317
+ @tap="testReadFileSyncEncoding('utf-8')">readFileSync(content://utf-8)</button>
2318
+ <button class="btnstyle" type="primary"
2319
+ @tap="testReadFileSyncEncoding('ascii')">readFileSync(content://ascii)</button>
2320
+ <button class="btnstyle" type="primary"
2321
+ @tap="testReadFileSyncArrayBuffer()">readFileSync(content://arraybuffer)</button>
2322
+ <button class="btnstyle" type="primary" @tap="copyFileByContent()">copyFile(content://)</button>
2323
+ <button class="btnstyle" type="primary" @tap="copyFileSyncByContent()">copyFileSync(content://)</button>
2324
+ <button class="btnstyle" type="primary" @tap="getFileInfoByContent">getFileInfo(content://)</button>
2325
+
2326
+
2327
+ <button class="btnstyle" type="primary" @tap="gotoExplore()">前往沙盒文件管理器</button>
2328
+ <button class="btnstyle" type="primary" @tap="gotoTestStatic()">前往Static文件测试</button>
2329
+ <view style="height: 4px;"></view>
2330
+
2331
+ </scroll-view>
2332
+
2333
+ </template>
2334
+
2335
+
2336
+
2337
+ <style>
2338
+ .btnstyle {
2339
+ margin: 4px;
2340
+ }
2341
+ </style>
2342
+
2343
+ ```
2344
+
2345
+ ## 通用类型
2346
+
2347
+ ### GeneralCallbackResult @generalcallbackresult-values
2348
+
2349
+ | 名称 | 类型 | 必备 | 描述 |
2350
+ | :- | :- | :- | :- |
2351
+ | errMsg | string | 是 | 错误信息 |