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 ndi gawo la JavaScript losungirako, lomwe lili ndi kubisa kwapambali kwa kasitomala.
5
+
6
+ # Zamkatimu
7
+ * [Chifukwa Chiyani Mobiletto?](#Why-Mobiletto?)
8
+ * [Kuyambira mwachangu](#Kuyambira mwachangu)
9
+ * [Mobiletto CLI](#mobiletto-cli)
10
+ * [Gwero](#Source)
11
+ * [Kagwiritsidwe ntchito kake](#Kagwiritsidwe koyambira)
12
+ * [Metadata](#Metadata)
13
+ * [Mtundu wina wolowetsa](#Mtundu wina wolowetsa)
14
+ * [Kusunga](#Caching)
15
+ * [Mirroring](#Mirroring)
16
+ * [Transparent encryption](# Transparent-encryption)
17
+ * [Kutembenuza kiyi](#Kutembenuza-makiyi)
18
+ * [Mawonekedwe a Dalaivala](#Mawonekedwe Oyendetsa)
19
+ * [Kudula mitengo](#Logging)
20
+
21
+ # Werengani izi muchilankhulo china
22
+ Chikalata cha README.md chamasuliridwa, kudzera pa [hokeylization](https://github.com/cobbzilla/hokeylization), ku
23
+ **[chinenero chilichonse chimathandizidwa ndi Zomasulira za Google](https://cloud.google.com/translate/docs/languages)!**
24
+
25
+ Ndikutsimikiza kuti sizabwino, koma ndikukhulupirira kuti nzabwino kuposa chilichonse!
26
+
27
+ [🇸🇦 Chiarabu](../ar/README.md)
28
+ [🇧🇩 Bengali](../bn/README.md)
29
+ [🇩🇪 Chijeremani](../de/README.md)
30
+ [🇺🇸 Chingerezi](../en/README.md)
31
+ [🇪🇸 Chisipanishi](../es/README.md)
32
+ [🇫🇷 Chifulenchi](../fr/README.md)
33
+ [🇹🇩 Hausa](../ha/README.md)
34
+ [🇮🇳 Chihindi](../hi/README.md)
35
+ [🇮🇩 Chiindoneziya](../id/README.md)
36
+ [🇮🇹 Chiitaliya](../it/README.md)
37
+ [🇯🇵 Japanese](../ja/README.md)
38
+ [🇰🇷 Chikorea](../ko/README.md)
39
+ [🇮🇳 Maranthi](../mr/README.md)
40
+ [🇵🇱 Chipolishi](../pl/README.md)
41
+ [🇧🇷 Chipwitikizi](../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
+ [🇻🇳 Vietnamese](../vi/README.md)
48
+ [🇨🇳 Chinese](../zh/README.md)
49
+
50
+
51
+ **[📚 ... Zinenero Zonse ...](../README.md)**
52
+ ----
53
+
54
+ ### Kodi pali vuto ndi kumasulira kumeneku kwa README?
55
+ Kumasulira kwenikweniku [README](https://github.com/cobbzilla/mobiletto/blob/master/README.md)
56
+ zitha kukhala zolakwika -- *zokonza ndizolandilidwa kwambiri!* Chonde tumizani [kukoka pempho pa GitHub](https://github.com/cobbzilla/mobiletto/pulls),
57
+ kapena ngati simumasuka kuchita zimenezo, [tsegulani nkhani](https://github.com/cobbzilla/mobiletto/issues)
58
+
59
+ Mukapanga nkhani yatsopano ya GitHub yokhudza kumasulira, chonde chitani:
60
+ * Phatikizani ulalo watsamba (koperani / kumata kuchokera pa adilesi ya msakatuli)
61
+ * Phatikizani zomwe zili zolakwika (koperani/mata kuchokera pa msakatuli)
62
+ * chonde fotokozani chomwe chalakwika -- kodi kumasulira kwake ndikolakwika? Kodi masanjidwewo awonongeka mwanjira ina?
63
+ * perekani mokoma mtima lingaliro la kumasulira kwabwinoko, kapena mmene malembawo ayenera kusanjidwira bwino
64
+ * **Zikomo!**
65
+
66
+ ## Chifukwa Mobiletto?
67
+
68
+ ### Tatsala pang'ono kutseka mavenda!
69
+ Othandizira osiyanasiyana osungira mitambo ali ndi ma API osagwirizana. Ngakhale omwe amayesetsa "kufanana kwa S3"
70
+ kukhala ndi makhalidwe osadziwika bwino.
71
+
72
+ Mukasankha wogulitsa wina wosungira pulogalamu yanu, ngati mumalembera mwachindunji ku API yawo, pulogalamu yanu
73
+ tsopano amadalira utumiki umenewo. Pamene nthawi ikupita ndipo code ikuwonjezeka, kusintha ogulitsa kumakhala
74
+ osavomerezeka. Takulandilani kudziko losangalatsa la mavenda lock-in!
75
+
76
+ Mobiletto idapangidwa kuti ithetse vutoli. Mwa kukopera pulogalamu yanu ku mobiletto's API, mungathe mosavuta
77
+ sinthani osungira ndikudziwa kuti malo osungira a pulogalamu yanu azichita chimodzimodzi.
78
+
79
+ ### Kuyesa kwakukulu
80
+ Madalaivala onse amayesedwa kuti akhale ndi machitidwe ofanana ndi mayeso 60+ pa driver aliyense.
81
+ Timayesa madalaivala onse ndi kuphatikiza kulikonse:
82
+ * Kubisa: zonse zimathandizidwa komanso zolephereka
83
+ * Redis cache: zonse zimayatsidwa komanso zolephereka
84
+
85
+ Njirayi imatipatsa mtendere wamumtima kuti mobiletto izichita chimodzimodzi mosasamala kanthu kuti mumagwiritsa ntchito dalaivala wotani,
86
+ ndipo mosasamala kanthu kuti mutsegula caching ndi/kapena kubisa.
87
+
88
+ ### Chithandizo cha oyendetsa
89
+ Madalaivala apano a Mobiletto:
90
+ * `s3` : Amazon S3
91
+ * `b2` : Backblaze B2
92
+ * `local` : file system yakomweko
93
+
94
+ *Zopereka zothandizira othandizira ambiri osungira mitambo ndizolandiridwa kwambiri!*
95
+
96
+ ## mobiletto-cli
97
+ Mobiletto idapangidwa kuti igwiritsidwe ntchito ngati laibulale ndi ma code ena a JavaScript.
98
+
99
+ Kuti mugwire ntchito ndi mobiletto pamzere wolamula, gwiritsani ntchito [mobiletto-cli](https://www.npmjs.com/package/mobiletto-cli)
100
+
101
+ ## Gwero
102
+ * [mobiletto pa GitHub](https://github.com/cobbzilla/mobiletto)
103
+ * [mobiletto pa npm](https://www.npmjs.com/package/mobiletto)
104
+
105
+ ## Yambani Mwachangu
106
+ Chitsanzo chachidule chogwiritsa ntchito mobiletto `s3` driver.
107
+
108
+ Khodi iyi ingayende chimodzimodzi ngati dalaivala anali `b2` kapena `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
+ ## Kugwiritsa ntchito Basic
139
+ Chitsanzo chowonjezereka, chosonyeza zambiri zomwe zimaperekedwa:
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
+ Lamulo la `metadata` limabweretsanso metadata yokhudza kulowa kwa fayilo imodzi.
242
+ Momwemonso, mtengo wobwerera kuchokera ku lamulo la `list` ndi mndandanda wazinthu za metadata.
243
+
244
+ Chinthu cha metadata chikuwoneka motere:
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
+ Katundu wa `type` ukhoza kukhala `file` , `dir` , `link` , kapena `special` .
255
+
256
+ Kutengera mtundu wa dalaivala, lamulo la `list` onse. The `name` ndi `type` katundu
257
+ ayenera kukhalapo nthawi zonse. Lamulo lotsatira la `metadata` lidzabwezera zonse zomwe zilipo.
258
+
259
+ ## Njira ina yolowera
260
+ Lowetsani gawo lokhala ndi mawonekedwe onse ndikugwiritsa ntchito `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
+ ##Kusunga
268
+ Mobiletto imagwira ntchito bwino ndi <a href="https://redis.io">redis</a> cache.
269
+
270
+ Mobiletto ayesa kulumikizana ndi chitsanzo cha redis pa 127.0.0.1:6379
271
+
272
+ Mutha kuchotsera chimodzi mwa izi:
273
+ * Khazikitsani env var ya `MOBILETTO_REDIS_HOST` , lumikizani pano m'malo mwa localhost
274
+ * Khazikitsani env var ya `MOBILETTO_REDIS_PORT` , dokoli lidzagwiritsidwa ntchito
275
+
276
+ Mobiletto idzasunga makiyi ake onse a redis ndi mawu oyamba `_mobiletto__` . Mutha kusintha izi
277
+ pokhazikitsa `MOBILETTO_REDIS_PREFIX` env var.
278
+
279
+ Mukhozanso kukhazikitsa posungira polumikizana ndi chinthu cha `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
+ ### Simukufuna redis caching?
291
+ Kuti muyimitse: dutsani `othandizira `enabled: false` mu chinthu chanu cha `opts.redisConfig` kulumikizana kwanu.
292
+
293
+ Monga tafotokozera m'munsimu, kuletsa caching kumakhala ndi zotsatira zoyipa pakuchita bwino komanso kumabweretsa zopempha zambiri
294
+ posungira zomwe mukufunikiradi.
295
+
296
+ ### Chitsogozo cha caching
297
+ **Kusungirako mwachinsinsi**: kuwerenga/kulemba kusungitsa kosungika kumachedwa pang'ono kusiyana ndi nthawi zonse,
298
+ koma kuyendayenda mozungulira (zomwe zinthu zina zimachita) ndizokwera mtengo. Kugwiritsa ntchito redis cache
299
+ zidzakupatsani chiwongola dzanja chachikulu.
300
+
301
+ Chosungira chosasinthika ndi chotetezeka, koma sichikuyenda bwino ngati muli ndi zambiri zolembera / kuchotsa.
302
+ Kulemba kapena kuchotsa ntchito kulikonse kumalepheretsa cache yonse, kuwonetsetsa kuti zowerenga zotsatila ziziwona
303
+ zosintha zaposachedwa.
304
+
305
+ ### CLI zida
306
+ Ngati mukugwiritsa ntchito chida cha CLI ngati [mobiletto-cli](https://www.npmjs.com/package/mobiletto-cli),
307
+ mudzafuna kuti cache ya redis iyambike, chifukwa imapitilira kuyitanitsa kwa lamulo la `mo` .
308
+
309
+ ##Kuwonetsa
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
+ Lamulo la `mirror` limapanga kukopera kamodzi kwamafayilo onse kuchokera pa mobiletto kupita kwina.
318
+ Sichiyendetsa njira iliyonse yosungira galasi pakapita nthawi. Thamangani lamulo la `mirror` kachiwiri
319
+ kulunzanitsa mafayilo aliwonse omwe akusowa.
320
+
321
+ Mtengo wobwerera kuchokera ku `mirror` ndi chinthu chosavuta chokhala ndi zowerengera za kuchuluka kwa mafayilo omwe adachita bwino
322
+ mirrored ndi kuchuluka kwa mafayilo omwe anali ndi zolakwika:
323
+
324
+ {
325
+ success: count-of-files-mirrored,
326
+ errors: count-of-files-with-errors
327
+ }
328
+
329
+ CHENJEZO: Kuyang'anira ma data akuluakulu kumatha kutenga nthawi komanso bandwidth
330
+
331
+ Ndi ma semantics oyimba a `mirror` nthawi zina zimakhala zosokoneza kumvetsetsa kuti ndani
332
+ wowerenga ndi amene analemba. Ingoganizirani ngati mawu a ntchito: "mobiletto yamanzere"
333
+ ndi chinthu chomwe chikuperekedwa (zojambula zojambulidwa), ndi "mobiletto yamanja" (the
334
+ Mtsutso wa njira ya `mirror` ) ndi mtengo womwe ukuperekedwa (zowerengera zawerengedwa).
335
+
336
+ ## Transparent encryption
337
+ Yambitsani kubisa kwapambali kwa kasitomala:
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
+ Chikuchitikandi chiyani? Chikwatu chosiyana cha "directory entry" (dirent) (chobisika) chimatsata mafayilo omwe ali mmenemo
357
+ directory (aka dirent directory).
358
+ * Lamulo la `list` limawerenga mafayilo olowera, kutsitsa njira iliyonse yomwe yatchulidwa; kenako amabwezeretsa metadata pa fayilo iliyonse
359
+ * Malamulo a `list` , makamaka pamakanema okhala ndi mafayilo ambiri
360
+ * Lamulo la `write` limalemba mafayilo achinsinsi mu bukhu la kholo lililonse, mobwerezabwereza; kenako amalemba fayilo
361
+ * Malamulo `write` kuti O (N) alembe, ndi N = kuya muzowongolera
362
+ * Lamulo la `remove` limachotsa fayilo yofananira, ndipo kholo lake ngati ilibe kanthu, mobwerezabwereza; kenako amachotsa fayilo
363
+ * Malamulo osabwereza a `remove` kuti O(N) awerengedwe ndikuchotsa zambiri, ndi N = kuya muzowongolera
364
+ * Malamulo `remove` akulu ndi akuya amatha kukhala okwera mtengo
365
+
366
+ Zindikirani kuti ngakhale kubisa kwamakasitomala kumayatsidwa, mdani yemwe amawoneka bwino pa seva yanu yosungidwa
367
+ yosungirako, ngakhale popanda kiyi, amatha kuwona kuchuluka kwa maupangiri ndi kuchuluka kwa mafayilo omwe ali mumtundu uliwonse, komanso ndi
368
+ kuyesetsa pang'ono, pezani zina kapena zonse zadongosolo lachikwatu.
369
+ *Zindikirani: Gwiritsani ntchito mawonekedwe athyathyathya kuti mutetezeke bwino.
370
+ Mdaniyo sangadziwe mayina a zolemba / mafayilo pokhapokha atadziwanso kubisa kwanu
371
+ key kapena adasokoneza bwino kubisa. Mabetcha onse atha ndiye!
372
+
373
+ ### Magwiridwe ndi caching
374
+ Ntchito zosungirako zosungidwa zitha kuchedwa. Zolemba zobwerezabwereza ndi zochotsa zimatha kuchedwa kwambiri.
375
+ Kusungirako kudzera pa redis kumathandiza kwambiri, koma dziwani kuti chosungiracho chimasinthidwa pazolemba zilizonse kapena kuchotsa.
376
+
377
+ ## Kusintha kofunikira
378
+ Pangani mobiletto ndi kiyi yanu yatsopano, kenako ndikuwonetsa zomwe zilimo kale:
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
+ ## Mawonekedwe oyendetsa
391
+ Dalaivala ndi fayilo iliyonse ya JS yomwe imatumiza ntchito ya 'storageClient' ndi siginecha iyi:
392
+
393
+ function storageClient (key, secret, opts)
394
+
395
+ * `key` : chingwe, kiyi yanu ya API (kwa oyendetsa `local` iyi ndiye chikwatu choyambira)
396
+ * `secret` : chingwe, chinsinsi cha API (chikhoza kusiyidwa kwa woyendetsa `local` )
397
+ * `opts` : chinthu, katundu ndi woyendetsa:
398
+ * Kwa `local` , katundu wa `fileMode` ndi `dirMode` amatsimikizira momwe mafayilo atsopano ndi zolemba zimapangidwira
399
+ * Kwa `s3` , katundu wa `bucket` amafunikira. Zosankha zomwe mungasankhe ndi:
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
+ Chinthu chomwe ntchito yosungiraClient imabwerera iyenera kutanthauzira izi:
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
+ ##Kudula mitengo
431
+ Mobiletto amagwiritsa ntchito laibulale yodula mitengo ya [winston](https://www.npmjs.com/package/winston).
432
+
433
+ Logs ** idzakhala ** idzakhala ndi njira zamafayilo ndi mauthenga olakwika, koma ** sichidzakhala ** ndi makiyi, zinsinsi,
434
+ kapena chidziwitso china chilichonse cholumikizira.
435
+
436
+ ### Log level
437
+ Gwiritsani ntchito `MOBILETTO_LOG_LEVEL` kusintha kwa chilengedwe kuti muyike mulingo wa chipika, pogwiritsa ntchito imodzi
438
+ za milingo ya `npm` yofotokozedwa mu [https://www.npmjs.com/package/winston#logging-levels](https://www.npmjs.com/package/winston#logging-levels)
439
+
440
+ Mulingo wokhazikika ndi `error` . Mulingo wa verbose kwambiri ndi `silly` , ngakhale pakali pano mobiletto
441
+ sichilowa m'munsimu `debug`
442
+
443
+ MOBILETTO_LOG_LEVEL=silly # maximum logs!
444
+
445
+ ### Fayilo yaulere
446
+ Mwachikhazikitso, wodula mitengoyo amalembera ku console. Kuti mutumize zolemba ku fayilo, ikani `MOBILETTO_LOG_FILE`
447
+ kusintha kwa chilengedwe. Mukalowa mufayilo, zipika sizidzalembedwanso ku console.
448
+
449
+ MOBILETTO_LOG_FILE=/var/my_mobiletto_log
450
+
451
+ Kuti muzimitsa kudula mitengo:
452
+
453
+ MOBILETTO_LOG_FILE=/dev/null
454
+
455
+ </pre>