definitions.js 4.0 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124
  1. export var Directory;
  2. (function (Directory) {
  3. /**
  4. * The Documents directory.
  5. * On iOS it's the app's documents directory.
  6. * Use this directory to store user-generated content.
  7. * On Android it's the Public Documents folder, so it's accessible from other apps.
  8. * It's not accessible on Android 10 unless the app enables legacy External Storage
  9. * by adding `android:requestLegacyExternalStorage="true"` in the `application` tag
  10. * in the `AndroidManifest.xml`.
  11. * On Android 11 or newer the app can only access the files/folders the app created.
  12. *
  13. * @since 1.0.0
  14. */
  15. Directory["Documents"] = "DOCUMENTS";
  16. /**
  17. * The Data directory.
  18. * On iOS it will use the Documents directory.
  19. * On Android it's the directory holding application files.
  20. * Files will be deleted when the application is uninstalled.
  21. *
  22. * @since 1.0.0
  23. */
  24. Directory["Data"] = "DATA";
  25. /**
  26. * The Library directory.
  27. * On iOS it will use the Library directory.
  28. * On Android it's the directory holding application files.
  29. * Files will be deleted when the application is uninstalled.
  30. *
  31. * @since 1.1.0
  32. */
  33. Directory["Library"] = "LIBRARY";
  34. /**
  35. * The Cache directory.
  36. * Can be deleted in cases of low memory, so use this directory to write app-specific files.
  37. * that your app can re-create easily.
  38. *
  39. * @since 1.0.0
  40. */
  41. Directory["Cache"] = "CACHE";
  42. /**
  43. * The external directory.
  44. * On iOS it will use the Documents directory.
  45. * On Android it's the directory on the primary shared/external
  46. * storage device where the application can place persistent files it owns.
  47. * These files are internal to the applications, and not typically visible
  48. * to the user as media.
  49. * Files will be deleted when the application is uninstalled.
  50. *
  51. * @since 1.0.0
  52. */
  53. Directory["External"] = "EXTERNAL";
  54. /**
  55. * The external storage directory.
  56. * On iOS it will use the Documents directory.
  57. * On Android it's the primary shared/external storage directory.
  58. * It's not accessible on Android 10 unless the app enables legacy External Storage
  59. * by adding `android:requestLegacyExternalStorage="true"` in the `application` tag
  60. * in the `AndroidManifest.xml`.
  61. * It's not accessible on Android 11 or newer.
  62. *
  63. * @since 1.0.0
  64. */
  65. Directory["ExternalStorage"] = "EXTERNAL_STORAGE";
  66. /**
  67. * The external cache directory.
  68. * On iOS it will use the Documents directory.
  69. * On Android it's the primary shared/external cache.
  70. *
  71. * @since 7.1.0
  72. */
  73. Directory["ExternalCache"] = "EXTERNAL_CACHE";
  74. /**
  75. * The Library directory without cloud backup. Used in iOS.
  76. * On Android it's the directory holding application files.
  77. *
  78. * @since 7.1.0
  79. */
  80. Directory["LibraryNoCloud"] = "LIBRARY_NO_CLOUD";
  81. /**
  82. * A temporary directory for iOS.
  83. * On Android it's the directory holding the application cache.
  84. *
  85. * @since 7.1.0
  86. */
  87. Directory["Temporary"] = "TEMPORARY";
  88. })(Directory || (Directory = {}));
  89. export var Encoding;
  90. (function (Encoding) {
  91. /**
  92. * Eight-bit UCS Transformation Format
  93. *
  94. * @since 1.0.0
  95. */
  96. Encoding["UTF8"] = "utf8";
  97. /**
  98. * Seven-bit ASCII, a.k.a. ISO646-US, a.k.a. the Basic Latin block of the
  99. * Unicode character set
  100. * This encoding is only supported on Android.
  101. *
  102. * @since 1.0.0
  103. */
  104. Encoding["ASCII"] = "ascii";
  105. /**
  106. * Sixteen-bit UCS Transformation Format, byte order identified by an
  107. * optional byte-order mark
  108. * This encoding is only supported on Android.
  109. *
  110. * @since 1.0.0
  111. */
  112. Encoding["UTF16"] = "utf16";
  113. })(Encoding || (Encoding = {}));
  114. /**
  115. * @deprecated Use `Directory`.
  116. * @since 1.0.0
  117. */
  118. export const FilesystemDirectory = Directory;
  119. /**
  120. * @deprecated Use `Encoding`.
  121. * @since 1.0.0
  122. */
  123. export const FilesystemEncoding = Encoding;
  124. //# sourceMappingURL=definitions.js.map