mobiletto 1.1.8 → 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 (117) hide show
  1. package/README.md +56 -4
  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 +33 -17
  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,455 @@
1
+ Mobiletto
2
+ =========
3
+
4
+ Mobiletto est JavaScript repositionis stratum abstractionis, cum ad libitum perlucidum encryption clientis.
5
+
6
+ # Contents
7
+ * [Quare Mobiletto?](#Quare-Mobiletto?)
8
+ *
9
+ * [Mobiletto CLI](#mobiletto-cli)
10
+ * [Source](#Source)
11
+ * [Basic usus](# Usus)
12
+ * [Metadata](#Metadata)
13
+ * [Alterne import style].
14
+ * [Caching](#Caching)
15
+ * [Speculum](#Mirroring)
16
+ * [Perspicuus encryption](# Transparens-encryption)
17
+ * [Key rotationis](#Key-rotatione)
18
+ * [Coegi interface](# Coegi-interface)
19
+ * [Logging](#Logging)
20
+
21
+ # Lege hoc in alia lingua
22
+ Hoc README.md documentum translatum est, per [hokeylization](https://github.com/cobbzilla/hokeylization), in
23
+ **[Omnis lingua a Google Translate](https://cloud.google.com/translate/docs/languages)!
24
+
25
+ Perfectum certe non sum, sed spero melius quam nihil!
26
+
27
+ [🇸🇦 Arabic](../ar/README.md)
28
+ [🇧🇩 Bengalica](../bn/README.md)
29
+ [🇩🇪 German](../de/README.md)
30
+ [🇺🇸 English](../en/README.md)
31
+ [🇪🇸 Spanish](../es/README.md)
32
+ [🇫🇷 French](../fr/README.md)
33
+ [🇹🇩 Hausa](../ha/README.md)
34
+ [🇮🇳 Hindi](../hi/README.md)
35
+ [🇮🇩 Indonesiaca](../id/README.md)
36
+ [🇮🇹 Italian](../it/README.md)
37
+ [🇯🇵 Japanese](../ja/README.md)
38
+ [🇰🇷 Coreanica](../ko/README.md)
39
+ [🇮🇳 Maranthi](../mr/README.md)
40
+ [🇵🇱 Polonica](../pl/README.md)
41
+ [🇧🇷 Portuguese](../pt/README.md)
42
+ [🇷🇺 Russian](../ru/README.md)
43
+ [🇰🇪 Swahili](../sw/README.md)
44
+ [🇵🇭 Tagalog](../tl/README.md)
45
+ [🇹🇷 Turkish](../tr/README.md)
46
+ [🇵🇰 Urdu](../ur/README.md)
47
+ [🇻🇳 Vietnamica](../vi/README.md)
48
+ [🇨🇳 Chinese](../zh/README.md)
49
+
50
+
51
+ **[ ... Omnes Linguae ...](../README.md)**
52
+ ----
53
+
54
+ ### Estne problema cum hac translatione README?
55
+ Haec praecipua translatio originalis [README](https://github.com/cobbzilla/mobiletto/blob/master/README.md)
56
+ fortasse vitiosum esse -- *correctiones gratae sunt!* Mitte quaeso [in GitHub rogationem viverra](https://github.com/cobbzilla/mobiletto/pulls);
57
+ vel si non es commodus id faciens, [aperi fluxum](https://github.com/cobbzilla/mobiletto/issues)
58
+
59
+ Cum novam GitHub quaestionem de translatione creas, quaeso fac;
60
+ * Paginam URL includere (exemplum / crustulum ex vecte electronica)
61
+ * Textum includere quod est nefas (exemplum / crustulum ex pasco)
62
+ * Quaeso describere quid sit iniuria — est interpretatio falsa? fractum est forma aliqua?
63
+ * benigne suggestionem praebeant translationis melioris vel quomodo textus debite formatus sit
64
+ * **Gratias tibi!**
65
+
66
+ ## Cur Mobiletto?
67
+
68
+ ### Vale venditori seram-in!
69
+ Variae nubes provisores repono APIs repugnantes habent. Etiam ea quae contendunt ad "S3 convenientiam";
70
+ ut idiosyncratic se gerendi rationibus.
71
+
72
+ Cum aliquem venditorem repositionis eligis pro app tua, si directe ad eorum API codicem, tuum app
73
+ is nunc ab illo servitio dependet. Procedente tempore ac codice accumulat, mutato concionatorum fit
74
+ magisque inconveniens. Welcome to the fun mundi venditoris lock-in!
75
+
76
+ Mobiletto designatus est hanc quaestionem solvere. Per coding tuum app ad mobiletto scriptor API, facile potes
77
+ provisores repositorii mutant et sciunt quod tabulatum app tabularium tuum identice se geret.
78
+
79
+ ### Extensiva probatio
80
+ Omnes rectores probati sunt pro pari habitu cum 60+ probationibus pro singulis exactoris.
81
+ Probamus omnes rectores cum omni complexione;
82
+ * Encryption: et enabled et debilem
83
+ * Redis cache: tum enabled et debilem
84
+
85
+ Aditus nobis pacem dat animo illo mobilitto se gerendi ratione cuius rectoris uteris;
86
+ et sive caching sive encryption.
87
+
88
+ ### Coegi firmamentum
89
+ Current rectoribus Mobiletto repono:
90
+ * `s3` : Amazon S3
91
+ * `b2` : Backblaze B2
92
+ * `local` : localis filesystem
93
+
94
+ *Conlationes magis provisores ad nubes suscipiendas valde gratae sunt!*
95
+
96
+ ## mobiletto-cli
97
+ Mobiletto destinatur ut bibliotheca ab aliis JavaScript codice adhibeatur.
98
+
99
+ Laborare cum mobiletto ad lineam praecepti, utere [mobiletto-cli](https://www.npmjs.com/package/mobiletto-cli)
100
+
101
+ ## Source
102
+ * [Mobiletto on GitHub](https://github.com/cobbzilla/mobiletto)
103
+ * [Mobiletto on npm](https://www.npmjs.com/package/mobiletto)
104
+
105
+ ## Velox Start
106
+ Breve exemplum utens agitator mobiletto `s3` .
107
+
108
+ Hoc signum idem curreret si auriga `b2` vel `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
+ ## Basic usage
139
+ Multo maiora exempla sunt, quibus maxime lineamenta proponuntur;
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
+ Mandatum `metadata` redit circa unum ingressum filesystem.
242
+ Item, reditus pretii a `list` imperio est ordinata metadata obiecti.
243
+
244
+ Metadata res similis est:
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
+ `type` potest esse `file` , `dir` , `link `link` seu `special` .
255
+
256
+ Secundum genus exactoris, mandatum `list` non potest omnes agros reddere. Quod `name` et `type` proprietatibus
257
+ semper adesset. Subsequens mandatum `metadata` omnes possessiones promptas reddet.
258
+
259
+ ## Alternate import style
260
+ Modulus plene-scoped importare et functionem `connect` uti:
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 optime operatur cum <a href="https://redis.io">redis</a> cache.
269
+
270
+ Mobiletto coniungere cum redis instantia conabitur in 127.0.0.1:6379
271
+
272
+ Vincat utrumque potes:
273
+ * `MOBILETTO_REDIS_HOST` env var pone, mobiletto iungo hic pro locali exercitu
274
+ * `MOBILETTO_REDIS_PORT` env var pone, hic portus adhibebitur
275
+
276
+ Mobiletto omnes suas redis claves cum praepositione `_mobiletto__` . Hoc potes mutare
277
+ ponendo `MOBILETTO_REDIS_PREFIX` env var.
278
+
279
+ Potes etiam per-connexionem caching cum obiecti `opts.redisConfig` obiecti:
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
+ ### Non vis redis caching?
291
+ To disable: pass `enabled: false` in your `opts.redisConfig` objectum cum constituis nexum tuum.
292
+
293
+ De quibus infra, inactivare caching effectum adversam in effectu habebunt et plures petitiones incurrunt
294
+ ad repono quod vere postulo.
295
+
296
+ ### Caching direction
297
+ ** Encrypted storage**: reading/ writing encrypted storage is only a little slow than normal ;
298
+ at navigatio circa directoria (quod aliquae res faciunt) satis pretiosae sunt. Usus redis cache
299
+ insigne perficientur dabit tibi boost.
300
+
301
+ Defalta cache tuta est, sed bene non facit si multum opus est scribere/remoto.
302
+ Quilibet scribat vel removeat operationem integram cella infirmat, prospiciat sequentem legitimum videbunt
303
+ tardus mutans.
304
+
305
+ ### CLI instrumenta
306
+ Si instrumentum uteris quasi [mobiletto-cli](https://www.npmjs.com/package/mobiletto-cli);
307
+ certum vis capacitatem redis cache, dum per invocationes `mo` mandati durat.
308
+
309
+ ## Speculum
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
+ `mirror` ' unum tempus exemplum omnium imaginum ab uno mobilitto ad alterum fungitur.
318
+ Non currit aliqua processus ad retinendum speculum in tempore. Curre `mirror` imperium iterum
319
+ ut synchronize quis files absentis.
320
+
321
+ Valor reditus a `mirror` obiectum simplex est cum calculis quot fasciculi bene erant
322
+ speculata et quot lima errores habuit;
323
+
324
+ {
325
+ success: count-of-files-mirrored,
326
+ errors: count-of-files-with-errors
327
+ }
328
+
329
+ MONITUM: Speculum magna notitia sets possunt esse valde vicis-consumens et sed intensiva
330
+
331
+ Cum `mirror` vocamus semanticos interdum potest confundere ad intelligendum quis est the
332
+ lector et quis est scriptor. Finge eam quasi constitutionis assignationis: "sinistra mobilitto".
333
+ res assignata est (specula notitia scripta), et "manus mobilitto" (the .
334
+ argumentum ad methodum `mirror` ) est valor assignatus (in speculo notitia legitur).
335
+
336
+ ## Perspicuus encryption
337
+ Admitte perlucidum latus encryption clientis;
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
+ Quid fit? A separatum "ingressum directorium" (dirent) directorium (encrypted) vestigia quae in eo sunt
357
+ directorium (aka directorium directum).
358
+ * `list` mandare legit directorium ingressuum imaginum, decryptarum singulae semitae inscriptae; inde redit metadata ad invicem file
359
+ * `list` magis inefficaces sunt, praesertim directoria cum magno numero fasciculorum
360
+ * The `write` command scribens limas directas in directorio directo cuiusque parentis , recursively ; tunc scribit tabella
361
+ * `write` praecipit incursurum O(N) scribens, cum N = profundum in directorio hierarchiae
362
+ * The `remove` imperium removet debitam limam direntem, et parentem si inanis est, recursively; tunc aufert lima
363
+ * Mandata non-recursiva `remove` incurrunt O (N) legit et potentialiter totidem deletiones, cum N = profundum in directorio hierarchiae.
364
+ * Recursive `remove` imperia in magnis et profundis filesystematibus potest esse pretiosa
365
+
366
+ Nota quod etiam cum encryption clientelam paravit, adversarium cum plena visibilitate in encrypted servo tuo
367
+ Repositiones, etiam sine clave, adhuc videre possunt numerum directorium et quot fasciculi in unaquaque, et cum
368
+ aliquem conatum, aliquos vel omnes altiore structurae directorii hierarchiae detegere.
369
+ * Nota: utere relative plana structuram ad meliorem securitatem.
370
+ Hostis nomina directoria/ imaginum non cognosceret nisi etiam encryptionem tuam sciant
371
+ clavis vel aliter feliciter crepuit encryption. Omnes sponsiones sunt tunc off!
372
+
373
+ ### euismod et caching
374
+ Operationes in repositione encrypted tardius possunt. Indices recursivi et remotiones valde tardae esse possunt.
375
+ Caching via redis vehementer adiuvat, sed nota quod cella in quavis scribendo vel removendo rubens est.
376
+
377
+ ## Key rotationis
378
+ Mobiletto crea cum nova clave tua, deinde in illam datam veterem imitari;
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
+ ## Coegi interface
391
+ A coegi est quaevis fasciculus JS, qui munus exportationis 'storageClient' cum hac subscriptione exportat:
392
+
393
+ function storageClient (key, secret, opts)
394
+
395
+ * `key` : chorda, clavis API tua (coegi `local` hoc est basis presul)
396
+ * `secret` : chorda, tuum API secretum (omitti potest pro `local` )
397
+ * `opts` : objectum, proprietatum per-auriga;
398
+ * Nam `local` , proprietatibus `fileMode` et `dirMode` determinant quomodo novae tabulae creandi et directoria creantur
399
+ * Nam `s3` , `bucket` proprietas requiritur. Proprietates libitum sunt:
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
+ Objectum quod munus reponoClient redit, has functiones definire debet:
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 utitur [winston](https://www.npmjs.com/package/winston) bibliotheca logging.
432
+
433
+ Tigna lima continent vias et nuntios erroris, sed nunquam claves, secreta continent.
434
+ vel quaevis alia connexionis conformatio notitia.
435
+
436
+ ### Log level
437
+ Utere `MOBILETTO_LOG_LEVEL` ambitus variabilis ad utere gradum truncum, uno utendo
438
+ de gradibus `npm` definitis [https://www.npmjs.com/package/winston#logging-levels](https://www.npmjs.com/package/winston#logging-levels)
439
+
440
+ Gradus default est `error` . Gradus verbosissimus est `silly` , quamvis nunc mobilitto .
441
+ non log in levels infra `debug`
442
+
443
+ MOBILETTO_LOG_LEVEL=silly # maximum logs!
444
+
445
+ ### Stipes lima
446
+ Defalta, logger ad consolatorium scribit. Ut omnia in tabella mittas, `MOBILETTO_LOG_FILE` . pone
447
+ ambitus varius. Cum ad limam colligationem, acta iam ad consolatorium scribenda non erunt.
448
+
449
+ MOBILETTO_LOG_FILE=/var/my_mobiletto_log
450
+
451
+ Ad logging averte:
452
+
453
+ MOBILETTO_LOG_FILE=/dev/null
454
+
455
+ </pre>