mobiletto 1.1.9 → 1.1.12

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 (117) hide show
  1. package/README.md +82 -4
  2. package/docs/README.md +113 -0
  3. package/docs/af/README.md +481 -0
  4. package/docs/am/README.md +481 -0
  5. package/docs/ar/README.md +481 -0
  6. package/docs/az/README.md +481 -0
  7. package/docs/be/README.md +481 -0
  8. package/docs/bg/README.md +481 -0
  9. package/docs/bn/README.md +481 -0
  10. package/docs/bs/README.md +481 -0
  11. package/docs/ca/README.md +481 -0
  12. package/docs/ceb/README.md +481 -0
  13. package/docs/co/README.md +481 -0
  14. package/docs/cs/README.md +481 -0
  15. package/docs/cy/README.md +481 -0
  16. package/docs/da/README.md +481 -0
  17. package/docs/de/README.md +481 -0
  18. package/docs/el/README.md +481 -0
  19. package/docs/eo/README.md +481 -0
  20. package/docs/es/README.md +481 -0
  21. package/docs/et/README.md +481 -0
  22. package/docs/eu/README.md +481 -0
  23. package/docs/fa/README.md +481 -0
  24. package/docs/fi/README.md +481 -0
  25. package/docs/fr/README.md +481 -0
  26. package/docs/fy/README.md +481 -0
  27. package/docs/ga/README.md +481 -0
  28. package/docs/gd/README.md +481 -0
  29. package/docs/gl/README.md +481 -0
  30. package/docs/gu/README.md +481 -0
  31. package/docs/ha/README.md +481 -0
  32. package/docs/haw/README.md +481 -0
  33. package/docs/he/README.md +481 -0
  34. package/docs/hi/README.md +481 -0
  35. package/docs/hmn/README.md +481 -0
  36. package/docs/hr/README.md +481 -0
  37. package/docs/ht/README.md +481 -0
  38. package/docs/hu/README.md +481 -0
  39. package/docs/hy/README.md +481 -0
  40. package/docs/id/README.md +481 -0
  41. package/docs/ig/README.md +481 -0
  42. package/docs/is/README.md +481 -0
  43. package/docs/it/README.md +481 -0
  44. package/docs/iw/README.md +481 -0
  45. package/docs/ja/README.md +481 -0
  46. package/docs/jv/README.md +481 -0
  47. package/docs/ka/README.md +481 -0
  48. package/docs/kk/README.md +481 -0
  49. package/docs/km/README.md +481 -0
  50. package/docs/kn/README.md +481 -0
  51. package/docs/ko/README.md +481 -0
  52. package/docs/ku/README.md +481 -0
  53. package/docs/ky/README.md +481 -0
  54. package/docs/la/README.md +481 -0
  55. package/docs/lb/README.md +481 -0
  56. package/docs/lo/README.md +481 -0
  57. package/docs/lt/README.md +481 -0
  58. package/docs/lv/README.md +481 -0
  59. package/docs/mg/README.md +481 -0
  60. package/docs/mi/README.md +481 -0
  61. package/docs/mk/README.md +481 -0
  62. package/docs/ml/README.md +481 -0
  63. package/docs/mn/README.md +481 -0
  64. package/docs/mr/README.md +481 -0
  65. package/docs/ms/README.md +481 -0
  66. package/docs/mt/README.md +481 -0
  67. package/docs/my/README.md +481 -0
  68. package/docs/ne/README.md +481 -0
  69. package/docs/nl/README.md +481 -0
  70. package/docs/no/README.md +481 -0
  71. package/docs/ny/README.md +481 -0
  72. package/docs/or/README.md +481 -0
  73. package/docs/pa/README.md +481 -0
  74. package/docs/pl/README.md +481 -0
  75. package/docs/ps/README.md +481 -0
  76. package/docs/pt/README.md +481 -0
  77. package/docs/ro/README.md +481 -0
  78. package/docs/ru/README.md +481 -0
  79. package/docs/rw/README.md +481 -0
  80. package/docs/sd/README.md +481 -0
  81. package/docs/si/README.md +481 -0
  82. package/docs/sk/README.md +481 -0
  83. package/docs/sl/README.md +481 -0
  84. package/docs/sm/README.md +481 -0
  85. package/docs/sn/README.md +481 -0
  86. package/docs/so/README.md +481 -0
  87. package/docs/sq/README.md +481 -0
  88. package/docs/sr/README.md +481 -0
  89. package/docs/st/README.md +481 -0
  90. package/docs/su/README.md +481 -0
  91. package/docs/sv/README.md +481 -0
  92. package/docs/sw/README.md +481 -0
  93. package/docs/ta/README.md +481 -0
  94. package/docs/te/README.md +481 -0
  95. package/docs/tg/README.md +481 -0
  96. package/docs/th/README.md +481 -0
  97. package/docs/tk/README.md +481 -0
  98. package/docs/tl/README.md +481 -0
  99. package/docs/tr/README.md +481 -0
  100. package/docs/tt/README.md +481 -0
  101. package/docs/ug/README.md +481 -0
  102. package/docs/uk/README.md +481 -0
  103. package/docs/ur/README.md +481 -0
  104. package/docs/uz/README.md +481 -0
  105. package/docs/vi/README.md +481 -0
  106. package/docs/xh/README.md +481 -0
  107. package/docs/yi/README.md +481 -0
  108. package/docs/yo/README.md +481 -0
  109. package/docs/zh/README.md +481 -0
  110. package/docs/zu/README.md +481 -0
  111. package/drivers/b2/index.js +24 -6
  112. package/hokey.json +16 -0
  113. package/index.js +32 -16
  114. package/package.json +3 -2
  115. package/test/api.spec.js +319 -306
  116. package/util/logger.js +1 -1
  117. package/util/redis.js +1 -1
package/README.md CHANGED
@@ -8,6 +8,8 @@ Mobiletto is a JavaScript storage abstraction layer, with optional transparent c
8
8
  * [Quick start](#Quick-start)
9
9
  * [Mobiletto CLI](#mobiletto-cli)
10
10
  * [Source](#Source)
11
+ * [Installation](#Installation)
12
+ * [Support and Funding](#Support-and-Funding)
11
13
  * [Basic usage](#Basic-usage)
12
14
  * [Metadata](#Metadata)
13
15
  * [Alternate import style](#Alternate-import-style)
@@ -18,6 +20,50 @@ Mobiletto is a JavaScript storage abstraction layer, with optional transparent c
18
20
  * [Driver interface](#Driver-interface)
19
21
  * [Logging](#Logging)
20
22
 
23
+ # Read this in another language
24
+ This README.md document has been translated, via [hokeylization](https://github.com/cobbzilla/hokeylization), into
25
+ **[every language supported by Google Translate](https://cloud.google.com/translate/docs/languages)!**
26
+
27
+ I'm certain it's not perfect, but I hope it's better than nothing!
28
+
29
+    [🇸🇦 Arabic](docs/ar/README.md)
30
+    [🇧🇩 Bengali](docs/bn/README.md)
31
+    [🇩🇪 German](docs/de/README.md)
32
+    [🇺🇸 English](docs/en/README.md)
33
+    [🇪🇸 Spanish](docs/es/README.md)
34
+    [🇫🇷 French](docs/fr/README.md)
35
+    [🇹🇩 Hausa](docs/ha/README.md)
36
+    [🇮🇳 Hindi](docs/hi/README.md)
37
+    [🇮🇩 Indonesian](docs/id/README.md)
38
+    [🇮🇹 Italian](docs/it/README.md)
39
+    [🇯🇵 Japanese](docs/ja/README.md)
40
+    [🇰🇷 Korean](docs/ko/README.md)
41
+    [🇮🇳 Maranthi](docs/mr/README.md)
42
+    [🇵🇱 Polish](docs/pl/README.md)
43
+    [🇧🇷 Portuguese](docs/pt/README.md)
44
+    [🇷🇺 Russian](docs/ru/README.md)
45
+    [🇰🇪 Swahili](docs/sw/README.md)
46
+    [🇵🇭 Tagalog](docs/tl/README.md)
47
+    [🇹🇷 Turkish](docs/tr/README.md)
48
+    [🇵🇰 Urdu](docs/ur/README.md)
49
+    [🇻🇳 Vietnamese](docs/vi/README.md)
50
+    [🇨🇳 Chinese](docs/zh/README.md)
51
+ <br/>
52
+ &nbsp;&nbsp;&nbsp;**[📚 ... All Languages ...](docs/README.md)**
53
+ ----
54
+
55
+ ### Is there a problem with this translation of the README?
56
+ This particular translation of the original [README](https://github.com/cobbzilla/mobiletto/blob/master/README.md)
57
+ may be flawed -- *corrections are very welcome!* Please send a [pull request on GitHub](https://github.com/cobbzilla/mobiletto/pulls),
58
+ or if you're not comfortable doing that, [open an issue](https://github.com/cobbzilla/mobiletto/issues)
59
+
60
+ When you create a new GitHub issue about a translation, please do:
61
+ * include the page URL (copy/paste from browser address bar)
62
+ * include the exact text that is wrong (copy/paste from browser)
63
+ * please describe what is wrong -- is the translation incorrect? is the formatting broken somehow?
64
+ * kindly offer a suggestion of a better translation, or how the text should be properly formatted
65
+ * **Thank you!**
66
+
21
67
  ## Why Mobiletto?
22
68
 
23
69
  ### Goodbye vendor lock-in!
@@ -33,7 +79,7 @@ change storage providers and know that your app's storage layer will behave iden
33
79
 
34
80
  ### Extensive testing
35
81
  All drivers are tested for identical behavior with 60+ tests for each driver.
36
- Each test actually runs *four times* with every (2x2) combination of:
82
+ We test all drivers with every combination of:
37
83
  * Encryption: both enabled and disabled
38
84
  * Redis cache: both enabled and disabled
39
85
 
@@ -57,6 +103,30 @@ To work with mobiletto at the command-line, use [mobiletto-cli](https://www.npmj
57
103
  * [mobiletto on GitHub](https://github.com/cobbzilla/mobiletto)
58
104
  * [mobiletto on npm](https://www.npmjs.com/package/mobiletto)
59
105
 
106
+ ## Support and Funding
107
+ I am attempting to be a professional open source software developer. I have been working in
108
+ the software industry for many years, I have started successful companies and sold them to public companies.
109
+ Recently I lost my job, and I don't really have any other work lined up
110
+
111
+ So I'm going to try writing helpful software and see if that works
112
+
113
+ If you enjoy using this software, I would be very thankful for even the
114
+ smallest [monthly contribution via Patreon](https://www.patreon.com/cobbzilla)
115
+
116
+ *Thank you!*
117
+
118
+ ## Installation
119
+ Install using `npm` or `yarn`. You probably want the `lite` version that does not include all the
120
+ translated README files:
121
+
122
+ npm install mobiletto-lite
123
+ yarn add mobiletto-lite
124
+
125
+ If you really want the README files in every language, install the full version:
126
+
127
+ npm install mobiletto
128
+ yarn add mobiletto
129
+
60
130
  ## Quick Start
61
131
  A short example using the mobiletto `s3` driver.
62
132
 
@@ -70,13 +140,13 @@ This code would run the same if the driver were `b2` or `local`.
70
140
  const dirList = await bucket.list('some/dir/')
71
141
  const everything = await bucket.list('', {recursive: true})
72
142
 
73
- // write an entire file in one-shot
143
+ // write an entire file
74
144
  let bytesWritten = await bucket.writeFile('some/path', someBufferOfData)
75
145
 
76
146
  // write a file from a stream/generator
77
147
  bytesWritten = await bucket.write('some/path', streamOrGenerator)
78
148
 
79
- // read an entire file in one-shot
149
+ // read an entire file
80
150
  // returns null if an exception would otherwise be thrown
81
151
  const bufferOrNull = await bucket.safeReadFile('some/path')
82
152
 
@@ -160,9 +230,13 @@ A much more extensive example, showing most of the features offered:
160
230
  const callback = (chunk) => { ... write chunk somewhere ... }
161
231
  api.read(path, callback) // returns count of bytes read
162
232
 
163
- // Read an entire file at once (convenience method)
233
+ // Read an entire file at once
164
234
  const data = await api.readFile(path) // returns a byte Buffer of the file contents
165
235
 
236
+ // Read an entire file at once
237
+ // returns null if an exception would otherwise be thrown
238
+ const bufferOrNull = await bucket.safeReadFile('some/path')
239
+
166
240
  // Write a file
167
241
  // Provide a generator function that yields chunks of data
168
242
  const generator = function* () {
@@ -321,6 +395,10 @@ some effort, discover some or all of the overall structure of the directory hier
321
395
  The adversary would not know the names of the directories/files unless they also knew your encryption
322
396
  key or had otherwise successfully cracked the encryption. All bets are off then!
323
397
 
398
+ ### Performance and caching
399
+ Operations on encrypted storage can be slow. Recursive listings and removals can be very slow.
400
+ Caching via redis helps tremendously, but note that the cache is flushed upon any writes or removes.
401
+
324
402
  ## Key rotation
325
403
  Create a mobiletto with your new key, then mirror the old data into it:
326
404
 
package/docs/README.md ADDED
@@ -0,0 +1,113 @@
1
+ Index of translations ⸺ README.md
2
+ ======================================================
3
+
4
+ #### **[Find your language code](https://cloud.google.com/translate/docs/languages)**
5
+
6
+ ### [Afrikaans ⸺ `af` ⸺ Afrikaans](af/README.md)
7
+ ### [shqiptare ⸺ `sq` ⸺ Albanian](sq/README.md)
8
+ ### [አማርኛ ⸺ `am` ⸺ Amharic](am/README.md)
9
+ ### [عربي ⸺ `ar` ⸺ Arabic](ar/README.md)
10
+ ### [հայերեն ⸺ `hy` ⸺ Armenian](hy/README.md)
11
+ ### [Azərbaycan ⸺ `az` ⸺ Azerbaijani](az/README.md)
12
+ ### [euskara ⸺ `eu` ⸺ Basque](eu/README.md)
13
+ ### [беларускі ⸺ `be` ⸺ Belarusian](be/README.md)
14
+ ### [বাংলা ⸺ `bn` ⸺ Bengali](bn/README.md)
15
+ ### [bosanski ⸺ `bs` ⸺ Bosnian](bs/README.md)
16
+ ### [български ⸺ `bg` ⸺ Bulgarian](bg/README.md)
17
+ ### [català ⸺ `ca` ⸺ Catalan](ca/README.md)
18
+ ### [Cebuano ⸺ `ceb` ⸺ Cebuano](ceb/README.md)
19
+ ### [中国人 ⸺ `zh` ⸺ Chinese](zh/README.md)
20
+ ### [Corsu ⸺ `co` ⸺ Corsican](co/README.md)
21
+ ### [Hrvatski ⸺ `hr` ⸺ Croatian](hr/README.md)
22
+ ### [čeština ⸺ `cs` ⸺ Czech](cs/README.md)
23
+ ### [dansk ⸺ `da` ⸺ Danish](da/README.md)
24
+ ### [Nederlands ⸺ `nl` ⸺ Dutch](nl/README.md)
25
+ ### [Esperanto ⸺ `eo` ⸺ Esperanto](eo/README.md)
26
+ ### [eesti keel ⸺ `et` ⸺ Estonian](et/README.md)
27
+ ### [Suomalainen ⸺ `fi` ⸺ Finnish](fi/README.md)
28
+ ### [Français ⸺ `fr` ⸺ French](fr/README.md)
29
+ ### [Frysk ⸺ `fy` ⸺ Frisian](fy/README.md)
30
+ ### [galego ⸺ `gl` ⸺ Galician](gl/README.md)
31
+ ### [ქართული ⸺ `ka` ⸺ Georgian](ka/README.md)
32
+ ### [Deutsch ⸺ `de` ⸺ German](de/README.md)
33
+ ### [Ελληνικά ⸺ `el` ⸺ Greek](el/README.md)
34
+ ### [ગુજરાતી ⸺ `gu` ⸺ Gujarati](gu/README.md)
35
+ ### [Kreyòl ayisyen ⸺ `ht` ⸺ Haitian Creole](ht/README.md)
36
+ ### [Hausa ⸺ `ha` ⸺ Hausa](ha/README.md)
37
+ ### [ʻŌlelo Hawaiʻi ⸺ `haw` ⸺ Hawaiian](haw/README.md)
38
+ ### [עִברִית ⸺ `he` ⸺ Hebrew](he/README.md)
39
+ ### [ ⸺ `iw` ⸺ ](iw/README.md)
40
+ ### [हिन्दी ⸺ `hi` ⸺ Hindi](hi/README.md)
41
+ ### [Hmoob ⸺ `hmn` ⸺ Hmong](hmn/README.md)
42
+ ### [Magyar ⸺ `hu` ⸺ Hungarian](hu/README.md)
43
+ ### [íslenskur ⸺ `is` ⸺ Icelandic](is/README.md)
44
+ ### [Igbo ⸺ `ig` ⸺ Igbo](ig/README.md)
45
+ ### [bahasa Indonesia ⸺ `id` ⸺ Indonesian](id/README.md)
46
+ ### [Gaeilge ⸺ `ga` ⸺ Irish](ga/README.md)
47
+ ### [Italiano ⸺ `it` ⸺ Italian](it/README.md)
48
+ ### [日本 ⸺ `ja` ⸺ Japanese](ja/README.md)
49
+ ### [basa jawa ⸺ `jv` ⸺ Javanese](jv/README.md)
50
+ ### [ಕನ್ನಡ ⸺ `kn` ⸺ Kannada](kn/README.md)
51
+ ### [қазақ ⸺ `kk` ⸺ Kazakh](kk/README.md)
52
+ ### [ខ្មែរ ⸺ `km` ⸺ Khmer](km/README.md)
53
+ ### [Kinyarwanda ⸺ `rw` ⸺ Kinyarwanda](rw/README.md)
54
+ ### [한국인 ⸺ `ko` ⸺ Korean](ko/README.md)
55
+ ### [Kurdî ⸺ `ku` ⸺ Kurdish](ku/README.md)
56
+ ### [Кыргызча ⸺ `ky` ⸺ Kyrgyz](ky/README.md)
57
+ ### [ພາສາລາວ ⸺ `lo` ⸺ Lao](lo/README.md)
58
+ ### [Latinus ⸺ `la` ⸺ Latin](la/README.md)
59
+ ### [latviski ⸺ `lv` ⸺ Latvian](lv/README.md)
60
+ ### [lietuvių ⸺ `lt` ⸺ Lithuanian](lt/README.md)
61
+ ### [lëtzebuergesch ⸺ `lb` ⸺ Luxembourgish](lb/README.md)
62
+ ### [македонски ⸺ `mk` ⸺ Macedonian](mk/README.md)
63
+ ### [Malagasy ⸺ `mg` ⸺ Malagasy](mg/README.md)
64
+ ### [Melayu ⸺ `ms` ⸺ Malay](ms/README.md)
65
+ ### [മലയാളം ⸺ `ml` ⸺ Malayalam](ml/README.md)
66
+ ### [Malti ⸺ `mt` ⸺ Maltese](mt/README.md)
67
+ ### [Maori ⸺ `mi` ⸺ Maori](mi/README.md)
68
+ ### [मराठी ⸺ `mr` ⸺ Marathi](mr/README.md)
69
+ ### [Монгол ⸺ `mn` ⸺ Mongolian](mn/README.md)
70
+ ### [မြန်မာ (ဗမာ)၊ ⸺ `my` ⸺ Myanmar (Burmese)](my/README.md)
71
+ ### [नेपाली ⸺ `ne` ⸺ Nepali](ne/README.md)
72
+ ### [norsk ⸺ `no` ⸺ Norwegian](no/README.md)
73
+ ### [Nyanja (Chichewa) ⸺ `ny` ⸺ Nyanja (Chichewa)](ny/README.md)
74
+ ### [ଓଡିଆ (ଓଡିଆ) ⸺ `or` ⸺ Odia (Oriya)](or/README.md)
75
+ ### [پښتو ⸺ `ps` ⸺ Pashto](ps/README.md)
76
+ ### [فارسی ⸺ `fa` ⸺ Persian](fa/README.md)
77
+ ### [Polski ⸺ `pl` ⸺ Polish](pl/README.md)
78
+ ### [Português (Portugal, Brasil) ⸺ `pt` ⸺ Portuguese (Portugal, Brazil)](pt/README.md)
79
+ ### [ਪੰਜਾਬੀ ⸺ `pa` ⸺ Punjabi](pa/README.md)
80
+ ### [Română ⸺ `ro` ⸺ Romanian](ro/README.md)
81
+ ### [Русский ⸺ `ru` ⸺ Russian](ru/README.md)
82
+ ### [Samoa ⸺ `sm` ⸺ Samoan](sm/README.md)
83
+ ### [Gàidhlig na h-Alba ⸺ `gd` ⸺ Scots Gaelic](gd/README.md)
84
+ ### [Српски ⸺ `sr` ⸺ Serbian](sr/README.md)
85
+ ### [Sesotho ⸺ `st` ⸺ Sesotho](st/README.md)
86
+ ### [Shona ⸺ `sn` ⸺ Shona](sn/README.md)
87
+ ### [سنڌي ⸺ `sd` ⸺ Sindhi](sd/README.md)
88
+ ### [සිංහල (සිංහල) ⸺ `si` ⸺ Sinhala (Sinhalese)](si/README.md)
89
+ ### [slovenský ⸺ `sk` ⸺ Slovak](sk/README.md)
90
+ ### [Slovenščina ⸺ `sl` ⸺ Slovenian](sl/README.md)
91
+ ### [Soomaali ⸺ `so` ⸺ Somali](so/README.md)
92
+ ### [español ⸺ `es` ⸺ Spanish](es/README.md)
93
+ ### [basa Sunda ⸺ `su` ⸺ Sundanese](su/README.md)
94
+ ### [kiswahili ⸺ `sw` ⸺ Swahili](sw/README.md)
95
+ ### [svenska ⸺ `sv` ⸺ Swedish](sv/README.md)
96
+ ### [Tagalog (Filipino) ⸺ `tl` ⸺ Tagalog (Filipino)](tl/README.md)
97
+ ### [тоҷикӣ ⸺ `tg` ⸺ Tajik](tg/README.md)
98
+ ### [தமிழ் ⸺ `ta` ⸺ Tamil](ta/README.md)
99
+ ### [Татар ⸺ `tt` ⸺ Tatar](tt/README.md)
100
+ ### [తెలుగు ⸺ `te` ⸺ Telugu](te/README.md)
101
+ ### [ไทย ⸺ `th` ⸺ Thai](th/README.md)
102
+ ### [Türk ⸺ `tr` ⸺ Turkish](tr/README.md)
103
+ ### [Türkmenler ⸺ `tk` ⸺ Turkmen](tk/README.md)
104
+ ### [українська ⸺ `uk` ⸺ Ukrainian](uk/README.md)
105
+ ### [اردو ⸺ `ur` ⸺ Urdu](ur/README.md)
106
+ ### [ئۇيغۇر ⸺ `ug` ⸺ Uyghur](ug/README.md)
107
+ ### [o&#x27;zbek ⸺ `uz` ⸺ Uzbek](uz/README.md)
108
+ ### [Tiếng Việt ⸺ `vi` ⸺ Vietnamese](vi/README.md)
109
+ ### [Cymraeg ⸺ `cy` ⸺ Welsh](cy/README.md)
110
+ ### [isiXhosa ⸺ `xh` ⸺ Xhosa](xh/README.md)
111
+ ### [יידיש ⸺ `yi` ⸺ Yiddish](yi/README.md)
112
+ ### [Yoruba ⸺ `yo` ⸺ Yoruba](yo/README.md)
113
+ ### [Zulu ⸺ `zu` ⸺ Zulu](zu/README.md)