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
@@ -0,0 +1,481 @@
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
+ * [Ynstallaasje](#Ynstallaasje)
12
+ * [Support and Funding](#Support-and-Funding)
13
+ * [Basisgebrûk](#Basisgebrûk)
14
+ * [Metadata](#Metadata)
15
+ * [Alternate ymportstyl](#Alternate-ymportstyl)
16
+ * [Caching](#Caching)
17
+ * [Spiegeljen](#Spiegeljen)
18
+ * [Transparante fersifering](#Transparante-fersifering)
19
+ * [Key rotation](#Key-rotation)
20
+ * [Sjauffeur-ynterface](#Bestjoerder-ynterface)
21
+ * [Logging](#Logging)
22
+
23
+ # Lês dit yn in oare taal
24
+ Dit README.md dokumint is oerset, fia [hokeylization](https://github.com/cobbzilla/hokeylization), yn
25
+ **[elke taal stipe troch Google Translate](https://cloud.google.com/translate/docs/languages)!**
26
+
27
+ Ik bin der wis fan dat it net perfekt is, mar ik hoopje dat it better is as neat!
28
+
29
+ [🇸🇦 Arabysk](../ar/README.md)
30
+ [🇧🇩 Bengali](../bn/README.md)
31
+ [🇩🇪 Dútsk](../de/README.md)
32
+ [🇺🇸 Ingelsk](../en/README.md)
33
+ [🇪🇸 Spaansk](../es/README.md)
34
+ [🇫🇷 Frânsk](../fr/README.md)
35
+ [🇹🇩 Hausa](../ha/README.md)
36
+ [🇮🇳 Hindi](../hi/README.md)
37
+ [🇮🇩 Yndonesysk](../id/README.md)
38
+ [🇮🇹 Italjaansk](../it/README.md)
39
+ [🇯🇵 Japansk](../ja/README.md)
40
+ [🇰🇷 Koreaansk](../ko/README.md)
41
+ [🇮🇳 Maranthi](../mr/README.md)
42
+ [🇵🇱 Poalsk](../pl/README.md)
43
+ [🇧🇷 Portugeesk](../pt/README.md)
44
+ [🇷🇺 Russysk](../ru/README.md)
45
+ [🇰🇪 Swahili](../sw/README.md)
46
+ [🇵🇭 Tagalog](../tl/README.md)
47
+ [🇹🇷 Turksk](../tr/README.md)
48
+ [🇵🇰 Urdu](../ur/README.md)
49
+ [🇻🇳 Fietnameesk](../vi/README.md)
50
+ [🇨🇳 Sineesk](../zh/README.md)
51
+
52
+
53
+ **[📚 ... Alle talen ...](../README.md)**
54
+ ----
55
+
56
+ ### Is der in probleem mei dizze oersetting fan de README?
57
+ Dizze bysûndere oersetting fan it orizjineel [README](https://github.com/cobbzilla/mobiletto/blob/master/README.md)
58
+ kin defekt wêze -- *korreksjes binne tige wolkom!* Stjoer asjebleaft in [pull request on GitHub](https://github.com/cobbzilla/mobiletto/pulls),
59
+ of as jo it net noflik binne om dat te dwaan, [iepenje in probleem](https://github.com/cobbzilla/mobiletto/issues)
60
+
61
+ As jo in nij GitHub-probleem oanmeitsje oer in oersetting, dwaan dan:
62
+ * befetsje de side-URL (kopiearje / plakke fan browseradresbalke)
63
+ * befetsje de krekte tekst dy't ferkeard is (kopiearje / plakke fan browser)
64
+ * beskriuw asjebleaft wat der mis is -- is de oersetting ferkeard? is de opmaak op ien of oare manier brutsen?
65
+ * biede freonlik in suggestje foar in bettere oersetting, of hoe't de tekst goed opmakke wurde moat
66
+ * **Dankewol!**
67
+
68
+ ## Wêrom Mobiletto?
69
+
70
+ ### Goodbye ferkeaper lock-in!
71
+ De ferskate oanbieders fan wolkopslach hawwe ynkompatibele API's. Sels dyjingen dy't stribje nei "S3-kompatibiliteit"
72
+ hawwe eigensinnige gedrach.
73
+
74
+ As jo in bepaalde opslachferkeaper kieze foar jo app, as jo direkt koade nei har API, jo app
75
+ is no ôfhinklik fan dy tsjinst. As de tiid trochgiet en koade accumulearret, wurde wikseljende leveransiers
76
+ hieltyd mear ûnhâldber. Wolkom by de leuke wrâld fan ferkeaper lock-in!
77
+
78
+ Mobiletto is ûntworpen om dit probleem op te lossen. Troch jo app te kodearjen nei de API fan mobiletto, kinne jo maklik
79
+ feroarje opslachproviders en wit dat de opslachlaach fan jo app identyk sil gedrage.
80
+
81
+ ### Wiidweidige testen
82
+ Alle bestjoerders wurde hifke foar identyk gedrach mei 60+ tests foar elke bestjoerder.
83
+ Wy testen alle bestjoerders mei elke kombinaasje fan:
84
+ * Fersifering: sawol yn- as útskeakele
85
+ * Redis-cache: sawol ynskeakele as útskeakele
86
+
87
+ Dizze oanpak jout ús frede fan geast dat mobiletto itselde sil gedrage, nettsjinsteande hokker bestjoerder jo brûke,
88
+ en nettsjinsteande oft jo caching en / of fersifering ynskeakelje.
89
+
90
+ ### Driverstipe
91
+ Aktuele Mobiletto-opslachbestjoerders:
92
+ * `s3` : Amazon S3
93
+ * `b2` : Backblaze B2
94
+ * `local` : lokaal bestânssysteem
95
+
96
+ *Bydragen om mear oanbieders fan wolkopslach te stypjen binne tige wolkom!*
97
+
98
+ ## mobiletto-cli
99
+ Mobiletto is bedoeld om te wurde brûkt as bibleteek troch oare JavaScript-koade.
100
+
101
+ Om te wurkjen mei mobiletto by de kommando-rigel, brûk [mobiletto-cli](https://www.npmjs.com/package/mobiletto-cli)
102
+
103
+ ## Boarne
104
+ * [mobiletto op GitHub](https://github.com/cobbzilla/mobiletto)
105
+ * [mobiletto op npm](https://www.npmjs.com/package/mobiletto)
106
+
107
+ ## Stipe en finansiering
108
+ Ik besykje in profesjonele ûntwikkelder fan iepen boarne software te wêzen. Ik haw wurke yn
109
+ de software yndustry foar in protte jierren, Ik haw begûn suksesfolle bedriuwen en ferkocht se oan iepenbiere bedriuwen.
110
+ Koartlyn bin ik myn baan kwytrekke, en ik haw eins gjin oar wurk opsteld
111
+
112
+ Dat ik sil besykje nuttige software te skriuwen en te sjen oft dat wurket
113
+
114
+ As jo genietsje fan in gebrûk dizze sêftguod, Ik soe wêze hiel tankber foar sels de
115
+ lytste [moanlikse bydrage fia Patreon](https://www.patreon.com/cobbzilla)
116
+
117
+ *Dankewol!*
118
+
119
+ ## Ynstallaasje
120
+ Ynstallearje mei `npm` of `yarn` . Jo wolle wierskynlik de `lite` ferzje dy't net alle
121
+ oersette README-bestannen:
122
+
123
+ npm install mobiletto-lite
124
+ yarn add mobiletto-lite
125
+
126
+ As jo de README-bestannen wirklik yn elke taal wolle, ynstallearje dan de folsleine ferzje:
127
+
128
+ npm install mobiletto
129
+ yarn add mobiletto
130
+
131
+ ## Flugge start
132
+ In koart foarbyld mei de mobiletto `s3` -bestjoerder.
133
+
134
+ Dizze koade soe itselde rinne as de bestjoerder `b2` of `local` .
135
+
136
+ const storage = require('mobiletto')
137
+ const bucket = await storage.connect('s3', aws_key, aws_secret, {bucket: 'bk'})
138
+
139
+ // list objects: returns array of metadata objects
140
+ const listing = await bucket.list()
141
+ const dirList = await bucket.list('some/dir/')
142
+ const everything = await bucket.list('', {recursive: true})
143
+
144
+ // write an entire file
145
+ let bytesWritten = await bucket.writeFile('some/path', someBufferOfData)
146
+
147
+ // write a file from a stream/generator
148
+ bytesWritten = await bucket.write('some/path', streamOrGenerator)
149
+
150
+ // read an entire file
151
+ // returns null if an exception would otherwise be thrown
152
+ const bufferOrNull = await bucket.safeReadFile('some/path')
153
+
154
+ // stream-read a file, passing data to callback
155
+ const bytesRead = await bucket.read('some/path', (chunk) => { ...do something with chunk... } )
156
+
157
+ // remove a file, returns the path removed
158
+ let removed = await bucket.remove('some/path') // removed is a string
159
+
160
+ // remove a directory, returns array of paths removed
161
+ removed = await bucket.remove('some/directory', {recursive: true}) // removed is now an array!
162
+
163
+ ----
164
+ ## Basisgebrûk
165
+ In folle wiidweidiger foarbyld, dat de measte fan 'e oanbeane funksjes toant:
166
+
167
+ const { mobiletto } = require('mobiletto')
168
+
169
+ // General usage
170
+ const api = await mobiletto(driverName, key, secret, opts)
171
+
172
+ // To use 'local' driver:
173
+ // * key: base directory
174
+ // * secret: ignored, can be null
175
+ // * opts object:
176
+ // * readOnly: optional, never change anything on the filesystem; default is false
177
+ // * fileMode: optional, permissions used when creating new files, default is 0600. can be string or integer
178
+ // * dirMode: optional, permissions used when creating new directories, default is 0700. can be string or integer
179
+ const local = await mobiletto('local', '/home/ubuntu/tmp', null, {fileMode: 0o0600, dirMode: '0700'})
180
+
181
+ // To use 's3' driver:
182
+ // * key: AWS Access Key ID
183
+ // * secret: AWS Secret Key
184
+ // * opts object:
185
+ // * readOnly: optional, never change anything on the bucket; default is false
186
+ // * bucket: required, name of the S3 bucket
187
+ // * region: optional, the AWS region to communicate with, default is us-east-1
188
+ // * prefix: optional, all read/writes within the S3 bucket will be under this prefix
189
+ // * delimiter: optional, directory delimiter, default is '/' (note: always '/' when encryption is enabled)
190
+ const s3 = await mobiletto('s3', aws_key, aws_secret, {bucket: 'bk', region: 'us-east-1'})
191
+
192
+ // To use 'b2' driver:
193
+ // * key: Backblaze Key ID
194
+ // * secret: Backblaze Application Key
195
+ // * opts object:
196
+ // * readOnly: optional, never change anything on the bucket; default is false
197
+ // * bucket: required, the ID (**not the name**) of the B2 bucket
198
+ // * prefix: optional, all read/writes within the B2 bucket will be under this prefix
199
+ // * delimiter: optional, directory delimiter, default is '/' (note: always '/' when encryption is enabled)
200
+ // * partSize: optional, large files will be split into chunks of this size when uploading
201
+ const b3 = await mobiletto('b2', b2_key_id, b2_app_key, {bucket: 'bk', partSize: 10000000})
202
+
203
+ // List files
204
+ api.list() // --> returns an array of metadata objects
205
+
206
+ // List files recursively
207
+ api.list({ recursive: true })
208
+
209
+ // List files in a directory
210
+ const path = 'some/path'
211
+ api.list(path)
212
+ api.list(path, { recursive: true }) // also supports recursive flag
213
+
214
+ // Visit files in a directory -- visitor function must be async
215
+ api.list(path, { visitor: myAsyncFunc })
216
+ api.list(path, { visitor: myAsyncFunc, recursive: true })
217
+
218
+ // The `list` method throws MobilettoNotFoundError if the path does not exist
219
+ // When you call `safeList` on a non-existent path, it returns an empty array
220
+ api.safeList('/path/that/does/not/exist') // returns []
221
+
222
+ // Read metadata for a file
223
+ api.metadata(path) // returns metadata object
224
+
225
+ // The `metadata` method throws MobilettoNotFoundError if the path does not exist
226
+ // When you call `safeMetadata` on a non-existent path, it returns null
227
+ api.safeMetadata('/tmp/does_not_exist') // returns null
228
+
229
+ // Read a file
230
+ // Provide a callback that writes the data someplace
231
+ const callback = (chunk) => { ... write chunk somewhere ... }
232
+ api.read(path, callback) // returns count of bytes read
233
+
234
+ // Read an entire file at once
235
+ const data = await api.readFile(path) // returns a byte Buffer of the file contents
236
+
237
+ // Read an entire file at once
238
+ // returns null if an exception would otherwise be thrown
239
+ const bufferOrNull = await bucket.safeReadFile('some/path')
240
+
241
+ // Write a file
242
+ // Provide a generator function that yields chunks of data
243
+ const generator = function* () {
244
+ while ( ... more-data-to-return ... ) {
245
+ data = ... load-data ...
246
+ yield data
247
+ }
248
+ }
249
+ local.api(path, generator) // returns count of bytes written
250
+
251
+ // Write an entire file at once (convenience method)
252
+ await api.writeFile(path, bufferOrString) // returns count of bytes written
253
+
254
+ // Delete a file
255
+ // Quiet param is optional (default false), when set errors will not be thrown if the path does not exist
256
+ // Always returns a value or throws an error.
257
+ // Return value may be a single string of the file removed, or an array of all files removed (driver-dependent)
258
+ const quiet = true
259
+ api.remove(path, {quiet}) // returns single path removed
260
+
261
+ // Recursively delete a directory and do it quietly (do not report errors)
262
+ const recursive = true
263
+ const quiet = true
264
+ api.remove(path, {recursive, quiet}) // returns array of paths removed
265
+
266
+ ## Metadata
267
+ It kommando `metadata` jout metadata werom oer in inkele triemsysteemyngong.
268
+ Likemin is de weromkommende wearde fan it kommando `list` in array fan metadata-objekten.
269
+
270
+ In metadata-objekt sjocht der sa út:
271
+
272
+ {
273
+ "name": "fully/qualified/path/to/file",
274
+ "type": "entry-type",
275
+ "size": size-in-bytes,
276
+ "ctime": creation-time-epoch-millis,
277
+ "mtime": modification-time-epoch-millis
278
+ }
279
+
280
+ De eigenskip `type` kin `file` , `dir` , `link` , of `special` .
281
+
282
+ Ofhinklik fan it type bestjoerder kin in `list` kommando net alle fjilden weromjaan. De eigenskippen `name` namme' en `type`
283
+ moat altyd oanwêzich wêze. In folgjende kommando `metadata` sil alle beskikbere eigenskippen weromjaan.
284
+
285
+ ## Alternatyf ymportstyl
286
+ Ymportearje de module mei folslein berik en brûk de funksje `connect` :
287
+
288
+ const storage = require('mobiletto')
289
+ const opts = {bucket: 'bk', region: 'us-east-1'}
290
+ const s3 = await storage.connect('s3', aws_key, aws_secret, opts)
291
+ const objectData = await s3.readFile('some/path')
292
+
293
+ ## Caching
294
+ Mobiletto wurket it bêste mei in <a href="https://redis.io">redis</a> -cache.
295
+
296
+ Mobiletto sil besykje te ferbinen mei in redis-eksimplaar op 127.0.0.1:6379
297
+
298
+ Jo kinne ien fan dizze oerskriuwe:
299
+ * Stel de `MOBILETTO_REDIS_HOST` env var, mobilet yn om hjir te ferbinen ynstee fan localhost
300
+ * Stel de `MOBILETTO_REDIS_PORT` env var yn, dizze poarte sil brûkt wurde
301
+
302
+ Mobiletto sil al syn redis-kaaien opslaan mei it foarheaksel `_mobiletto__` . Jo kinne dit feroarje
303
+ troch it ynstellen fan `MOBILETTO_REDIS_PREFIX` env var.
304
+
305
+ Jo kinne ek caching per ferbining ynstelle mei it objekt `opts.redisConfig` :
306
+
307
+ const redisConfig = {
308
+ enabled: true, // optional, default is true. if false other props are ignored
309
+ host: '127.0.0.1',
310
+ port: 6379,
311
+ prefix: '_mobiletto__'
312
+ }
313
+ const opts = { redisConfig, bucket: 'bk', region: 'us-east-1' }
314
+ const s3 = await storage.connect('s3', aws_key, aws_secret, opts)
315
+
316
+ ### Wolle jo gjin redis caching?
317
+ Om út te skeakeljen: pass `enabled: false` yn jo `opts.redisConfig` objekt as jo jo ferbining meitsje.
318
+
319
+ Lykas hjirûnder besprutsen, sil it útskeakeljen fan caching in negatyf effekt hawwe op prestaasjes en mear oanfragen meitsje
320
+ oan opslach dy't jo echt nedich binne.
321
+
322
+ ### Caching-begelieding
323
+ ** Fersifere opslach **: it lêzen/skriuwen fan fersifere opslach is mar in bytsje stadiger dan normaal,
324
+ mar navigearje om mappen (wat guon dingen dogge) is frij djoer. Mei help fan in redis-cache
325
+ sil jaan dy in wichtige prestaasje ympuls.
326
+
327
+ De standert cache is feilich, mar docht net goed as jo in protte skriuw-/ferwideringsoperaasjes hawwe.
328
+ Eltse skriuw- of fuortsmite operaasje ûnjildich de hiele cache, garandearjen pafolgende lêzen sil sjen de
329
+ lêste feroarings.
330
+
331
+ ### CLI-ark
332
+ As jo in CLI-ark brûke lykas [mobiletto-cli](https://www.npmjs.com/package/mobiletto-cli),
333
+ jo sille perfoarst wolle dat de redis-cache ynskeakele is, om't it duorret oer oproppen fan it kommando `mo` .
334
+
335
+ ## Mirroring
336
+
337
+ // Copy a local filesystem mobiletto to S3
338
+ s3.mirror(local)
339
+
340
+ // Mirror a local subdirectory from one mobiletto to an S3 mobiletto, with it's own subdirectory
341
+ local.mirror(s3, 'some/local-folder', 'some/s3-folder')
342
+
343
+ It kommando `mirror` fiert in ienmalige kopy út fan alle bestannen fan de iene mobiletto nei de oare.
344
+ It rint gjin proses om de spegel oer de tiid te behâlden. Laad it kommando `mirror` wer út
345
+ om alle ûntbrekkende bestannen te syngronisearjen.
346
+
347
+ De `mirror` is in ienfâldich objekt mei tellers foar hoefolle bestannen mei súkses wiene
348
+ spegele en hoefolle bestannen hawwe flaters:
349
+
350
+ {
351
+ success: count-of-files-mirrored,
352
+ errors: count-of-files-with-errors
353
+ }
354
+
355
+ WARSKUWING: It spegeljen fan grutte datasets kin heul tiidslinend en bânbreedte-yntinsyf wêze
356
+
357
+ Mei de `mirror` oprop semantyk kin it soms betiizjend wêze om te begripen wa't de is
358
+ lêzer en wa is de skriuwer. Stel jo it foar as in opdrachtferklearring: de "linkerhand mobiletto"
359
+ is it ding dat wurdt tawiisd oan (spegele gegevens skreaun), en de "rjochterhand mobiletto" (de
360
+ argumint oan 'e `mirror` metoade) is de wearde dy't wurdt tawiisd (spegele gegevens wurde lêzen).
361
+
362
+ ## Transparante fersifering
363
+ Transparante fersifering oan de clientside ynskeakelje:
364
+
365
+ // Pass encryption parameters
366
+ const encryption = {
367
+ // key is required, must be >= 16 chars
368
+ key: randomstring.generate(128),
369
+
370
+ // optional, the default is to derive IV from key
371
+ // when set, IV must be >= 16 chars
372
+ iv: randomstring.generate(128),
373
+
374
+ // optional, the default is aes-256-cbc
375
+ algo: 'aes-256-cbc'
376
+ }
377
+ const api = await mobiletto(driverName, key, secret, opts, encryption)
378
+
379
+ // Subsequent write operations will encrypt data (client side) when writing
380
+ // Subsequent read operations will decrypt data (client side) when reading
381
+
382
+ Wat bart der? In aparte "directory-yngong" (dirent) map (fersifere) tracks hokker bestannen dêryn binne
383
+ map (alias de dirent map).
384
+ * It kommando 'list' lêst de triemmen yn 'e `list` , ûntsiferet elk fermelde paad; jout dan metadata foar elke triem werom
385
+ * Kommando's 'list' binne `list` , foaral foar mappen mei in grut oantal bestannen
386
+ * It kommando `write` skriuwt dirent bestannen yn de dirent map fan elke âlder, rekursyf; dan skriuwt de triem
387
+ * `write` kommando's sille O(N) skriuwe, mei N = djipte yn 'e maphierarchy
388
+ * It kommando 'ferwiderje' ferwideret it korrespondearjende `remove` bestân, en syn âlder as leech, rekursyf; dan fuortsmite de triem
389
+ * Net-rekursive `remove` en mooglik safolle wiskjen, mei N = djipte yn 'e maphierarchy
390
+ * Rekursive `remove` kommando's op grutte en djippe bestânssystemen kinne djoer wêze
391
+
392
+ Tink derom dat sels mei fersifering oan kliïntside ynskeakele, in tsjinstanner mei folsleine sichtberens yn jo fersifere serverside
393
+ opslach, sels sûnder de kaai, kin noch sjen it totale oantal mappen en hoefolle triemmen binne yn elk, en mei
394
+ guon ynspannings , ûntdekke guon of al de totale struktuer fan de triemtafel hiërargy.
395
+ *Opmerking: Brûk in relatyf platte struktuer foar bettere feiligens.*
396
+ De tsjinstanner soe de nammen fan 'e mappen/bestannen net kenne, útsein as se jo fersifering ek wisten
397
+ kaai of hie oars de fersifering mei súkses kreake. Alle bets binne dan út!
398
+
399
+ ### Prestaasje en caching
400
+ Operaasjes op fersifere opslach kinne stadich wêze. Rekursive listings en ferwideringen kinne heul stadich wêze.
401
+ Caching fia redis helpt enoarm, mar tink derom dat de cache wurdt spoeld by elk skriuwt of fuorthelle.
402
+
403
+ ## Toetsrotaasje
404
+ Meitsje in mobiletto mei jo nije kaai, en spegelje dan de âlde gegevens deryn:
405
+
406
+ const storage = require('mobiletto')
407
+
408
+ const oldEncryption = { key: .... }
409
+ const oldStorage = await storage.connect('s3', aws_key, aws_secret, {bucket: 'bk', region: 'us-east-1'}, oldEncryption)
410
+
411
+ const newEncryption = { key: .... }
412
+ const newStorage = await storage.connect('s3', aws_key, aws_secret, {bucket: 'zz', region: 'us-east-1'}, newEncryption)
413
+
414
+ newStorage.mirror(oldStorage) // if oldStorage is very large, this may take a looooooong time...
415
+
416
+ ## Driver ynterface
417
+ In stjoerprogramma is elk JS-bestân dat in 'storageClient'-funksje eksportearret mei dizze hantekening:
418
+
419
+ function storageClient (key, secret, opts)
420
+
421
+ * `key` : in tekenrige, jo API-kaai (foar it `local` stjoerprogramma is dit de basismap)
422
+ * `secret` : in tekenrige, jo API-geheim (kin weilitten wurde foar de `local` stjoerprogramma)
423
+ * `opts` : in objekt, de eigenskippen binne per bestjoerder:
424
+ * Foar `local` de `fileMode` en `dirMode` eigenskippen hoe nije oanmeitsjende triemmen en mappen wurde oanmakke
425
+ * Foar `s3` is de eigenskip `bucket` fereaske. Opsjonele eigenskippen binne:
426
+ * `region`: the S3 region, default is us-east-1
427
+ * `prefix`: a prefix to prepend to all S3 paths, default is the empty string
428
+ * `delimiter`: the directory delimiter, default is '/'
429
+
430
+ It objekt dat de storageClient-funksje werombringt moat dizze funksjes definiearje:
431
+
432
+ // Test the driver before using, ensure proper configuration
433
+ async testConfig ()
434
+
435
+ // List files in path (or from base-directory)
436
+ // If recursive is true, list recursively
437
+ // If visitor is defined, it will be an async function. await the visitor function on each file found
438
+ // Otherwise, perform the listing and return an array of objects
439
+ async list (path, recursive = false, visitor = null) // path may be omitted
440
+
441
+ // Read metadata for a path
442
+ async metadata (path)
443
+
444
+ // Read a file
445
+ // callback receives a chunk of data. endCallback is called at end-of-stream
446
+ async read (path, callback, endCallback = null)
447
+
448
+ // Write a file
449
+ // driver must be able to handle a generator or a stream
450
+ async write (path, generatorOrReadableStream)
451
+
452
+ // Remove a file, or recursively delete a directory
453
+ // returns a string of a single path removed, or an array of multiple paths removed
454
+ async remove (path, recursive = false, quiet = false)
455
+
456
+ ## Logging
457
+ Mobiletto brûkt de [winston](https://www.npmjs.com/package/winston) logging bibleteek.
458
+
459
+ Logboeken **sil** triempaden en flaterberjochten befetsje, mar sille **nea** kaaien, geheimen,
460
+ of hokker oare ferbining konfiguraasje ynformaasje.
461
+
462
+ ### Lognivo
463
+ Brûk de omjouwingsfariabele `MOBILETTO_LOG_LEVEL` om it lognivo yn te stellen, mei ien
464
+ fan de `npm` nivo's definieare yn [https://www.npmjs.com/package/winston#logging-levels](https://www.npmjs.com/package/winston#logging-levels)
465
+
466
+ It standertnivo is `error` . It meast verbose nivo is `silly` , hoewol op it stuit mobiletto
467
+ `debug`
468
+
469
+ MOBILETTO_LOG_LEVEL=silly # maximum logs!
470
+
471
+ ### Logtriem
472
+ Standert skriuwt de logger nei de konsole. Om logs nei in bestân te stjoeren, set de `MOBILETTO_LOG_FILE`
473
+ omjouwing fariabele. By it oanmelden nei in bestân sille logs net mear nei de konsole skreaun wurde.
474
+
475
+ MOBILETTO_LOG_FILE=/var/my_mobiletto_log
476
+
477
+ Om logging út te skeakeljen:
478
+
479
+ MOBILETTO_LOG_FILE=/dev/null
480
+
481
+ </pre>