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 është një shtresë abstraksioni i ruajtjes së JavaScript, me enkriptim transparent opsional nga ana e klientit.
5
+
6
+ # Përmbajtje
7
+ * [Pse Mobiletto?](#Pse-Mobiletto?)
8
+ * [Fillimi i shpejtë](#Fillimi i shpejtë)
9
+ * [Mobiletto CLI](#mobiletto-cli)
10
+ * [Burimi](#Burimi)
11
+ * [Përdorimi bazë](#Basic-usage)
12
+ * [Metadata](#Metadata)
13
+ * [Stil alternativ importi](#Alternate-import-style)
14
+ * [Caching](#Caching)
15
+ * [Pasqyrim](#Pasqyrim)
16
+ * [Kriptimi transparent](#Transparent-encryption)
17
+ * [Rrotullimi i çelësit](#Rrotullimi i çelësit)
18
+ * [Ndërfaqja e shoferit](#Driver-interface)
19
+ * [Logging](#Logging)
20
+
21
+ # Lexojeni këtë në një gjuhë tjetër
22
+ Ky dokument README.md është përkthyer, nëpërmjet [hokeylization](https://github.com/cobbzilla/hokeylization), në
23
+ **[çdo gjuhë e mbështetur nga Google Translate](https://cloud.google.com/translate/docs/languages)!**
24
+
25
+ Jam i sigurt se nuk është perfekt, por shpresoj të jetë më mirë se asgjë!
26
+
27
+ [🇸🇦 Arabisht](../ar/README.md)
28
+ [🇧🇩 Bengalisht](../bn/README.md)
29
+ [🇩🇪 gjermanisht](../de/README.md)
30
+ [🇺🇸 Anglisht](../en/README.md)
31
+ [🇪🇸 spanjisht](../es/README.md)
32
+ [🇫🇷 Frengjisht](../fr/README.md)
33
+ [🇹🇩 Hausa](../ha/README.md)
34
+ [🇮🇳 Hindi](../hi/README.md)
35
+ [🇮🇩 Indonezisht](../id/README.md)
36
+ [🇮🇹 Italisht](../it/README.md)
37
+ [🇯🇵 Japonisht](../ja/README.md)
38
+ [🇰🇷 Koreane](../ko/README.md)
39
+ [🇮🇳 Maranthi](../mr/README.md)
40
+ [🇵🇱 Polonisht](../pl/README.md)
41
+ [🇧🇷 Portugeze](../pt/README.md)
42
+ [🇷🇺 Rusisht](../ru/README.md)
43
+ [🇰🇪 Suahili](../sw/README.md)
44
+ [🇵🇭 Tagalog](../tl/README.md)
45
+ [🇹🇷 Turqisht](../tr/README.md)
46
+ [🇵🇰 Urdu](../ur/README.md)
47
+ [🇻🇳 Vietnamisht](../vi/README.md)
48
+ [🇨🇳 Kinezisht](../zh/README.md)
49
+
50
+
51
+ **[📚 ... Të gjitha gjuhët ...](../README.md)**
52
+ ----
53
+
54
+ ### A ka ndonjë problem me këtë përkthim të README?
55
+ Ky përkthim i veçantë i origjinalit [README](https://github.com/cobbzilla/mobiletto/blob/master/README.md)
56
+ mund të jetë me të meta -- *korrigjimet janë shumë të mirëseardhura!* Ju lutemi dërgoni një [kërkesë për tërheqje në GitHub](https://github.com/cobbzilla/mobiletto/pulls),
57
+ ose nëse nuk jeni të kënaqur ta bëni këtë, [hapni një çështje](https://github.com/cobbzilla/mobiletto/issues)
58
+
59
+ Kur krijoni një problem të ri të GitHub në lidhje me një përkthim, ju lutemi bëni:
60
+ * përfshini URL-në e faqes (kopjoni/ngjisni nga shiriti i adresave të shfletuesit)
61
+ * përfshini tekstin e saktë që është i gabuar (kopjoni/ngjisni nga shfletuesi)
62
+ * ju lutemi përshkruani se çfarë nuk shkon -- a është përkthimi i gabuar? a është thyer disi formatimi?
63
+ * me mirësi ofroni një sugjerim për një përkthim më të mirë, ose se si teksti duhet të formatohet siç duhet
64
+ * **Faleminderit!**
65
+
66
+ ## Pse Mobiletto?
67
+
68
+ ### Mirupafshim mbyllje e shitësit!
69
+ Ofruesit e ndryshëm të ruajtjes së cloud kanë API të papajtueshme. Edhe ata që përpiqen për "përputhshmërinë S3"
70
+ kanë sjellje idiosinkratike.
71
+
72
+ Kur zgjidhni një shitës të veçantë ruajtjeje për aplikacionin tuaj, nëse kodoni drejtpërdrejt në API-në e tyre, aplikacionin tuaj
73
+ tani është i varur nga ai shërbim. Me kalimin e kohës dhe grumbullimin e kodit, ndryshimi i shitësve bëhet
74
+ gjithnjë e më e paqëndrueshme. Mirë se vini në botën argëtuese të mbylljes së shitësve!
75
+
76
+ Mobiletto u krijua për të zgjidhur këtë problem. Duke koduar aplikacionin tuaj në API-në e mobiletto, ju mund të lehtë
77
+ ndryshoni ofruesit e ruajtjes dhe dijeni se shtresa e ruajtjes së aplikacionit tuaj do të sillet në mënyrë identike.
78
+
79
+ ### Testim i gjerë
80
+ Të gjithë drejtuesit testohen për sjellje identike me mbi 60 teste për çdo shofer.
81
+ Ne testojmë të gjithë drejtuesit me çdo kombinim të:
82
+ * Kriptimi: i aktivizuar dhe i çaktivizuar
83
+ * Redis cache: si i aktivizuar ashtu edhe i çaktivizuar
84
+
85
+ Kjo qasje na jep paqe mendore se mobiletto do të sillet njësoj pavarësisht nga shoferi që përdorni,
86
+ dhe pavarësisht nëse aktivizoni memorien dhe/ose enkriptimin.
87
+
88
+ ### Mbështetje e shoferit
89
+ Drejtuesit aktualë të ruajtjes Mobiletto:
90
+ * `s3` : Amazon S3
91
+ * `b2` : Backblaze B2
92
+ * `local` : sistemi i skedarëve lokal
93
+
94
+ *Kontributet për të mbështetur më shumë ofrues të ruajtjes së cloud janë shumë të mirëseardhura!*
95
+
96
+ ## celulartto-cli
97
+ Mobiletto synohet të përdoret si bibliotekë nga kode të tjera JavaScript.
98
+
99
+ Për të punuar me mobiletto në linjën e komandës, përdorni [mobiletto-cli](https://www.npmjs.com/package/mobiletto-cli)
100
+
101
+ ## Burimi
102
+ * [mobiletto në GitHub](https://github.com/cobbzilla/mobiletto)
103
+ * [mobiletto në npm](https://www.npmjs.com/package/mobiletto)
104
+
105
+ ## Fillim i shpejte
106
+ Një shembull i shkurtër duke përdorur drejtuesin e mobiletto `s3` .
107
+
108
+ Ky kod do të funksiononte njësoj nëse drejtuesi do të ishte `b2` " ose `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ërdorimi bazë
139
+ Një shembull shumë më i gjerë, që tregon shumicën e veçorive të ofruara:
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
+ ## Të dhënat meta
241
+ Komanda `metadata` kthen meta të dhënat për një hyrje të vetme të sistemit të skedarëve.
242
+ Po kështu, vlera e kthyer nga komanda `list` është një grup objektesh meta të dhënash.
243
+
244
+ Një objekt i meta të dhënave duket kështu:
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` mund të jetë `file` `dir` , 'dir', `link` , ose `special` .
255
+
256
+ Në varësi të llojit të drejtuesit, një komandë `list` mund të mos kthejë të gjitha fushat. `name` " dhe `type`
257
+ duhet të jetë gjithmonë i pranishëm. Një komandë e mëpasshme `metadata` do të kthejë të gjitha vetitë e disponueshme.
258
+
259
+ ## Stili i importit alternativ
260
+ Importoni modulin me shtrirje të plotë dhe përdorni funksionin `connect` :
261
+
262
+ const storage = require('mobiletto')
263
+ const opts = {bucket: 'bk', region: 'us-east-1'}
264
+ const s3 = await storage.connect('s3', aws_key, aws_secret, opts)
265
+ const objectData = await s3.readFile('some/path')
266
+
267
+ ## Caching
268
+ Mobiletto funksionon më mirë me një cache <a href="https://redis.io">redis</a> .
269
+
270
+ Mobiletto do të përpiqet të lidhet me një shembull redis në 127.0.0.1:6379
271
+
272
+ Ju mund të anashkaloni njërën nga këto:
273
+ * Vendosni `MOBILETTO_REDIS_HOST` env var, celular për t'u lidhur këtu në vend të hostit lokal
274
+ * Vendosni `MOBILETTO_REDIS_PORT` env var, kjo portë do të përdoret
275
+
276
+ Mobiletto do të ruajë të gjithë çelësat e tij redis me prefiksin `_mobiletto__` . Ju mund ta ndryshoni këtë
277
+ duke vendosur `MOBILETTO_REDIS_PREFIX` .
278
+
279
+ Ju gjithashtu mund të caktoni caching për lidhje me objektin `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
+ ### Nuk dëshironi redis caching?
291
+ Për të çaktivizuar: kaloni `enabled: false` " në objektin tuaj `opts.redisConfig` kur krijoni lidhjen tuaj.
292
+
293
+ Siç diskutohet më poshtë, çaktivizimi i memorjes në memorie do të ketë një efekt negativ në performancën dhe do të shkaktojë më shumë kërkesa
294
+ në ruajtje që ju duhet vërtet.
295
+
296
+ ### Udhëzime për ruajtjen e memories
297
+ **Magazinimi i koduar**: leximi/shkrimi i ruajtjes së koduar është vetëm pak më i ngadalshëm se normalja,
298
+ por lundrimi nëpër drejtori (që disa gjëra e bëjnë) është mjaft i shtrenjtë. Përdorimi i një cache redis
299
+ do t'ju japë një rritje të konsiderueshme të performancës.
300
+
301
+ Memoria e paracaktuar është e sigurt, por nuk funksionon mirë nëse keni shumë operacione shkrimi/fshirjeje.
302
+ Çdo operacion shkrimi ose heqjeje e zhvlerëson të gjithë memorien e fshehtë, duke siguruar që leximet e mëvonshme do ta shohin atë
303
+ ndryshimet e fundit.
304
+
305
+ ### Mjetet CLI
306
+ Nëse jeni duke përdorur një mjet CLI si [mobiletto-cli](https://www.npmjs.com/package/mobiletto-cli),
307
+ patjetër që do të dëshironi që cache-i redis të aktivizohet, pasi zgjat gjatë thirrjeve të komandës `mo` .
308
+
309
+ ## Pasqyrim
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` kryen një kopje një herë të të gjithë skedarëve nga një celular në tjetrin.
318
+ Nuk kryen asnjë proces për të ruajtur pasqyrën me kalimin e kohës. Ekzekutoni përsëri komandën `mirror`
319
+ për të sinkronizuar çdo skedar që mungon.
320
+
321
+ Vlera e kthyer nga `mirror` është një objekt i thjeshtë me numërues për numrin e skedarëve të suksesshëm
322
+ pasqyruar dhe sa skedarë kishin gabime:
323
+
324
+ {
325
+ success: count-of-files-mirrored,
326
+ errors: count-of-files-with-errors
327
+ }
328
+
329
+ PARALAJMËRIM: Pasqyrimi i grupeve të mëdha të të dhënave mund të marrë shumë kohë dhe me gjerësi brezi
330
+
331
+ Me semantikën e quajtur `mirror` , ndonjëherë mund të jetë konfuze të kuptosh se kush është
332
+ lexuesi dhe kush është shkrimtari. Imagjinoni si një deklaratë detyre: "mobili i dorës së majtë"
333
+ është gjëja që i është caktuar (të dhënat e pasqyruara janë shkruar), dhe "celulari i dorës së djathtë" (i
334
+ argumenti i metodës `mirror` ) është vlera që caktohet (lexohen të dhënat e pasqyruara).
335
+
336
+ ## Kriptim transparent
337
+ Aktivizo kriptim transparent nga ana e klientit:
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
+ Cfare po ndodh? Një direktori e veçantë "hyrje në direktori" (dirent) (i koduar) gjurmon se cilat skedarë janë në të
357
+ drejtoria (aka direktoria dirent).
358
+ * `list` lexon skedarët e hyrjes në drejtori, deshifron çdo shteg të listuar; pastaj kthen meta të dhënat për çdo skedar
359
+ * `list` janë më joefikase, veçanërisht për drejtoritë me një numër të madh skedarësh
360
+ * `write` shkruan skedarë dirent në drejtorinë dirent të secilit prind, në mënyrë rekursive; pastaj shkruan skedarin
361
+ * `write` do të shkaktojnë shkrime O(N), me N = thellësi në hierarkinë e drejtorisë
362
+ * `remove` heq skedarin dirent përkatës dhe prindin e tij nëse është bosh, në mënyrë rekursive; pastaj heq skedarin
363
+ * Komandat jo-rekurzive të `remove` do të shkaktojnë lexime O(N) dhe potencialisht po aq fshirje, me N = thellësi në hierarkinë e drejtorisë
364
+ * Komandat rekursive `remove` në sisteme skedarësh të mëdhenj dhe të thellë mund të jenë të shtrenjta
365
+
366
+ Vini re se edhe me enkriptimin nga ana e klientit të aktivizuar, një kundërshtar me shikueshmëri të plotë në anën tuaj të koduar nga serveri
367
+ ruajtja, edhe pa çelësin, mund të shohë përsëri numrin e përgjithshëm të drejtorive dhe sa skedarë janë në secilën prej tyre dhe me
368
+ disa përpjekje, zbuloni disa ose të gjithë strukturën e përgjithshme të hierarkisë së drejtorive.
369
+ *Shënim: Përdorni një strukturë relativisht të sheshtë për siguri më të mirë.*
370
+ Kundërshtari nuk do t'i dinte emrat e drejtorive/skedarëve nëse nuk dinte gjithashtu enkriptimin tuaj
371
+ kyç ose kishte thyer me sukses kriprimin. Të gjitha bastet janë jashtë atëherë!
372
+
373
+ ### Performanca dhe caching
374
+ Operacionet në ruajtjen e koduar mund të jenë të ngadalta. Listimet dhe heqjet rekursive mund të jenë shumë të ngadalta.
375
+ Memoria e memories nëpërmjet redis ndihmon jashtëzakonisht shumë, por kini parasysh se memoria e fshehtë shpërndahet pas çdo shkrimi ose heqjeje.
376
+
377
+ ## Rrotullimi i tastit
378
+ Krijoni një celular me çelësin tuaj të ri, më pas pasqyroni të dhënat e vjetra në të:
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
+ ## Ndërfaqja e shoferit
391
+ Një drejtues është çdo skedar JS që eksporton një funksion 'storageClient' me këtë nënshkrim:
392
+
393
+ function storageClient (key, secret, opts)
394
+
395
+ * `key` : një varg, çelësi juaj API (për drejtuesin `local` ky është drejtoria bazë)
396
+ * `secret` : një varg, sekreti juaj i API-së (mund të hiqet për drejtuesin `local` )
397
+ * `opts` : një objekt, vetitë janë për drejtues:
398
+ * Për `local` , `fileMode` " dhe `dirMode` përcaktojnë se si krijohen skedarë dhe drejtori të reja të krijimit
399
+ * Për `s3` , kërkohet `bucket` . Karakteristikat opsionale janë:
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
+ Objekti që kthen funksioni storageClient duhet të përcaktojë këto funksione:
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
+ ## Regjistrimi
431
+ Mobiletto përdor bibliotekën e regjistrimit [winston](https://www.npmjs.com/package/winston).
432
+
433
+ Regjistrat **do** të përmbajnë shtigje skedarësh dhe mesazhe gabimi, por **nuk** do të përmbajnë çelësa, sekrete,
434
+ ose ndonjë informacion tjetër për konfigurimin e lidhjes.
435
+
436
+ ### Niveli i regjistrit
437
+ Përdorni variablin e mjedisit `MOBILETTO_LOG_LEVEL` për të vendosur nivelin e regjistrit, duke përdorur një
438
+ e niveleve `npm` të përcaktuara në [https://www.npmjs.com/package/winston#logging-levels](https://www.npmjs.com/package/winston#logging-levels)
439
+
440
+ Niveli i parazgjedhur është `error` . Niveli më i folur është `silly` , megjithëse aktualisht është i lëvizshëm
441
+ nuk regjistrohet në nivele nën `debug`
442
+
443
+ MOBILETTO_LOG_LEVEL=silly # maximum logs!
444
+
445
+ ### Skedari i regjistrit
446
+ Si parazgjedhje, regjistruesi shkruan në tastierë. Për të dërguar regjistrat në një skedar, caktoni `MOBILETTO_LOG_FILE`
447
+ variabli i mjedisit. Kur regjistroheni në një skedar, regjistrat nuk do të shkruhen më në tastierë.
448
+
449
+ MOBILETTO_LOG_FILE=/var/my_mobiletto_log
450
+
451
+ Për të çaktivizuar regjistrimin:
452
+
453
+ MOBILETTO_LOG_FILE=/dev/null
454
+
455
+ </pre>