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
+ Mobiletto is in JavaSkript-opslachabstraksjelaach, mei opsjonele transparante fersifering oan de client-side.
5
+
6
+ # Ynhâld
7
+ * [Wêrom Mobiletto?](#Why-Mobiletto?)
8
+ * [Fluchstart](#Fluchstart)
9
+ * [Mobiletto CLI](#mobiletto-cli)
10
+ * [Boarne](#Boarne)
11
+ * [Basisgebrûk](#Basisgebrûk)
12
+ * [Metadata](#Metadata)
13
+ * [Alternate ymportstyl](#Alternate-ymportstyl)
14
+ * [Caching](#Caching)
15
+ * [Spiegeljen](#Spiegeljen)
16
+ * [Transparante fersifering](#Transparante-fersifering)
17
+ * [Key rotation](#Key-rotation)
18
+ * [Sjauffeur-ynterface](#Bestjoerder-ynterface)
19
+ * [Logging](#Logging)
20
+
21
+ # Lês dit yn in oare taal
22
+ Dit README.md dokumint is oerset, fia [hokeylization](https://github.com/cobbzilla/hokeylization), yn
23
+ **[elke taal stipe troch Google Translate](https://cloud.google.com/translate/docs/languages)!**
24
+
25
+ Ik bin der wis fan dat it net perfekt is, mar ik hoopje dat it better is as neat!
26
+
27
+ [🇸🇦 Arabysk](../ar/README.md)
28
+ [🇧🇩 Bengali](../bn/README.md)
29
+ [🇩🇪 Dútsk](../de/README.md)
30
+ [🇺🇸 Ingelsk](../en/README.md)
31
+ [🇪🇸 Spaansk](../es/README.md)
32
+ [🇫🇷 Frânsk](../fr/README.md)
33
+ [🇹🇩 Hausa](../ha/README.md)
34
+ [🇮🇳 Hindi](../hi/README.md)
35
+ [🇮🇩 Yndonesysk](../id/README.md)
36
+ [🇮🇹 Italjaansk](../it/README.md)
37
+ [🇯🇵 Japansk](../ja/README.md)
38
+ [🇰🇷 Koreaansk](../ko/README.md)
39
+ [🇮🇳 Maranthi](../mr/README.md)
40
+ [🇵🇱 Poalsk](../pl/README.md)
41
+ [🇧🇷 Portugeesk](../pt/README.md)
42
+ [🇷🇺 Russysk](../ru/README.md)
43
+ [🇰🇪 Swahili](../sw/README.md)
44
+ [🇵🇭 Tagalog](../tl/README.md)
45
+ [🇹🇷 Turksk](../tr/README.md)
46
+ [🇵🇰 Urdu](../ur/README.md)
47
+ [🇻🇳 Fietnameesk](../vi/README.md)
48
+ [🇨🇳 Sineesk](../zh/README.md)
49
+
50
+
51
+ **[📚 ... Alle talen ...](../README.md)**
52
+ ----
53
+
54
+ ### Is der in probleem mei dizze oersetting fan de README?
55
+ Dizze bysûndere oersetting fan it orizjineel [README](https://github.com/cobbzilla/mobiletto/blob/master/README.md)
56
+ kin defekt wêze -- *korreksjes binne tige wolkom!* Stjoer asjebleaft in [pull request on GitHub](https://github.com/cobbzilla/mobiletto/pulls),
57
+ of as jo it net noflik binne om dat te dwaan, [iepenje in probleem](https://github.com/cobbzilla/mobiletto/issues)
58
+
59
+ As jo in nij GitHub-probleem oanmeitsje oer in oersetting, dwaan dan:
60
+ * befetsje de side-URL (kopiearje / plakke fan browseradresbalke)
61
+ * befetsje de krekte tekst dy't ferkeard is (kopiearje / plakke fan browser)
62
+ * beskriuw asjebleaft wat der mis is -- is de oersetting ferkeard? is de opmaak op ien of oare manier brutsen?
63
+ * biede freonlik in suggestje foar in bettere oersetting, of hoe't de tekst goed opmakke wurde moat
64
+ * **Dankewol!**
65
+
66
+ ## Wêrom Mobiletto?
67
+
68
+ ### Goodbye ferkeaper lock-in!
69
+ De ferskate oanbieders fan wolkopslach hawwe ynkompatibele API's. Sels dyjingen dy't stribje nei "S3-kompatibiliteit"
70
+ hawwe eigensinnige gedrach.
71
+
72
+ As jo in bepaalde opslachferkeaper kieze foar jo app, as jo direkt koade nei har API, jo app
73
+ is no ôfhinklik fan dy tsjinst. As de tiid trochgiet en koade accumulearret, wurde wikseljende leveransiers
74
+ hieltyd mear ûnhâldber. Wolkom by de leuke wrâld fan ferkeaper lock-in!
75
+
76
+ Mobiletto is ûntworpen om dit probleem op te lossen. Troch jo app te kodearjen nei de API fan mobiletto, kinne jo maklik
77
+ feroarje opslachproviders en wit dat de opslachlaach fan jo app identyk sil gedrage.
78
+
79
+ ### Wiidweidige testen
80
+ Alle bestjoerders wurde hifke foar identyk gedrach mei 60+ tests foar elke bestjoerder.
81
+ Wy testen alle bestjoerders mei elke kombinaasje fan:
82
+ * Fersifering: sawol yn- as útskeakele
83
+ * Redis-cache: sawol ynskeakele as útskeakele
84
+
85
+ Dizze oanpak jout ús frede fan geast dat mobiletto itselde sil gedrage, nettsjinsteande hokker bestjoerder jo brûke,
86
+ en nettsjinsteande oft jo caching en / of fersifering ynskeakelje.
87
+
88
+ ### Driverstipe
89
+ Aktuele Mobiletto-opslachbestjoerders:
90
+ * `s3` : Amazon S3
91
+ * `b2` : Backblaze B2
92
+ * `local` : lokaal bestânssysteem
93
+
94
+ *Bydragen om mear oanbieders fan wolkopslach te stypjen binne tige wolkom!*
95
+
96
+ ## mobiletto-cli
97
+ Mobiletto is bedoeld om te wurde brûkt as bibleteek troch oare JavaScript-koade.
98
+
99
+ Om te wurkjen mei mobiletto by de kommando-rigel, brûk [mobiletto-cli](https://www.npmjs.com/package/mobiletto-cli)
100
+
101
+ ## Boarne
102
+ * [mobiletto op GitHub](https://github.com/cobbzilla/mobiletto)
103
+ * [mobiletto op npm](https://www.npmjs.com/package/mobiletto)
104
+
105
+ ## Flugge start
106
+ In koart foarbyld mei de mobiletto `s3` -bestjoerder.
107
+
108
+ Dizze koade soe itselde rinne as de bestjoerder `b2` of `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
+ ## Basisgebrûk
139
+ In folle wiidweidiger foarbyld, dat de measte fan 'e oanbeane funksjes toant:
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
+ It kommando `metadata` jout metadata werom oer in inkele triemsysteemyngong.
242
+ Likemin is de weromkommende wearde fan it kommando `list` in array fan metadata-objekten.
243
+
244
+ In metadata-objekt sjocht der sa út:
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
+ De eigenskip `type` kin `file` , `dir` , `link` , of `special` .
255
+
256
+ Ofhinklik fan it type bestjoerder kin in `list` kommando net alle fjilden weromjaan. De eigenskippen `name` namme' en `type`
257
+ moat altyd oanwêzich wêze. In folgjende kommando `metadata` sil alle beskikbere eigenskippen weromjaan.
258
+
259
+ ## Alternatyf ymportstyl
260
+ Ymportearje de module mei folslein berik en brûk de funksje `connect` :
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
+ ## Caching
268
+ Mobiletto wurket it bêste mei in <a href="https://redis.io">redis</a> -cache.
269
+
270
+ Mobiletto sil besykje te ferbinen mei in redis-eksimplaar op 127.0.0.1:6379
271
+
272
+ Jo kinne ien fan dizze oerskriuwe:
273
+ * Stel de `MOBILETTO_REDIS_HOST` env var, mobilet yn om hjir te ferbinen ynstee fan localhost
274
+ * Stel de `MOBILETTO_REDIS_PORT` env var yn, dizze poarte sil brûkt wurde
275
+
276
+ Mobiletto sil al syn redis-kaaien opslaan mei it foarheaksel `_mobiletto__` . Jo kinne dit feroarje
277
+ troch it ynstellen fan `MOBILETTO_REDIS_PREFIX` env var.
278
+
279
+ Jo kinne ek caching per ferbining ynstelle mei it objekt `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
+ ### Wolle jo gjin redis caching?
291
+ Om út te skeakeljen: pass `enabled: false` yn jo `opts.redisConfig` objekt as jo jo ferbining meitsje.
292
+
293
+ Lykas hjirûnder besprutsen, sil it útskeakeljen fan caching in negatyf effekt hawwe op prestaasjes en mear oanfragen meitsje
294
+ oan opslach dy't jo echt nedich binne.
295
+
296
+ ### Caching-begelieding
297
+ ** Fersifere opslach **: it lêzen/skriuwen fan fersifere opslach is mar in bytsje stadiger dan normaal,
298
+ mar navigearje om mappen (wat guon dingen dogge) is frij djoer. Mei help fan in redis-cache
299
+ sil jaan dy in wichtige prestaasje ympuls.
300
+
301
+ De standert cache is feilich, mar docht net goed as jo in protte skriuw-/ferwideringsoperaasjes hawwe.
302
+ Eltse skriuw- of fuortsmite operaasje ûnjildich de hiele cache, garandearjen pafolgende lêzen sil sjen de
303
+ lêste feroarings.
304
+
305
+ ### CLI-ark
306
+ As jo in CLI-ark brûke lykas [mobiletto-cli](https://www.npmjs.com/package/mobiletto-cli),
307
+ jo sille perfoarst wolle dat de redis-cache ynskeakele is, om't it duorret oer oproppen fan it kommando `mo` .
308
+
309
+ ## Mirroring
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
+ It kommando `mirror` fiert in ienmalige kopy út fan alle bestannen fan de iene mobiletto nei de oare.
318
+ It rint gjin proses om de spegel oer de tiid te behâlden. Laad it kommando `mirror` wer út
319
+ om alle ûntbrekkende bestannen te syngronisearjen.
320
+
321
+ De `mirror` is in ienfâldich objekt mei tellers foar hoefolle bestannen mei súkses wiene
322
+ spegele en hoefolle bestannen hawwe flaters:
323
+
324
+ {
325
+ success: count-of-files-mirrored,
326
+ errors: count-of-files-with-errors
327
+ }
328
+
329
+ WARSKUWING: It spegeljen fan grutte datasets kin heul tiidslinend en bânbreedte-yntinsyf wêze
330
+
331
+ Mei de `mirror` oprop semantyk kin it soms betiizjend wêze om te begripen wa't de is
332
+ lêzer en wa is de skriuwer. Stel jo it foar as in opdrachtferklearring: de "linkerhand mobiletto"
333
+ is it ding dat wurdt tawiisd oan (spegele gegevens skreaun), en de "rjochterhand mobiletto" (de
334
+ argumint oan 'e `mirror` metoade) is de wearde dy't wurdt tawiisd (spegele gegevens wurde lêzen).
335
+
336
+ ## Transparante fersifering
337
+ Transparante fersifering oan de clientside ynskeakelje:
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
+ Wat bart der? In aparte "directory-yngong" (dirent) map (fersifere) tracks hokker bestannen dêryn binne
357
+ map (alias de dirent map).
358
+ * It kommando 'list' lêst de triemmen yn 'e `list` , ûntsiferet elk fermelde paad; jout dan metadata foar elke triem werom
359
+ * Kommando's 'list' binne `list` , foaral foar mappen mei in grut oantal bestannen
360
+ * It kommando `write` skriuwt dirent bestannen yn de dirent map fan elke âlder, rekursyf; dan skriuwt de triem
361
+ * `write` kommando's sille O(N) skriuwe, mei N = djipte yn 'e maphierarchy
362
+ * It kommando 'ferwiderje' ferwideret it korrespondearjende `remove` bestân, en syn âlder as leech, rekursyf; dan fuortsmite de triem
363
+ * Net-rekursive `remove` en mooglik safolle wiskjen, mei N = djipte yn 'e maphierarchy
364
+ * Rekursive `remove` kommando's op grutte en djippe bestânssystemen kinne djoer wêze
365
+
366
+ Tink derom dat sels mei fersifering oan kliïntside ynskeakele, in tsjinstanner mei folsleine sichtberens yn jo fersifere serverside
367
+ opslach, sels sûnder de kaai, kin noch sjen it totale oantal mappen en hoefolle triemmen binne yn elk, en mei
368
+ guon ynspannings , ûntdekke guon of al de totale struktuer fan de triemtafel hiërargy.
369
+ *Opmerking: Brûk in relatyf platte struktuer foar bettere feiligens.*
370
+ De tsjinstanner soe de nammen fan 'e mappen/bestannen net kenne, útsein as se jo fersifering ek wisten
371
+ kaai of hie oars de fersifering mei súkses kreake. Alle bets binne dan út!
372
+
373
+ ### Prestaasje en caching
374
+ Operaasjes op fersifere opslach kinne stadich wêze. Rekursive listings en ferwideringen kinne heul stadich wêze.
375
+ Caching fia redis helpt enoarm, mar tink derom dat de cache wurdt spoeld by elk skriuwt of fuorthelle.
376
+
377
+ ## Toetsrotaasje
378
+ Meitsje in mobiletto mei jo nije kaai, en spegelje dan de âlde gegevens deryn:
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
+ ## Driver ynterface
391
+ In stjoerprogramma is elk JS-bestân dat in 'storageClient'-funksje eksportearret mei dizze hantekening:
392
+
393
+ function storageClient (key, secret, opts)
394
+
395
+ * `key` : in tekenrige, jo API-kaai (foar it `local` stjoerprogramma is dit de basismap)
396
+ * `secret` : in tekenrige, jo API-geheim (kin weilitten wurde foar de `local` stjoerprogramma)
397
+ * `opts` : in objekt, de eigenskippen binne per bestjoerder:
398
+ * Foar `local` de `fileMode` en `dirMode` eigenskippen hoe nije oanmeitsjende triemmen en mappen wurde oanmakke
399
+ * Foar `s3` is de eigenskip `bucket` fereaske. Opsjonele eigenskippen binne:
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
+ It objekt dat de storageClient-funksje werombringt moat dizze funksjes definiearje:
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
+ ## Logging
431
+ Mobiletto brûkt de [winston](https://www.npmjs.com/package/winston) logbibleteek.
432
+
433
+ Logboeken **sil** triempaden en flaterberjochten befetsje, mar sille **nea** kaaien, geheimen,
434
+ of hokker oare ferbining konfiguraasje ynformaasje.
435
+
436
+ ### Lognivo
437
+ Brûk de omjouwingsfariabele `MOBILETTO_LOG_LEVEL` om it lognivo yn te stellen, mei ien
438
+ fan de `npm` nivo's definieare yn [https://www.npmjs.com/package/winston#logging-levels](https://www.npmjs.com/package/winston#logging-levels)
439
+
440
+ It standertnivo is `error` . It meast verbose nivo is `silly` , hoewol op it stuit mobiletto
441
+ `debug`
442
+
443
+ MOBILETTO_LOG_LEVEL=silly # maximum logs!
444
+
445
+ ### Logtriem
446
+ Standert skriuwt de logger nei de konsole. Om logs nei in bestân te stjoeren, set de `MOBILETTO_LOG_FILE`
447
+ omjouwing fariabele. By it oanmelden nei in bestân sille logs net mear nei de konsole skreaun wurde.
448
+
449
+ MOBILETTO_LOG_FILE=/var/my_mobiletto_log
450
+
451
+ Om logging út te skeakeljen:
452
+
453
+ MOBILETTO_LOG_FILE=/dev/null
454
+
455
+ </pre>