mobiletto 1.1.10 → 1.1.11

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 (116) hide show
  1. package/README.md +48 -0
  2. package/docs/README.md +113 -0
  3. package/docs/af/README.md +455 -0
  4. package/docs/am/README.md +455 -0
  5. package/docs/ar/README.md +455 -0
  6. package/docs/az/README.md +455 -0
  7. package/docs/be/README.md +455 -0
  8. package/docs/bg/README.md +455 -0
  9. package/docs/bn/README.md +455 -0
  10. package/docs/bs/README.md +455 -0
  11. package/docs/ca/README.md +455 -0
  12. package/docs/ceb/README.md +455 -0
  13. package/docs/co/README.md +455 -0
  14. package/docs/cs/README.md +455 -0
  15. package/docs/cy/README.md +455 -0
  16. package/docs/da/README.md +455 -0
  17. package/docs/de/README.md +455 -0
  18. package/docs/el/README.md +455 -0
  19. package/docs/eo/README.md +455 -0
  20. package/docs/es/README.md +455 -0
  21. package/docs/et/README.md +455 -0
  22. package/docs/eu/README.md +455 -0
  23. package/docs/fa/README.md +455 -0
  24. package/docs/fi/README.md +455 -0
  25. package/docs/fr/README.md +455 -0
  26. package/docs/fy/README.md +455 -0
  27. package/docs/ga/README.md +455 -0
  28. package/docs/gd/README.md +455 -0
  29. package/docs/gl/README.md +455 -0
  30. package/docs/gu/README.md +455 -0
  31. package/docs/ha/README.md +455 -0
  32. package/docs/haw/README.md +455 -0
  33. package/docs/he/README.md +455 -0
  34. package/docs/hi/README.md +455 -0
  35. package/docs/hmn/README.md +455 -0
  36. package/docs/hr/README.md +455 -0
  37. package/docs/ht/README.md +455 -0
  38. package/docs/hu/README.md +455 -0
  39. package/docs/hy/README.md +455 -0
  40. package/docs/id/README.md +455 -0
  41. package/docs/ig/README.md +455 -0
  42. package/docs/is/README.md +455 -0
  43. package/docs/it/README.md +455 -0
  44. package/docs/iw/README.md +455 -0
  45. package/docs/ja/README.md +455 -0
  46. package/docs/jv/README.md +455 -0
  47. package/docs/ka/README.md +455 -0
  48. package/docs/kk/README.md +455 -0
  49. package/docs/km/README.md +455 -0
  50. package/docs/kn/README.md +455 -0
  51. package/docs/ko/README.md +455 -0
  52. package/docs/ku/README.md +455 -0
  53. package/docs/ky/README.md +455 -0
  54. package/docs/la/README.md +455 -0
  55. package/docs/lb/README.md +455 -0
  56. package/docs/lo/README.md +455 -0
  57. package/docs/lt/README.md +455 -0
  58. package/docs/lv/README.md +455 -0
  59. package/docs/mg/README.md +455 -0
  60. package/docs/mi/README.md +455 -0
  61. package/docs/mk/README.md +455 -0
  62. package/docs/ml/README.md +455 -0
  63. package/docs/mn/README.md +455 -0
  64. package/docs/mr/README.md +455 -0
  65. package/docs/ms/README.md +455 -0
  66. package/docs/mt/README.md +455 -0
  67. package/docs/my/README.md +455 -0
  68. package/docs/ne/README.md +455 -0
  69. package/docs/nl/README.md +455 -0
  70. package/docs/no/README.md +455 -0
  71. package/docs/ny/README.md +455 -0
  72. package/docs/or/README.md +455 -0
  73. package/docs/pa/README.md +455 -0
  74. package/docs/pl/README.md +455 -0
  75. package/docs/ps/README.md +455 -0
  76. package/docs/pt/README.md +455 -0
  77. package/docs/ro/README.md +455 -0
  78. package/docs/ru/README.md +455 -0
  79. package/docs/rw/README.md +455 -0
  80. package/docs/sd/README.md +455 -0
  81. package/docs/si/README.md +455 -0
  82. package/docs/sk/README.md +455 -0
  83. package/docs/sl/README.md +455 -0
  84. package/docs/sm/README.md +455 -0
  85. package/docs/sn/README.md +455 -0
  86. package/docs/so/README.md +455 -0
  87. package/docs/sq/README.md +455 -0
  88. package/docs/sr/README.md +455 -0
  89. package/docs/st/README.md +455 -0
  90. package/docs/su/README.md +455 -0
  91. package/docs/sv/README.md +455 -0
  92. package/docs/sw/README.md +455 -0
  93. package/docs/ta/README.md +455 -0
  94. package/docs/te/README.md +455 -0
  95. package/docs/tg/README.md +455 -0
  96. package/docs/th/README.md +455 -0
  97. package/docs/tk/README.md +455 -0
  98. package/docs/tl/README.md +455 -0
  99. package/docs/tr/README.md +455 -0
  100. package/docs/tt/README.md +455 -0
  101. package/docs/ug/README.md +455 -0
  102. package/docs/uk/README.md +455 -0
  103. package/docs/ur/README.md +455 -0
  104. package/docs/uz/README.md +455 -0
  105. package/docs/vi/README.md +455 -0
  106. package/docs/xh/README.md +455 -0
  107. package/docs/yi/README.md +455 -0
  108. package/docs/yo/README.md +455 -0
  109. package/docs/zh/README.md +455 -0
  110. package/docs/zu/README.md +455 -0
  111. package/drivers/b2/index.js +24 -6
  112. package/hokey.json +16 -0
  113. package/index.js +7 -2
  114. package/package.json +1 -1
  115. package/test/api.spec.js +12 -9
  116. package/util/redis.js +1 -1
@@ -0,0 +1,455 @@
1
+ Mobiletto
2
+ =========
3
+
4
+ O le Mobiletto o se vaega e teu ai mea e teu ai le JavaScript, fa'atasi ai ma le fa'amalamalamaga manino a le tagata o tausia.
5
+
6
+ # I totonu
7
+ * [Aisea Mobiletto?](#Aisea-Mobiletto?)
8
+ * [Amata vave](#Amata vave)
9
+ * [Mobiletto CLI](#mobiletto-cli)
10
+ * [Source](#Source)
11
+ * [Fa'aoga masani](#Fa'aoga-fa'aoga)
12
+ * [Metadata](#Metadata)
13
+ * [Sui fa'aulufale mai](#Alternate-import-style)
14
+ * [Cach](#Caching)
15
+ * [Fa'ata](#Fa'ata)
16
+ * [Fa'amatalaga manino](#Fa'amatalaga manino)
17
+ * [Tili ki ki](#Tili-ki)
18
+ * [Ataavale ta'avale](#Fa'aoga-taavale)
19
+ * [Logging](#Logging)
20
+
21
+ # Faitau lenei i se isi gagana
22
+ O lenei README.md pepa ua faaliliuina, e ala i le [hokeylization](https://github.com/cobbzilla/hokeylization), i totonu
23
+ **[gagana uma e lagolagoina e Google Translate](https://cloud.google.com/translate/docs/languages)!**
24
+
25
+ Ou te mautinoa e le atoatoa, ae ou te faʻamoemoe e sili atu nai lo le leai!
26
+
27
+ [🇸🇦 Alapi](../ar/README.md)
28
+ [🇧🇩 Bengali](../bn/README.md)
29
+ [🇩🇪 Siamani](../de/README.md)
30
+ [🇺🇸 Igilisi](../en/README.md)
31
+ [🇪🇸 Sipaniolo](../es/README.md)
32
+ [🇫🇷 Farani](../fr/README.md)
33
+ [🇹🇩 Hausa](../ha/README.md)
34
+ [🇮🇳 Hindi](../hi/README.md)
35
+ [🇮🇩 Initonesia](../id/README.md)
36
+ [🇮🇹 Italia](../it/README.md)
37
+ [🇯🇵 Iapani](../ja/README.md)
38
+ [🇰🇷 Korea](../ko/README.md)
39
+ [🇮🇳 Maranthi](../mr/README.md)
40
+ [🇵🇱 Polani](../pl/README.md)
41
+ [🇧🇷 Potukale](../pt/README.md)
42
+ [🇷🇺 Rusia](../ru/README.md)
43
+ [🇰🇪 Swahili](../sw/README.md)
44
+ [🇵🇭 Tagalog](../tl/README.md)
45
+ [🇹🇷 Turkish](../tr/README.md)
46
+ [🇵🇰 Urdu](../ur/README.md)
47
+ [🇻🇳 Vietnamese](../vi/README.md)
48
+ [🇨🇳 Saina](../zh/README.md)
49
+
50
+
51
+ **[📚 ... Gagana Uma ...](../README.md)**
52
+ ----
53
+
54
+ ### E iai se fa'afitauli i lenei fa'aliliuga o le README?
55
+ Lenei fa'aliliuga fa'apitoa o le ulua'i [README](https://github.com/cobbzilla/mobiletto/blob/master/README.md)
56
+ atonu e sese -- *fa'asa'oga e matua talia lava!* Fa'amolemole lafo mai se [talosaga toso ile GitHub](https://github.com/cobbzilla/mobiletto/pulls),
57
+ pe afai e te le fiafia e fai lena mea, [tatala se mataupu](https://github.com/cobbzilla/mobiletto/issues)
58
+
59
+ A e fatuina se lomiga fou GitHub e uiga i se faaliliuga, faamolemole fai:
60
+ * fa'aaofia ai le itulau URL (kopi/pa'i mai le tuatusi tuatusi pa)
61
+ * fa'aaofia ai le fa'amatalaga sa'o e sese (kopi/pa'i mai le su'esu'ega)
62
+ * fa'amolemole fa'amatala le mea o lo'o fa'aletonu -- e le sa'o le fa'aliliuga? ua malepe le faatulagaga?
63
+ * ofo mai ma le agalelei se fautuaga o se faaliliuga e sili atu, po o le auala e tatau ona faatulaga lelei ai le tusitusiga
64
+ * **Faafetai!**
65
+
66
+ ## Aisea Mobiletto?
67
+
68
+ ### Tofa le tagata faatau loka-i totonu!
69
+ O 'au'aunaga teu oloa eseese e iai API e le fetaui. E oʻo lava ia i latou o loʻo taumafai mo le "S3 compatibility"
70
+ e iai uiga fa'apitoa.
71
+
72
+ A e filifilia se fa'atau oloa teu mo lau app, pe a e fa'ailoga sa'o i la latou API, lau app
73
+ ua faalagolago nei i lea auaunaga. A'o alu le taimi ma fa'aputuina le code, o le a suia tagata fa'atau
74
+ ua faateleina le le mafaia. Faʻafeiloaʻi i le lalolagi malie o le faʻatau loka-i totonu!
75
+
76
+ Mobiletto na fuafuaina e foia lenei faafitauli. I le fa'ailogaina o lau app ile mobiletto's API, e faigofie
77
+ sui kamupani teu oloa ma iloa o le a tutusa le amio a lau app.
78
+
79
+ ### Su'ega tele
80
+ O aveta'avale uma e fa'ata'ita'iina mo uiga tutusa ma le 60+ su'ega mo ta'avale ta'itasi.
81
+ Matou te faʻataʻitaʻiina avetaavale uma i tuʻufaʻatasiga uma o:
82
+ * Fa'ailoga: e mafai uma ma fa'aletonu
83
+ * Redis cache: mafai uma ma le le atoatoa
84
+
85
+ O lenei faiga e maua ai le filemu o le mafaufau o le mobiletto o le a amio tutusa tusa lava po o le a le avetaavale e te faʻaaogaina,
86
+ ma e tusa lava pe e te faʻaogaina le faʻaogaina ma/poʻo le faʻailoga.
87
+
88
+ ### Lagolago avetaavale
89
+ Avetaavale teuina Mobiletto nei:
90
+ * `s3` : Amazon S3
91
+ * `b2` : Backblaze B2
92
+ * `local` : faiga faila i le lotoifale
93
+
94
+ *O sao e lagolago ai le tele o kamupani e teu ai ao e matua talia!*
95
+
96
+ ## mobiletto-cli
97
+ Mobiletto ua fa'amoemoe e fa'aoga e fai ma faletusi e isi code JavaScript.
98
+
99
+ Ina ia galue ma mobiletto i le laina-faʻatonu, faʻaaoga [mobiletto-cli](https://www.npmjs.com/package/mobiletto-cli)
100
+
101
+ ## Punavai
102
+ * [mobiletto i luga ole GitHub](https://github.com/cobbzilla/mobiletto)
103
+ * [mobiletto on npm](https://www.npmjs.com/package/mobiletto)
104
+
105
+ ## Amata vave
106
+ O se fa'ata'ita'iga pu'upu'u e fa'aaoga ai le aveta'avale mobiletto `s3` .
107
+
108
+ E tutusa le fa'aogaina o lenei code pe afai o le aveta'avale o le `b2` po'o `local` .
109
+
110
+ const storage = require('mobiletto')
111
+ const bucket = await storage.connect('s3', aws_key, aws_secret, {bucket: 'bk'})
112
+
113
+ // list objects: returns array of metadata objects
114
+ const listing = await bucket.list()
115
+ const dirList = await bucket.list('some/dir/')
116
+ const everything = await bucket.list('', {recursive: true})
117
+
118
+ // write an entire file
119
+ let bytesWritten = await bucket.writeFile('some/path', someBufferOfData)
120
+
121
+ // write a file from a stream/generator
122
+ bytesWritten = await bucket.write('some/path', streamOrGenerator)
123
+
124
+ // read an entire file
125
+ // returns null if an exception would otherwise be thrown
126
+ const bufferOrNull = await bucket.safeReadFile('some/path')
127
+
128
+ // stream-read a file, passing data to callback
129
+ const bytesRead = await bucket.read('some/path', (chunk) => { ...do something with chunk... } )
130
+
131
+ // remove a file, returns the path removed
132
+ let removed = await bucket.remove('some/path') // removed is a string
133
+
134
+ // remove a directory, returns array of paths removed
135
+ removed = await bucket.remove('some/directory', {recursive: true}) // removed is now an array!
136
+
137
+ ----
138
+ ## Fa'aoga masani
139
+ O se faʻataʻitaʻiga sili atu ona lautele, faʻaalia le tele o foliga o loʻo ofoina atu:
140
+
141
+ const { mobiletto } = require('mobiletto')
142
+
143
+ // General usage
144
+ const api = await mobiletto(driverName, key, secret, opts)
145
+
146
+ // To use 'local' driver:
147
+ // * key: base directory
148
+ // * secret: ignored, can be null
149
+ // * opts object:
150
+ // * readOnly: optional, never change anything on the filesystem; default is false
151
+ // * fileMode: optional, permissions used when creating new files, default is 0600. can be string or integer
152
+ // * dirMode: optional, permissions used when creating new directories, default is 0700. can be string or integer
153
+ const local = await mobiletto('local', '/home/ubuntu/tmp', null, {fileMode: 0o0600, dirMode: '0700'})
154
+
155
+ // To use 's3' driver:
156
+ // * key: AWS Access Key ID
157
+ // * secret: AWS Secret Key
158
+ // * opts object:
159
+ // * readOnly: optional, never change anything on the bucket; default is false
160
+ // * bucket: required, name of the S3 bucket
161
+ // * region: optional, the AWS region to communicate with, default is us-east-1
162
+ // * prefix: optional, all read/writes within the S3 bucket will be under this prefix
163
+ // * delimiter: optional, directory delimiter, default is '/' (note: always '/' when encryption is enabled)
164
+ const s3 = await mobiletto('s3', aws_key, aws_secret, {bucket: 'bk', region: 'us-east-1'})
165
+
166
+ // To use 'b2' driver:
167
+ // * key: Backblaze Key ID
168
+ // * secret: Backblaze Application Key
169
+ // * opts object:
170
+ // * readOnly: optional, never change anything on the bucket; default is false
171
+ // * bucket: required, the ID (**not the name**) of the B2 bucket
172
+ // * prefix: optional, all read/writes within the B2 bucket will be under this prefix
173
+ // * delimiter: optional, directory delimiter, default is '/' (note: always '/' when encryption is enabled)
174
+ // * partSize: optional, large files will be split into chunks of this size when uploading
175
+ const b3 = await mobiletto('b2', b2_key_id, b2_app_key, {bucket: 'bk', partSize: 10000000})
176
+
177
+ // List files
178
+ api.list() // --> returns an array of metadata objects
179
+
180
+ // List files recursively
181
+ api.list({ recursive: true })
182
+
183
+ // List files in a directory
184
+ const path = 'some/path'
185
+ api.list(path)
186
+ api.list(path, { recursive: true }) // also supports recursive flag
187
+
188
+ // Visit files in a directory -- visitor function must be async
189
+ api.list(path, { visitor: myAsyncFunc })
190
+ api.list(path, { visitor: myAsyncFunc, recursive: true })
191
+
192
+ // The `list` method throws MobilettoNotFoundError if the path does not exist
193
+ // When you call `safeList` on a non-existent path, it returns an empty array
194
+ api.safeList('/path/that/does/not/exist') // returns []
195
+
196
+ // Read metadata for a file
197
+ api.metadata(path) // returns metadata object
198
+
199
+ // The `metadata` method throws MobilettoNotFoundError if the path does not exist
200
+ // When you call `safeMetadata` on a non-existent path, it returns null
201
+ api.safeMetadata('/tmp/does_not_exist') // returns null
202
+
203
+ // Read a file
204
+ // Provide a callback that writes the data someplace
205
+ const callback = (chunk) => { ... write chunk somewhere ... }
206
+ api.read(path, callback) // returns count of bytes read
207
+
208
+ // Read an entire file at once
209
+ const data = await api.readFile(path) // returns a byte Buffer of the file contents
210
+
211
+ // Read an entire file at once
212
+ // returns null if an exception would otherwise be thrown
213
+ const bufferOrNull = await bucket.safeReadFile('some/path')
214
+
215
+ // Write a file
216
+ // Provide a generator function that yields chunks of data
217
+ const generator = function* () {
218
+ while ( ... more-data-to-return ... ) {
219
+ data = ... load-data ...
220
+ yield data
221
+ }
222
+ }
223
+ local.api(path, generator) // returns count of bytes written
224
+
225
+ // Write an entire file at once (convenience method)
226
+ await api.writeFile(path, bufferOrString) // returns count of bytes written
227
+
228
+ // Delete a file
229
+ // Quiet param is optional (default false), when set errors will not be thrown if the path does not exist
230
+ // Always returns a value or throws an error.
231
+ // Return value may be a single string of the file removed, or an array of all files removed (driver-dependent)
232
+ const quiet = true
233
+ api.remove(path, {quiet}) // returns single path removed
234
+
235
+ // Recursively delete a directory and do it quietly (do not report errors)
236
+ const recursive = true
237
+ const quiet = true
238
+ api.remove(path, {recursive, quiet}) // returns array of paths removed
239
+
240
+ ## Metadata
241
+ O le `metadata` poloaiga e toe fa'afo'i mai metadata e uiga i se faila faila e tasi.
242
+ E fa'apea fo'i, o le tau fa'afo'i mai le `list` fa'atonuga o se fa'asologa o mea metadata.
243
+
244
+ O se mea metadata e pei o lenei:
245
+
246
+ {
247
+ "name": "fully/qualified/path/to/file",
248
+ "type": "entry-type",
249
+ "size": size-in-bytes,
250
+ "ctime": creation-time-epoch-millis,
251
+ "mtime": modification-time-epoch-millis
252
+ }
253
+
254
+ O le meatotino `type` e mafai ona avea ma `file` , `dir` , `link` , po'o `special` .
255
+
256
+ Fa'alagolago ile ituaiga aveta'avale, ole `list` fa'atonuga e le mafai ona toe fa'afo'i uma fanua. Le `name` ma `type` meatotino
257
+ e tatau ona i ai i taimi uma. Ole fa'atonuga ole `metadata` ole a toe fa'afo'i uma meatotino avanoa.
258
+
259
+ ## Su'i faiga fa'aulufale mai
260
+ Fa'aulufale mai le fa'aoga atoa ma fa'aoga le `connect` galuega:
261
+
262
+ const storage = require('mobiletto')
263
+ const opts = {bucket: 'bk', region: 'us-east-1'}
264
+ const s3 = await storage.connect('s3', aws_key, aws_secret, opts)
265
+ const objectData = await s3.readFile('some/path')
266
+
267
+ ## Fa'asao
268
+ E sili ona aoga le Mobiletto i le <a href="https://redis.io">redis</a> cache.
269
+
270
+ Mobiletto o le a taumafai e faʻafesoʻotaʻi i se redis faʻataʻitaʻiga ile 127.0.0.1:6379
271
+
272
+ E mafai ona e suia se tasi o mea nei:
273
+ * Seti le `MOBILETTO_REDIS_HOST` env var, mobiletto fesootai iinei nai lo localhost
274
+ * Seti le `MOBILETTO_REDIS_PORT` env var, o le a fa'aoga lenei uafu
275
+
276
+ Mobiletto o le a teuina uma ana ki redis ma le prefix `_mobiletto__` . E mafai ona e suia lenei mea
277
+ e ala i le setiina o le `MOBILETTO_REDIS_PREFIX` env var.
278
+
279
+ E mafai fo'i ona e setiina le fa'aogaina o feso'ota'iga ma le mea `opts.redisConfig` :
280
+
281
+ const redisConfig = {
282
+ enabled: true, // optional, default is true. if false other props are ignored
283
+ host: '127.0.0.1',
284
+ port: 6379,
285
+ prefix: '_mobiletto__'
286
+ }
287
+ const opts = { redisConfig, bucket: 'bk', region: 'us-east-1' }
288
+ const s3 = await storage.connect('s3', aws_key, aws_secret, opts)
289
+
290
+ ### E te le manaʻo e toe faʻapipiʻi faʻailoga?
291
+ E fa'agata: pasi `enabled: false` i lau `opts.redisConfig` mea pe a e fa'atuina lau feso'ota'iga.
292
+
293
+ E pei ona talanoaina i lalo, o le tapeina o le caching o le a i ai se aafiaga leaga i le faatinoga ma maua ai nisi talosaga
294
+ i le teuina e te manaʻomia moni lava.
295
+
296
+ ### Ta'iala fa'asao
297
+ **Teuga fa'aigoa**: faitau/tusitusi fa'ailoga fa'ailoga e fa'agesegese teisi nai lo le masani,
298
+ ae o le fa'ata'amilo i fa'atonuga (lea e fai e nisi mea) e fai si taugata. Faʻaaogaina o le redis cache
299
+ o le a tu'uina atu ia te oe se fa'aopoopoga taua tele.
300
+
301
+ O le fa'aoga fa'aoga e saogalemu, ae e le lelei pe afai e tele au tusitusi/ave'ese galuega.
302
+ So'o se tusi pe aveese fa'agaioiga e fa'aleaogaina ai le fa'aoga atoa, fa'amautinoa o le a va'aia e faitauga mulimuli ane le
303
+ suiga lata mai.
304
+
305
+ ### CLI meafaigaluega
306
+ Afai o lo'o e fa'aogaina se meafaigaluega CLI pei o le [mobiletto-cli](https://www.npmjs.com/package/mobiletto-cli),
307
+ e mautinoa lava e te mana'o e fa'aaga le cache redis, aua e tumau i le fa'atonuga o le `mo` command.
308
+
309
+ ## Fa'ata
310
+
311
+ // Copy a local filesystem mobiletto to S3
312
+ s3.mirror(local)
313
+
314
+ // Mirror a local subdirectory from one mobiletto to an S3 mobiletto, with it's own subdirectory
315
+ local.mirror(s3, 'some/local-folder', 'some/s3-folder')
316
+
317
+ O le `mirror` fa'atonuga e faia se kopi tasi taimi o faila uma mai le tasi mobiletto i le isi.
318
+ E leai se faiga e fa'atumauina ai le fa'ata ile taimi. Toe fa'atonu le `mirror`
319
+ e fa'amaopoopo so'o se faila e misi.
320
+
321
+ O le tau fa'afo'i mai `mirror` o se mea faigofie ma fa'atau mo le tele o faila na manuia
322
+ fa'ata ma pe fia faila na iai mea sese:
323
+
324
+ {
325
+ success: count-of-files-mirrored,
326
+ errors: count-of-files-with-errors
327
+ }
328
+
329
+ LAPATA'IGA: O le fa'ataina o seti fa'amaumauga tetele e mafai ona alu tele le taimi ma fa'ato'a tele le bandwidth
330
+
331
+ Faatasi ai ma le `mirror` valaau semantics e mafai i nisi taimi ona fenumiai le malamalama po o ai le
332
+ tagata faitau ma o ai le tusitala. Vaʻai faalemafaufau e pei o se faʻamatalaga o tofiga: o le "lima agavale mobiletto"
333
+ o le mea o loʻo tuʻuina atu i (faʻata faʻamatalaga tusia), ma le "lima taumatau mobiletto" (le
334
+ finauga i le `mirror` auala) o le tau o loʻo tuʻuina atu (faʻata faʻamatalaga faitau).
335
+
336
+ ## Fa'amatalaga manino
337
+ Fa'aagaioi le fa'amalamalamaga manino le itu o tagata o tausia:
338
+
339
+ // Pass encryption parameters
340
+ const encryption = {
341
+ // key is required, must be >= 16 chars
342
+ key: randomstring.generate(128),
343
+
344
+ // optional, the default is to derive IV from key
345
+ // when set, IV must be >= 16 chars
346
+ iv: randomstring.generate(128),
347
+
348
+ // optional, the default is aes-256-cbc
349
+ algo: 'aes-256-cbc'
350
+ }
351
+ const api = await mobiletto(driverName, key, secret, opts, encryption)
352
+
353
+ // Subsequent write operations will encrypt data (client side) when writing
354
+ // Subsequent read operations will decrypt data (client side) when reading
355
+
356
+ O le a le mea o tupu? O se isi fa'asinomaga "fa'asinomaga" (dirent) fa'ailoga (fa'ailoga) e su'e ai faila o lo'o i ai
357
+ directory (a'o le directory directory).
358
+ * O le `list` poloaiga e faitau ai faila fa'amaufa'ailoga, fa'ate'aina ala ta'itasi o lo'o lisiina; ona toe faafoi mai lea o metadata mo faila taitasi
359
+ * `list` poloaiga e sili atu le le lelei, aemaise lava mo faʻamaumauga e tele faila
360
+ * O le fa'atonuga `write` tusi' e tusia ai faila eseese i fa'amaumauga a matua ta'itasi, fa'asolosolo; ona tusi lea o le faila
361
+ * O tulafono `write` o le a maua ai le O(N) tusitusi, ma N = loloto i le fa'atonuga o le lisi.
362
+ * O le fa'atonuga `remove` e aveese ai le faila tu'usa'o, ma lona matua pe a gaogao, fa'asolosolo; ona aveese lea o le faila
363
+ * O tulafono `remove` e le toe fa'afo'isia o le a maua ai le O(N) faitau ma e ono tele fo'i le tapeina, fa'atasi ai ma le N = loloto i le fa'asologa o fa'atonuga.
364
+ * `remove` i luga o faila faila tetele ma loloto e mafai ona taugata
365
+
366
+ Manatua e tusa lava pe fa'amanaia le fa'ailoga tagata o tausia, o se fili ma le va'aia atoatoa i lau 'au'aunaga fa'ailoga.
367
+ teuina, e tusa lava pe leai se ki, e mafai lava ona vaʻaia le aofaʻi o faʻamaumauga ma pe fia faila i totonu taʻitasi, ma faʻatasi
368
+ nisi taumafaiga, su'e nisi po'o le fa'atulagaina atoa o le fa'asologa o fa'atonuga.
369
+ *Manatua: Fa'aoga se fausaga mafolafola mo le saogalemu lelei.*
370
+ O le a le iloa e le fili igoa o directories/faila sei vagana ua latou iloa foi lau fa'ailoga
371
+ ki po'o na fa'asolo manuia le fa'ailoga. Ua uma loa peti uma!
372
+
373
+ ### Fa'atinoga ma le fa'aoga
374
+ E mafai ona faagesegese le fa'agaioiga i luga o le teuina fa'ailoga. E mafai ona telegese le fa'asologa o lisi ma aveese.
375
+ E fesoasoani tele le fa'asaoina e ala i le redis, ae ia maitauina o lo'o fa'afefe le cache i luga o so'o se tusitusiga pe aveese.
376
+
377
+ ## Ki suiga
378
+ Fausia se mobiletto i lau ki fou, ona faʻataʻitaʻi lea o faʻamaumauga tuai i totonu:
379
+
380
+ const storage = require('mobiletto')
381
+
382
+ const oldEncryption = { key: .... }
383
+ const oldStorage = await storage.connect('s3', aws_key, aws_secret, {bucket: 'bk', region: 'us-east-1'}, oldEncryption)
384
+
385
+ const newEncryption = { key: .... }
386
+ const newStorage = await storage.connect('s3', aws_key, aws_secret, {bucket: 'zz', region: 'us-east-1'}, newEncryption)
387
+
388
+ newStorage.mirror(oldStorage) // if oldStorage is very large, this may take a looooooong time...
389
+
390
+ ## Fa'atonu aveta'avale
391
+ O le aveta'avale o so'o se faila JS e auina atu i fafo se galuega 'storageClient' ma lenei saini:
392
+
393
+ function storageClient (key, secret, opts)
394
+
395
+ * `key` : o se manoa, lau ki API (mo le `local` aveta'avale o le lisi autu lea)
396
+ * `secret` : o se manoa, lau API mealilo (e mafai ona aveese mo le avetaavale `local` )
397
+ * `opts` : o se mea, o meatotino e ta'i-taavale:
398
+ * Mo `local` , o le `fileMode` ma `dirMode` meatotino e fuafua ai pe fa'afefea ona faia faila fou ma fa'atonuga.
399
+ * Mo `s3` , e mana'omia le meatotino `bucket` . O meatotino e filifili ai o:
400
+ * `region`: the S3 region, default is us-east-1
401
+ * `prefix`: a prefix to prepend to all S3 paths, default is the empty string
402
+ * `delimiter`: the directory delimiter, default is '/'
403
+
404
+ O le mea e toe faʻafoʻi mai e le storageClient galuega e tatau ona faʻamalamalamaina galuega nei:
405
+
406
+ // Test the driver before using, ensure proper configuration
407
+ async testConfig ()
408
+
409
+ // List files in path (or from base-directory)
410
+ // If recursive is true, list recursively
411
+ // If visitor is defined, it will be an async function. await the visitor function on each file found
412
+ // Otherwise, perform the listing and return an array of objects
413
+ async list (path, recursive = false, visitor = null) // path may be omitted
414
+
415
+ // Read metadata for a path
416
+ async metadata (path)
417
+
418
+ // Read a file
419
+ // callback receives a chunk of data. endCallback is called at end-of-stream
420
+ async read (path, callback, endCallback = null)
421
+
422
+ // Write a file
423
+ // driver must be able to handle a generator or a stream
424
+ async write (path, generatorOrReadableStream)
425
+
426
+ // Remove a file, or recursively delete a directory
427
+ // returns a string of a single path removed, or an array of multiple paths removed
428
+ async remove (path, recursive = false, quiet = false)
429
+
430
+ ## Loka
431
+ E fa'aoga e Mobiletto le faletusi talatala [winston](https://www.npmjs.com/package/winston).
432
+
433
+ O ogalaau **o le a** iai ala faila ma feʻau sese, ae o le a **leai lava** iai ki, mealilo,
434
+ po'o so'o se isi fa'amatalaga fa'aopoopo feso'ota'iga.
435
+
436
+ ### Tulaga ogalaau
437
+ Fa'aoga le suiga ole siosiomaga `MOBILETTO_LOG_LEVEL` e seti ai le maualuga o ogalaau, fa'aaoga le tasi
438
+ o tulaga `npm` o lo'o fa'amatalaina i le [https://www.npmjs.com/package/winston#logging-levels](https://www.npmjs.com/package/winston#logging-levels)
439
+
440
+ Ole tulaga fa'aletonu ole `error` . Ole la'asaga pito sili ona tautala ole `silly` , e ui o le taimi nei o mobiletto
441
+ e le fa'amauina i tulaga i lalo ole `debug`
442
+
443
+ MOBILETTO_LOG_LEVEL=silly # maximum logs!
444
+
445
+ ### Faila faila
446
+ Ona o le faaletonu, e tusi le logger i le faamafanafanaga. Ina ia lafo atu ogalaau i se faila, seti le `MOBILETTO_LOG_FILE`
447
+ fesuiaiga o le siosiomaga. A o'o i se faila, o le a le toe tusia ni ogalaau i le fa'amafanafanaga.
448
+
449
+ MOBILETTO_LOG_FILE=/var/my_mobiletto_log
450
+
451
+ Ina ia tape le laiga:
452
+
453
+ MOBILETTO_LOG_FILE=/dev/null
454
+
455
+ </pre>