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 on JavaScripti salvestamise abstraktsioonikiht, millel on valikuline läbipaistev kliendipoolne krüptimine.
5
+
6
+ # Sisu
7
+ * [Miks Mobiletto?](#Why-Mobiletto?)
8
+ * [Kiire algus](#Quick-start)
9
+ * [Mobiletto CLI](#mobiletto-cli)
10
+ * [Allikas](#Allikas)
11
+ * [Põhikasutus](#Põhikasutus)
12
+ * [Metaandmed](#Metadata)
13
+ * [Alternatiivne impordi stiil](#Alternate-import-style)
14
+ * [vahemällu salvestamine](#vahemällu salvestamine)
15
+ * [Peegeldamine](#Peegeldamine)
16
+ * [Läbipaistev krüptimine](#Transparent-encryption)
17
+ * [Key rotation](#Key-rotation)
18
+ * [Draiveri liides](#Driver-interface)
19
+ * [Logimine](#Logging)
20
+
21
+ # Lugege seda teises keeles
22
+ See README.md dokument on [hokeylization](https://github.com/cobbzilla/hokeylization) kaudu tõlgitud keelde
23
+ **[Google'i tõlge toetab kõiki keeli](https://cloud.google.com/translate/docs/languages)!**
24
+
25
+ Olen kindel, et see pole täiuslik, aga ma loodan, et see on parem kui mitte midagi!
26
+
27
+ [🇸🇦 araabia](../ar/README.md)
28
+ [🇧🇩 Bengali](../bn/README.md)
29
+ [🇩🇪 saksa keel](../de/README.md)
30
+ [🇺🇸 inglise keel](../en/README.md)
31
+ [🇪🇸 hispaania](../es/README.md)
32
+ [🇫🇷 prantsuse keel](../fr/README.md)
33
+ [🇹🇩 Hausa](../ha/README.md)
34
+ [🇮🇳 Hindi](../hi/README.md)
35
+ [🇮🇩 Indoneesia](../id/README.md)
36
+ [🇮🇹 itaalia](../it/README.md)
37
+ [🇯🇵 jaapani](../ja/README.md)
38
+ [🇰🇷 korea](../ko/README.md)
39
+ [🇮🇳 Maranthi](../mr/README.md)
40
+ [🇵🇱 Poola](../pl/README.md)
41
+ [🇧🇷 portugali](../pt/README.md)
42
+ [🇷🇺 vene keel](../ru/README.md)
43
+ [🇰🇪 suahiili](../sw/README.md)
44
+ [🇵🇭 Tagalog](../tl/README.md)
45
+ [🇹🇷 türgi](../tr/README.md)
46
+ [🇵🇰 Urdu](../ur/README.md)
47
+ [🇻🇳 vietnami](../vi/README.md)
48
+ [🇨🇳 hiina](../zh/README.md)
49
+
50
+
51
+ **[📚 ... Kõik keeled ...](../README.md)**
52
+ ----
53
+
54
+ ### Kas selle README tõlkega on probleeme?
55
+ See konkreetne originaali [README] tõlge (https://github.com/cobbzilla/mobiletto/blob/master/README.md)
56
+ võib olla vigane -- *parandused on väga teretulnud!* Saatke [tõmbetaotlus GitHubis](https://github.com/cobbzilla/mobiletto/pulls),
57
+ või kui te ei soovi seda teha, [avage probleem](https://github.com/cobbzilla/mobiletto/issues)
58
+
59
+ Kui loote tõlke kohta uue GitHubi probleemi, tehke järgmist.
60
+ * lisage lehe URL (kopeerige/kleepige brauseri aadressiribalt)
61
+ * lisage täpne tekst, mis on vale (kopeeri/kleebi brauserist)
62
+ * palun kirjeldage, mis on valesti – kas tõlge on vale? kas vormindus on kuidagi katki?
63
+ * pakkuge lahkelt ettepanekut parema tõlke kohta või kuidas tekst tuleks õigesti vormistada
64
+ * **Aitäh!**
65
+
66
+ ## Miks just Mobiletto?
67
+
68
+ ### Hüvasti müüja lukustus!
69
+ Erinevatel pilvesalvestuse pakkujatel on ühildumatud API-d. Isegi need, mis püüdlevad "S3-ühilduvuse poole"
70
+ omavad omapärast käitumist.
71
+
72
+ Kui valite oma rakendusele konkreetse salvestusruumi tarnija, kui kodeerite otse nende API-sse, oma rakendusse
73
+ sõltub nüüd sellest teenusest. Aja möödudes ja koodi kogunedes muutuvad tarnijad
74
+ üha talumatumaks. Tere tulemast müüja lukustamise lõbusasse maailma!
75
+
76
+ Mobiletto loodi selle probleemi lahendamiseks. Kodeerides oma rakenduse mobiletto API-sse, saate seda hõlpsalt teha
77
+ muutke salvestusruumi pakkujat ja teadke, et teie rakenduse salvestuskiht käitub identselt.
78
+
79
+ ### Ulatuslikud testid
80
+ Kõiki juhte testitakse identse käitumise suhtes, iga juhi kohta tehakse 60+ testi.
81
+ Testime kõiki draivereid kõigi järgmiste kombinatsioonidega:
82
+ * Krüpteerimine: nii lubatud kui ka keelatud
83
+ * Redis vahemälu: nii lubatud kui ka keelatud
84
+
85
+ See lähenemine annab meile meelerahu, et mobiletto käitub samamoodi, olenemata sellest, millist draiverit kasutate,
86
+ ja olenemata sellest, kas lubate vahemällu salvestamise ja/või krüptimise.
87
+
88
+ ### Juhi tugi
89
+ Praegused Mobiletto salvestusdraiverid:
90
+ * `s3` : Amazon S3
91
+ * `b2` : Backblaze B2
92
+ * `local` : kohalik failisüsteem
93
+
94
+ *Kaastööd rohkemate pilvesalvestuse pakkujate toetamiseks on väga teretulnud!*
95
+
96
+ ## mobiletto-cli
97
+ Mobiletto on mõeldud kasutamiseks muu JavaScripti koodi raamatukoguna.
98
+
99
+ Käsureal mobilettoga töötamiseks kasutage [mobiletto-cli](https://www.npmjs.com/package/mobiletto-cli)
100
+
101
+ ## Allikas
102
+ * [mobiletto GitHubis](https://github.com/cobbzilla/mobiletto)
103
+ * [mobiletto on npm](https://www.npmjs.com/package/mobiletto)
104
+
105
+ ## Kiire algus
106
+ Lühike näide mobiletto `s3` draiveri kasutamisest.
107
+
108
+ See kood töötaks sama, kui draiver oleks `b2` või `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
+ ## Põhikasutus
139
+ Palju ulatuslikum näide, mis näitab enamikku pakutavatest funktsioonidest:
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
+ ## Metaandmed
241
+ Käsk `metadata` tagastab metaandmed ühe failisüsteemi kirje kohta.
242
+ Samamoodi on käsu `list` metaandmeobjektide massiiv.
243
+
244
+ Metaandmete objekt näeb välja selline:
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
+ Atribuut `type` type" võib olla `file` " , `link` `dir` " , "link" või `special` .
255
+
256
+ Olenevalt draiveri tüübist ei pruugi käsk `list` kõiki välju tagastada. `name` ja `type`
257
+ peaks alati kohal olema. Järgnev `metadata` käsk tagastab kõik saadaolevad atribuudid.
258
+
259
+ ## Alternatiivne impordi stiil
260
+ Importige täieliku ulatusega moodul ja kasutage funktsiooni `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
+ ## Vahemälu
268
+ Mobiletto töötab kõige paremini <a href="https://redis.io">redis</a> -vahemäluga.
269
+
270
+ Mobiletto proovib luua ühenduse redis-eksemplariga aadressil 127.0.0.1:6379
271
+
272
+ Saate alistada ühe järgmistest:
273
+ * Seadke `MOBILETTO_REDIS_HOST` env var, mobile loob siin ühenduse kohaliku hosti asemel
274
+ * Määra `MOBILETTO_REDIS_PORT` env var, seda porti kasutatakse
275
+
276
+ Mobiletto salvestab kõik oma redis-võtmed eesliitega `_mobiletto__` . Saate seda muuta
277
+ määrates `MOBILETTO_REDIS_PREFIX` env var.
278
+
279
+ Ühendusepõhise vahemällu saate määrata ka objektiga `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
+ ### Kas te ei soovi uuesti vahemällu salvestada?
291
+ Keelamiseks edastage ühenduse loomisel objektile `opts.redisConfig` `enabled: false` false".
292
+
293
+ Nagu allpool kirjeldatud, avaldab vahemällu salvestamise keelamine jõudlust negatiivselt ja toob kaasa rohkem taotlusi
294
+ salvestusruumi, mida te tõesti vajate.
295
+
296
+ ### Vahemällu salvestamise juhised
297
+ **Krüpteeritud salvestusruum**: krüptitud salvestusruumi lugemine/kirjutamine on tavalisest veidi aeglasem,
298
+ kuid kataloogides navigeerimine (mida mõned asjad teevad) on üsna kulukas. Redis vahemälu kasutamine
299
+ annab teile märkimisväärse jõudluse tõuke.
300
+
301
+ Vaikevahemälu on turvaline, kuid ei tööta hästi, kui teil on palju kirjutamis-/eemaldustoiminguid.
302
+ Iga kirjutamis- või eemaldamisoperatsioon muudab kogu vahemälu kehtetuks, tagades, et järgnevad lugemised näevad
303
+ viimased muudatused.
304
+
305
+ ### CLI tööriistad
306
+ Kui kasutate CLI-tööriista, nagu [mobiletto-cli](https://www.npmjs.com/package/mobiletto-cli),
307
+ kindlasti soovite redis-vahemälu lubada, kuna see kestab kogu käsu `mo` väljakutsumise ajal.
308
+
309
+ ## Peegeldamine
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
+ Käsk `mirror` teeb kõigist failidest ühekordse koopia ühest mobiilist teise.
318
+ See ei käivita peegli aja jooksul hooldamiseks ühtegi protsessi. Käivitage käsk `mirror` uuesti
319
+ puuduvate failide sünkroonimiseks.
320
+
321
+ `mirror` on lihtne objekt, millel on loendurid selle kohta, kui palju faile õnnestus
322
+ peegeldatud ja kui paljudes failides oli vigu:
323
+
324
+ {
325
+ success: count-of-files-mirrored,
326
+ errors: count-of-files-with-errors
327
+ }
328
+
329
+ HOIATUS: suurte andmekogumite peegeldamine võib olla väga aeganõudev ja ribalaiusmahukas
330
+
331
+ `mirror` semantika puhul võib mõnikord olla segane aru saada, kes on
332
+ lugeja ja kes on kirjutaja. Kujutage ette seda nagu ülesandelause: "vasakpoolne mobiiltelefon"
333
+ on asi, millele määratakse (kirjutatud peegelandmed) ja "parempoolne mobiiltelefon" (
334
+ `mirror` argument) on omistatav väärtus (loetakse peegeldatud andmeid).
335
+
336
+ ## Läbipaistev krüptimine
337
+ Luba läbipaistev kliendipoolne krüptimine:
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
+ Mis toimub? Eraldi "kataloogi kirje" (dirent) kataloog (krüpteeritud) jälgib, millised failid selles on
357
+ kataloog (teise nimega dirent kataloog).
358
+ * Käsk `list` loeb kataloogikirje failid, dekrüpteerib iga loetletud tee; seejärel tagastab iga faili metaandmed
359
+ * Käsud `list` on ebaefektiivsemad, eriti suure hulga failidega kataloogide puhul
360
+ * Käsk `write` kirjutab dirent failid iga vanema dirent kataloogi, rekursiivselt; siis kirjutab faili
361
+ * `write` käsud nõuavad O(N) kirjutamist, kusjuures N = sügavus kataloogihierarhias
362
+ * Käsk `remove` eemalda" eemaldab rekursiivselt vastava dirent-faili ja selle vanema, kui see on tühi; seejärel eemaldab faili
363
+ * `remove` O(N) lugemist ja potentsiaalselt sama palju kustutamisi, kusjuures N = sügavus kataloogihierarhias
364
+ * Rekursiivsed `remove` suurtes ja sügavates failisüsteemides võivad olla kulukad
365
+
366
+ Pange tähele, et isegi kui kliendipoolne krüptimine on lubatud, on vastane, kellel on täielik nähtavus teie krüptitud serveri poolel
367
+ salvestusruum, isegi ilma võtmeta, näeb siiski kataloogide koguarvu ja seda, kui palju faile igas ja koos on
368
+ mõningaid jõupingutusi, avastage osa või kogu kataloogihierarhia üldine struktuur.
369
+ *Märkus. Parema turvalisuse tagamiseks kasutage suhteliselt tasast konstruktsiooni.*
370
+ Vastane ei tea kataloogide/failide nimesid, kui ta ei tea ka sinu krüptimist
371
+ võti või oli krüpteering muul viisil edukalt lahti murdnud. Kõik ennustused on siis välja lülitatud!
372
+
373
+ ### Jõudlus ja vahemälu
374
+ Krüpteeritud salvestusruumi toimingud võivad olla aeglased. Rekursiivsed loendid ja eemaldamised võivad olla väga aeglased.
375
+ Vahemällu salvestamine redise kaudu aitab tohutult, kuid pange tähele, et vahemälu tühjeneb iga kirjutamise või eemaldamise korral.
376
+
377
+ ## Võtme pöörlemine
378
+ Looge oma uue võtmega mobiiltelefon, seejärel peegeldage sellesse vanu andmeid:
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
+ ## Draiveri liides
391
+ Draiver on mis tahes JS-fail, mis ekspordib funktsiooni „storageClient” järgmise allkirjaga:
392
+
393
+ function storageClient (key, secret, opts)
394
+
395
+ * `key` : string, teie API võti ( `local` draiveri jaoks on see baaskataloog)
396
+ * `secret` : string, teie API saladus (saab `local` draiveri puhul ära jätta)
397
+ * `opts` : objekt, atribuudid on juhipõhised:
398
+ * `local` ” puhul määravad atribuudid `fileMode` ja `dirMode` , kuidas luuakse uusi loovaid faile ja katalooge
399
+ * `s3` `bucket` on atribuut „bucket” nõutav. Valikulised omadused on järgmised:
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
+ Objekt, mille funktsioon storageClient tagastab, peab määratlema järgmised funktsioonid:
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
+ ## Logimine
431
+ Mobiletto kasutab [winstoni](https://www.npmjs.com/package/winston) logimise teeki.
432
+
433
+ Logid **sisaldavad** failiteid ja veateateid, kuid **mitte kunagi** ei sisalda võtmeid, saladusi,
434
+ või muud ühenduse konfiguratsiooniteavet.
435
+
436
+ ### Logi tase
437
+ Logitaseme määramiseks kasutage keskkonnamuutujat `MOBILETTO_LOG_LEVEL` , kasutades ühte
438
+ `npm` tasemetest, mis on määratletud saidil [https://www.npmjs.com/package/winston#logging-levels](https://www.npmjs.com/package/winston#logging-levels)
439
+
440
+ `error` . Kõige sõnasõnalisem tase on `silly` , kuigi praegu on mobiletto
441
+ ei logi sisse `debug`
442
+
443
+ MOBILETTO_LOG_LEVEL=silly # maximum logs!
444
+
445
+ ### Logifail
446
+ Vaikimisi kirjutab logija konsooli. Logide faili saatmiseks määrake `MOBILETTO_LOG_FILE`
447
+ keskkonna muutuja. Faili logides logisid enam konsooli ei kirjutata.
448
+
449
+ MOBILETTO_LOG_FILE=/var/my_mobiletto_log
450
+
451
+ Logimise väljalülitamiseks toimige järgmiselt.
452
+
453
+ MOBILETTO_LOG_FILE=/dev/null
454
+
455
+ </pre>