mobiletto 1.2.1 → 2.0.1

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 (124) hide show
  1. package/lib/cjs/index.d.ts +2 -0
  2. package/lib/cjs/index.js +30 -0
  3. package/lib/cjs/package.json +16 -0
  4. package/lib/esm/index.d.ts +2 -0
  5. package/lib/esm/index.js +12 -0
  6. package/package.json +27 -13
  7. package/.babelrc +0 -5
  8. package/.eslintrc.js +0 -14
  9. package/docs/README.md +0 -113
  10. package/docs/af/README.md +0 -481
  11. package/docs/am/README.md +0 -481
  12. package/docs/ar/README.md +0 -481
  13. package/docs/az/README.md +0 -481
  14. package/docs/be/README.md +0 -481
  15. package/docs/bg/README.md +0 -481
  16. package/docs/bn/README.md +0 -481
  17. package/docs/bs/README.md +0 -481
  18. package/docs/ca/README.md +0 -481
  19. package/docs/ceb/README.md +0 -481
  20. package/docs/co/README.md +0 -481
  21. package/docs/cs/README.md +0 -481
  22. package/docs/cy/README.md +0 -481
  23. package/docs/da/README.md +0 -481
  24. package/docs/de/README.md +0 -481
  25. package/docs/el/README.md +0 -481
  26. package/docs/eo/README.md +0 -481
  27. package/docs/es/README.md +0 -481
  28. package/docs/et/README.md +0 -481
  29. package/docs/eu/README.md +0 -481
  30. package/docs/fa/README.md +0 -481
  31. package/docs/fi/README.md +0 -481
  32. package/docs/fr/README.md +0 -481
  33. package/docs/fy/README.md +0 -481
  34. package/docs/ga/README.md +0 -481
  35. package/docs/gd/README.md +0 -481
  36. package/docs/gl/README.md +0 -481
  37. package/docs/gu/README.md +0 -481
  38. package/docs/ha/README.md +0 -481
  39. package/docs/haw/README.md +0 -481
  40. package/docs/he/README.md +0 -481
  41. package/docs/hi/README.md +0 -481
  42. package/docs/hmn/README.md +0 -481
  43. package/docs/hr/README.md +0 -481
  44. package/docs/ht/README.md +0 -481
  45. package/docs/hu/README.md +0 -481
  46. package/docs/hy/README.md +0 -481
  47. package/docs/id/README.md +0 -481
  48. package/docs/ig/README.md +0 -481
  49. package/docs/is/README.md +0 -481
  50. package/docs/it/README.md +0 -481
  51. package/docs/iw/README.md +0 -481
  52. package/docs/ja/README.md +0 -481
  53. package/docs/jv/README.md +0 -481
  54. package/docs/ka/README.md +0 -481
  55. package/docs/kk/README.md +0 -481
  56. package/docs/km/README.md +0 -481
  57. package/docs/kn/README.md +0 -481
  58. package/docs/ko/README.md +0 -481
  59. package/docs/ku/README.md +0 -481
  60. package/docs/ky/README.md +0 -481
  61. package/docs/la/README.md +0 -481
  62. package/docs/lb/README.md +0 -481
  63. package/docs/lo/README.md +0 -481
  64. package/docs/lt/README.md +0 -481
  65. package/docs/lv/README.md +0 -481
  66. package/docs/mg/README.md +0 -481
  67. package/docs/mi/README.md +0 -481
  68. package/docs/mk/README.md +0 -481
  69. package/docs/ml/README.md +0 -481
  70. package/docs/mn/README.md +0 -481
  71. package/docs/mr/README.md +0 -481
  72. package/docs/ms/README.md +0 -481
  73. package/docs/mt/README.md +0 -481
  74. package/docs/my/README.md +0 -481
  75. package/docs/ne/README.md +0 -481
  76. package/docs/nl/README.md +0 -481
  77. package/docs/no/README.md +0 -481
  78. package/docs/ny/README.md +0 -481
  79. package/docs/or/README.md +0 -481
  80. package/docs/pa/README.md +0 -481
  81. package/docs/pl/README.md +0 -481
  82. package/docs/ps/README.md +0 -481
  83. package/docs/pt/README.md +0 -481
  84. package/docs/ro/README.md +0 -481
  85. package/docs/ru/README.md +0 -481
  86. package/docs/rw/README.md +0 -481
  87. package/docs/sd/README.md +0 -481
  88. package/docs/si/README.md +0 -481
  89. package/docs/sk/README.md +0 -481
  90. package/docs/sl/README.md +0 -481
  91. package/docs/sm/README.md +0 -481
  92. package/docs/sn/README.md +0 -481
  93. package/docs/so/README.md +0 -481
  94. package/docs/sq/README.md +0 -481
  95. package/docs/sr/README.md +0 -481
  96. package/docs/st/README.md +0 -481
  97. package/docs/su/README.md +0 -481
  98. package/docs/sv/README.md +0 -481
  99. package/docs/sw/README.md +0 -481
  100. package/docs/ta/README.md +0 -481
  101. package/docs/te/README.md +0 -481
  102. package/docs/tg/README.md +0 -481
  103. package/docs/th/README.md +0 -481
  104. package/docs/tk/README.md +0 -481
  105. package/docs/tl/README.md +0 -481
  106. package/docs/tr/README.md +0 -481
  107. package/docs/tt/README.md +0 -481
  108. package/docs/ug/README.md +0 -481
  109. package/docs/uk/README.md +0 -481
  110. package/docs/ur/README.md +0 -481
  111. package/docs/uz/README.md +0 -481
  112. package/docs/vi/README.md +0 -481
  113. package/docs/xh/README.md +0 -481
  114. package/docs/yi/README.md +0 -481
  115. package/docs/yo/README.md +0 -481
  116. package/docs/zh/README.md +0 -481
  117. package/docs/zu/README.md +0 -481
  118. package/drivers/b2/index.js +0 -451
  119. package/drivers/local/index.js +0 -315
  120. package/drivers/s3/index.js +0 -316
  121. package/hokey.json +0 -16
  122. package/index.js +0 -29
  123. package/test/api.spec.js +0 -512
  124. package/test/crypt.spec.js +0 -67
package/docs/la/README.md DELETED
@@ -1,481 +0,0 @@
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
- * [Installation](#Installation)
12
- * [Support and Funding](Support-and-Funding)
13
- * [Basic usus](# Usus)
14
- * [Metadata](#Metadata)
15
- * [Alterne import style].
16
- * [Caching](#Caching)
17
- * [Speculum](#Mirroring)
18
- * [Perspicuus encryption](# Transparens-encryption)
19
- * [Key rotationis](#Key-rotatione)
20
- * [Coegi interface](# Coegi-interface)
21
- * [Logging](#Logging)
22
-
23
- # Lege hoc in alia lingua
24
- Hoc README.md documentum translatum est, per [hokeylization](https://github.com/cobbzilla/hokeylization), in
25
- **[Omnis lingua a Google Translate](https://cloud.google.com/translate/docs/languages)!
26
-
27
- Perfectum certe non sum, sed spero melius quam nihil!
28
-
29
- [🇸🇦 Arabic](../ar/README.md)
30
- [🇧🇩 Bengalica](../bn/README.md)
31
- [🇩🇪 German](../de/README.md)
32
- [🇺🇸 English](../en/README.md)
33
- [🇪🇸 Spanish](../es/README.md)
34
- [🇫🇷 French](../fr/README.md)
35
- [🇹🇩 Hausa](../ha/README.md)
36
- [🇮🇳 Hindi](../hi/README.md)
37
- [🇮🇩 Indonesiaca](../id/README.md)
38
- [🇮🇹 Italian](../it/README.md)
39
- [🇯🇵 Japanese](../ja/README.md)
40
- [🇰🇷 Coreanica](../ko/README.md)
41
- [🇮🇳 Marathi](../mr/README.md)
42
- [🇵🇱 Polonica](../pl/README.md)
43
- [🇧🇷 Portuguese](../pt/README.md)
44
- [🇷🇺 Russian](../ru/README.md)
45
- [🇰🇪 Swahili](../sw/README.md)
46
- [🇵🇭 Tagalog](../tl/README.md)
47
- [🇹🇷 Turkish](../tr/README.md)
48
- [🇵🇰 Urdu](../ur/README.md)
49
- [🇻🇳 Vietnamica](../vi/README.md)
50
- [🇨🇳 Chinese](../zh/README.md)
51
-
52
-
53
- **[ ... Omnes Linguae ...](../README.md)**
54
- ----
55
-
56
- ### Estne problema cum hac translatione README?
57
- Haec praecipua translatio originalis [README](https://github.com/cobbzilla/mobiletto/blob/master/README.md)
58
- fortasse vitiosum esse -- *correctiones gratae sunt!* Mitte quaeso [in GitHub rogationem viverra](https://github.com/cobbzilla/mobiletto/pulls);
59
- vel si non es commodus id faciens, [aperi fluxum](https://github.com/cobbzilla/mobiletto/issues)
60
-
61
- Cum novam GitHub quaestionem de translatione creas, quaeso fac;
62
- * Paginam URL includere (exemplum / crustulum ex vecte electronica)
63
- * Textum includere quod est nefas (exemplum / crustulum ex pasco)
64
- * Quaeso describere quid sit iniuria — est interpretatio falsa? fractum est forma aliqua?
65
- * benigne suggestionem praebeant translationis melioris vel quomodo textus debite formatus sit
66
- * **Gratias tibi!**
67
-
68
- ## Cur Mobiletto?
69
-
70
- ### Vale venditori crinem-in!
71
- Variae nubes provisores repono APIs repugnantes habent. Etiam ea quae contendunt ad "S3 convenientiam";
72
- ut idiosyncratic se gerendi rationibus.
73
-
74
- Cum aliquem venditorem repositionis eligis pro app tua, si directe ad eorum API codicem, tuum app
75
- is nunc ab illo servitio dependet. Procedente tempore ac codice accumulat, mutato concionatorum fit
76
- magisque inconveniens. Welcome to the fun mundi venditoris lock-in!
77
-
78
- Mobiletto designatus est hanc quaestionem solvere. Per coding tuum app ad mobiletto scriptor API, facile potes
79
- provisores repositorii mutant et sciunt quod tabulatum app tabularium tuum identice se geret.
80
-
81
- ### Extensiva probatio
82
- Omnes rectores probati sunt pro pari habitu cum 60+ probationibus pro singulis exactoris.
83
- Probamus omnes rectores cum omni complexione;
84
- * Encryption: et enabled et debilem
85
- * Redis cache: tum enabled et debilem
86
-
87
- Aditus nobis pacem dat animo illo mobilitto se gerendi ratione cuius rectoris uteris;
88
- et sive caching sive encryption.
89
-
90
- ### Coegi firmamentum
91
- Current rectoribus Mobiletto repono:
92
- * `s3` : Amazon S3
93
- * `b2` : Backblaze B2
94
- * `local` : localis filesystem
95
-
96
- *Conlationes magis provisores ad nubes suscipiendas valde gratae sunt!*
97
-
98
- ## mobiletto-cli
99
- Mobiletto destinatur ut bibliotheca ab aliis JavaScript codice adhibeatur.
100
-
101
- Laborare cum mobiletto ad lineam praecepti, utere [mobiletto-cli](https://www.npmjs.com/package/mobiletto-cli)
102
-
103
- ## Source
104
- * [Mobiletto on GitHub](https://github.com/cobbzilla/mobiletto)
105
- * [Mobiletto on npm](https://www.npmjs.com/package/mobiletto)
106
-
107
- ## Support et Donec
108
- Conor esse professionalem fontem programmatum elit. I have been working in
109
- industria programmatis multos annos feliciter societates incepi et eas societates publicas vendidi.
110
- Nuper officium meum perdidi, et aliud opus non instruxit
111
-
112
- Eo igitur experior utilium programmatum scribo et vide an opera sit
113
-
114
- Si hoc programmate utendo frueris, gratias ago etiam ipsis
115
- minima [menstrua contributio per Patreon](https://www.patreon.com/cobbzilla)
116
-
117
- *Gratias tibi!*
118
-
119
- ## Installation
120
- Instrue utens `npm` vel `yarn` . Probabiliter vis `lite` quae non includit omnia
121
- README translata files:
122
-
123
- npm install mobiletto-lite
124
- yarn add mobiletto-lite
125
-
126
- Si vere vis tabularia README in omni lingua, plenam versionem institue:
127
-
128
- npm install mobiletto
129
- yarn add mobiletto
130
-
131
- ## Velox Start
132
- Breve exemplum utens agitator mobiletto `s3` .
133
-
134
- Hoc signum idem curreret si auriga `b2` vel `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
- ## Basic usage
165
- Multo maiora exempla sunt, quibus maxime lineamenta proponuntur;
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
- Mandatum `metadata` redit circa unum ingressum filesystem.
268
- Item, reditus pretii a `list` imperio est ordinata metadata obiecti.
269
-
270
- Metadata res similis est:
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
- `type` potest esse `file` , `dir` , `link `link` seu `special` .
281
-
282
- Secundum genus exactoris, mandatum `list` non potest omnes agros reddere. Quod `name` et `type` proprietatibus
283
- semper adesset. Subsequens mandatum `metadata` omnes possessiones promptas reddet.
284
-
285
- ## Alternate import style
286
- Modulus plene-scoped importare et functionem `connect` uti:
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 optime operatur cum <a href="https://redis.io">redis</a> cache.
295
-
296
- Mobiletto coniungere cum redis instantia conabitur in 127.0.0.1:6379
297
-
298
- Vincat utrumque potes:
299
- * `MOBILETTO_REDIS_HOST` env var pone, mobiletto iungo hic pro locali exercitu
300
- * `MOBILETTO_REDIS_PORT` env var pone, hic portus adhibebitur
301
-
302
- Mobiletto omnes suas redis claves cum praepositione `_mobiletto__` . Hoc potes mutare
303
- ponendo `MOBILETTO_REDIS_PREFIX` env var.
304
-
305
- Potes etiam per-connexionem caching cum obiecti `opts.redisConfig` obiecti:
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
- ### Non vis redis caching?
317
- To disable: pass `enabled: false` in your `opts.redisConfig` objectum cum constituis nexum tuum.
318
-
319
- De quibus infra, inactivare caching effectum adversam in effectu habebunt et plures petitiones incurrunt
320
- ad repono quod vere postulo.
321
-
322
- ### Caching direction
323
- ** Encrypted storage**: reading/ writing encrypted storage is only a little slow than normal ;
324
- at navigatio circa directoria (quod aliquae res faciunt) satis pretiosae sunt. Usus redis cache
325
- insigne perficientur dabit tibi boost.
326
-
327
- Defalta cache tuta est, sed bene non facit si multum opus est scribere/remoto.
328
- Quilibet scribat vel removeat operationem integram cella infirmat, prospiciat sequentem legitimum videbunt
329
- tardus mutans.
330
-
331
- ### CLI instrumenta
332
- Si instrumentum uteris quasi [mobiletto-cli](https://www.npmjs.com/package/mobiletto-cli);
333
- certum vis capacitatem redis cache, dum per invocationes `mo` mandati durat.
334
-
335
- ## Speculum
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
- `mirror` ' unum tempus exemplum omnium imaginum ab uno mobilitto ad alterum fungitur.
344
- Non currit aliqua processus ad retinendum speculum in tempore. Curre `mirror` imperium iterum
345
- ut synchronize quis files absentis.
346
-
347
- Valor reditus a `mirror` obiectum simplex est cum calculis quot fasciculi bene erant
348
- speculata et quot lima errores habuit;
349
-
350
- {
351
- success: count-of-files-mirrored,
352
- errors: count-of-files-with-errors
353
- }
354
-
355
- MONITUM: Speculum magna notitia sets possunt esse valde vicis-consumens et sed intensiva
356
-
357
- Cum `mirror` vocamus semanticos interdum potest confundere ad intelligendum quis est the
358
- lector et quis est scriptor. Finge eam quasi constitutionis assignationis: "sinistra mobilitto".
359
- res assignata est (specula notitia scripta), et "manus mobilitto" (the .
360
- argumentum ad methodum `mirror` ) est valor assignatus (in speculo notitia legitur).
361
-
362
- ## Perspicuus encryption
363
- Admitte perlucidum latus encryption clientis;
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
- Quid fit? A separatum "ingressum directorium" (dirent) directorium (encrypted) vestigia quae in eo sunt
383
- directorium (aka directorium directum).
384
- * `list` mandare legit directorium ingressuum imaginum, decryptarum singulae semitae inscriptae; inde redit metadata ad invicem file
385
- * `list` magis inefficaces sunt, praesertim directoria cum magno numero fasciculorum
386
- * The `write` command scribens limas directas in directorio directo cuiusque parentis , recursively ; tunc scribit tabella
387
- * `write` praecipit incursurum O(N) scribens, cum N = profundum in directorio hierarchiae
388
- * The `remove` imperium removet debitam limam direntem, et parentem si inanis est, recursively; tunc aufert lima
389
- * Mandata non-recursiva `remove` incurrunt O (N) legit et potentialiter totidem deletiones, cum N = profundum in directorio hierarchiae.
390
- * Recursive `remove` imperia in magnis et profundis filesystematibus potest esse pretiosa
391
-
392
- Nota quod etiam cum encryption clientelam paravit, adversarium cum plena visibilitate in encrypted servo tuo
393
- Repositiones, etiam sine clave, adhuc videre possunt numerum directorium et quot fasciculi in unaquaque, et cum
394
- aliquem conatum, aliquos vel omnes altiore structurae directorii hierarchiae detegere.
395
- * Nota: utere relative plana structuram ad meliorem securitatem.
396
- Hostis nomina directoria/ imaginum non cognosceret nisi etiam encryptionem tuam sciant
397
- clavis vel aliter feliciter crepuit encryption. Omnes sponsiones sunt tunc off!
398
-
399
- ### euismod et caching
400
- Operationes in repositione encrypted tardae esse possunt. Indices recursivi et remotiones valde tardae esse possunt.
401
- Caching via redis vehementer adiuvat, sed nota quod cella in quavis scribendo vel removendo rubens est.
402
-
403
- ## Key rotationis
404
- Mobiletto crea cum nova clave tua, deinde in illam datam veterem imitari;
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
- ## Coegi interface
417
- A coegi est quaevis fasciculus JS, qui munus exportationis 'storageClient' cum hac subscriptione exportat:
418
-
419
- function storageClient (key, secret, opts)
420
-
421
- * `key` : chorda, clavis API tua (coegi `local` hoc est basis presul)
422
- * `secret` : chorda, tuum API secretum (omitti potest pro `local` )
423
- * `opts` : objectum, proprietatum per-auriga;
424
- * Nam `local` , proprietatibus `fileMode` et `dirMode` determinant quomodo novae tabulae creandi et directoria creantur
425
- * Nam `s3` , `bucket` proprietas requiritur. Proprietates libitum sunt:
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
- Objectum quod munus reponoClient redit, has functiones definire debet:
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 utitur [winston](https://www.npmjs.com/package/winston) bibliotheca logging.
458
-
459
- Tigna lima continent vias et nuntios erroris, sed nunquam claves, secreta continent,
460
- vel quodlibet aliud connexionis informationem.
461
-
462
- ### Log level
463
- Utere `MOBILETTO_LOG_LEVEL` ambitus variabilis ad utere gradum truncum, uno utendo
464
- de gradibus `npm` definitis [https://www.npmjs.com/package/winston#logging-levels](https://www.npmjs.com/package/winston#logging-levels)
465
-
466
- Gradus default est `error` . Gradus verbosissimus est `silly` , quamvis nunc mobilitto .
467
- non log in levels infra `debug`
468
-
469
- MOBILETTO_LOG_LEVEL=silly # maximum logs!
470
-
471
- ### Stipes lima
472
- Defalta, logger ad consolatorium scribit. Ut omnia in tabella mittas, `MOBILETTO_LOG_FILE` . pone
473
- ambitus varius. Cum ad fasciculum colligationem, acta iam ad consolatorium scribenda non erunt.
474
-
475
- MOBILETTO_LOG_FILE=/var/my_mobiletto_log
476
-
477
- Ad logging averte:
478
-
479
- MOBILETTO_LOG_FILE=/dev/null
480
-
481
- </pre>