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 waa lakabka kaydinta kaydinta JavaScript, oo leh sir dhinaca macmiilka ah oo ikhtiyaari ah.
5
+
6
+ # Nuxurka
7
+ * [Sababta Mobiletto?](#Sababta Mobiletto?)
8
+ * [Bilow degdeg ah](#Si degdeg ah u bilow)
9
+ * [Mobiletto CLI](#mobiletto-cli)
10
+ * [Isha](#Isha)
11
+ * [Isticmaalka aasaasiga ah](#Isticmaalka aasaasiga ah)
12
+ * [Metadata](#Metadata)
13
+ * [Qaabka soo dejinta beddelka](#Habka-soo dejinta-ka beddelka)
14
+ * [Caching](#Caching)
15
+ * [Mirroring](#Mirroring)
16
+ * [Si daah-furnaan]
17
+ * [wareejinta furaha](#furaha-wareejin)
18
+ * [Driver interface](#Driver-interface)
19
+ * [Giritaanka](#Logging)
20
+
21
+ # Ku akhri luqad kale
22
+ Dukumeentigan README.md waxa lagu turjumay, iyada oo loo marayo [hokeylization](https://github.com/cobbzilla/hokeylization), galay
23
+ **[Luqadda kasta oo ay taageerto Google Translate](https://cloud.google.com/translate/docs/languages)!**
24
+
25
+ Waan hubaa inaysan qummanayn, laakiin waxaan rajeynayaa inay ka fiican tahay waxba!
26
+
27
+ [🇸🇦 Carabi](../ar/README.md)
28
+ [🇧🇩 Bengali](../bn/README.md)
29
+ [🇩🇪 Jarmal](../de/README.md)
30
+ [🇺🇸 Ingiriis](../en/README.md)
31
+ [🇪🇸 Isbaanish](../es/README.md)
32
+ [🇫🇷 Faransiis](../fr/README.md)
33
+ [🇹🇩 Hausa](../ha/README.md)
34
+ [🇮🇳 Hindi](../hi/README.md)
35
+ [🇮🇩 Indonesian](../id/README.md)
36
+ [🇮🇹 Talyaani](../it/README.md)
37
+ [🇯🇵 Jabbaan](../ja/README.md)
38
+ [🇰🇷 Kuuriyaan](../ko/README.md)
39
+ [🇮🇳 Maranthi](../mr/README.md)
40
+ [🇵🇱 Polish](../pl/README.md)
41
+ [🇧🇷 Boortaqiis](../pt/README.md)
42
+ [🇷🇺 Ruush](../ru/README.md)
43
+ [🇰🇪 Swahili](../sw/README.md)
44
+ [🇵🇭 Tagalog](../tl/README.md)
45
+ [🇹🇷 Turkish](../tr/README.md)
46
+ [🇵🇰 Urduu](../ur/README.md)
47
+ [🇻🇳 Vietnamese](../vi/README.md)
48
+ [🇨🇳 Shiine](../zh/README.md)
49
+
50
+
51
+ **[📚 ... Dhammaan Luqadaha ...](../README.md)**
52
+ ----
53
+
54
+ ### Dhib ma ka jirtaa tarjumaada README?
55
+ Turjumaaddan gaarka ah ee asalka ah [README](https://github.com/cobbzilla/mobiletto/blob/master/README.md)
56
+ waxaa laga yaabaa in ay cilladaysan tahay -- *sixitaanku aad ayaa loo soo dhawaynayaa!* Fadlan u soo dir [codsi jiid GitHub](https://github.com/cobbzilla/mobiletto/pulls),
57
+ ama haddii aadan ku qanacsanayn inaad taas samayso, [fur arrin](https://github.com/cobbzilla/mobiletto/issues)
58
+
59
+ Markaad abuurto arrin cusub oo GitHub ah oo ku saabsan tarjumaada, fadlan samee:
60
+ * ku dar URL bogga (koobi/ku dheji barta ciwaanka browserka)
61
+ * ku dar qoraalka saxda ah ee khaldan (koobi ka soo gal browserka)
62
+ * fadlan sharax waxa khaldan -- turjumaada ma khaldan tahay? qaabaynta si uun ma u jabtay?
63
+ * si naxariis leh u soo jeedi soo jeedin tarjumaad ka wanaagsan, ama sida qoraalka si habboon loo qaabeeyey
64
+ * **Mahadsanid!**
65
+
66
+ Waa maxay sababta Mobiletto?
67
+
68
+ ### Nabadgelyo-iibiyaha qufulka!
69
+ Bixiyeyaasha kaydinta daruuraha ee kala duwan waxay leeyihiin API-yo aan ku haboonayn Xitaa kuwa ku dadaalaya "waafaqid S3"
70
+ waxay leeyihiin dabeecado aan caadi ahayn.
71
+
72
+ Marka aad doorato iibiyaha kaydinta gaarka ah abkaaga, haddii aad si toos ah code ugu geliso API-ga, abkaaga
73
+ hadda waxay ku tiirsan tahay adeeggaas. Marka uu wakhtigu sii socdo oo koodhka is urursado, beddelka iibiyeyaasha ayaa noqda
74
+ sii kordheysa oo aan la sii wadi karin. Ku soo dhawoow aduunka xiisaha leh ee qufulka iibiyaha!
75
+
76
+ Mobiletto waxaa loo qorsheeyay in lagu xalliyo dhibaatadan. Markaad ku xidhid abkaaga mobiltto's API, si fudud ayaad u samayn kartaa
77
+ beddel bixiyeyaasha kaydinta oo ogow in lakabka kaydinta abkaagu u dhaqmi doono si isku mid ah.
78
+
79
+ ### Imtixaan baaxad leh
80
+ Dhammaan darawalada waxa lagu tijaabiyaa dabeecad isku mid ah iyada oo 60+ imtixaan laga qaaday darawal kasta.
81
+ Waxaan ku tijaabineynaa dhammaan darawalada isku darka kasta oo:
82
+ * Sireed: labadaba waa karti iyo naafo
83
+ * Redis cache: labadaba waa karti iyo naafo
84
+
85
+ Habkani waxa uu ina siinaya maskaxda maskaxda in mobiletto uu u dhaqmayo si la mid ah darawalka aad isticmaasho,
86
+ iyadoo aan loo eegin haddii aad karti u leedahay kaydinta iyo/ama sirta.
87
+
88
+ ### Taageerada darawalka
89
+ Wadayaasha kaydinta Mobiletto hadda:
90
+ * `s3` : Amazon S3
91
+ * `b2` : Backblaze B2
92
+ * `local` : nidaamka faylalka maxalliga ah
93
+
94
+ *Tabarucaadka lagu taageerayo bixiyayaasha kaydinta daruuraha aad ayaa loo soo dhawaynayaa!*
95
+
96
+ ## mobiletto-cli
97
+ Mobiletto waxaa loogu talagalay in loo isticmaalo maktabad ahaan koodka JavaScript kale.
98
+
99
+ Si aad mobiletto ugala shaqeyso khadka taliska, isticmaal [mobiletto-cli](https://www.npmjs.com/package/mobiletto-cli)
100
+
101
+ ## Isha
102
+ * [mobiletto on GitHub](https://github.com/cobbzilla/mobiletto)
103
+ * [mobiletto onpm](https://www.npmjs.com/package/mobiletto)
104
+
105
+ ## Deg deg ah
106
+ Tusaale gaaban oo isticmaalaya mobaylka `s3` darawalka.
107
+
108
+ Koodhkani sidiisii ayuu u shaqayn lahaa haddii darawalku yahay `b2` ama `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
+ ## Isticmaalka aasaasiga ah
139
+ Tusaale aad u ballaaran, oo muujinaya inta badan sifooyinka la bixiyo:
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
+ Amarka `metadata` wuxuu soo celiyaa xogta badan ee ku saabsan hal gelinta nidaamka faylalka.
242
+ Sidoo kale, qiimaha ka soo `list` waa shay kala duwan oo xog badan ah.
243
+
244
+ Shayga xogta badan ayaa sidan u eg:
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
+ Hantida `type` waxay noqon kartaa `file` , `dir` , `link` , ama `special` .
255
+
256
+ Iyadoo ku xiran nooca darawalka, amarka `list` waxaa laga yaabaa inuusan soo celin dhammaan goobaha. `name` iyo `type`
257
+ had iyo jeer waa inay joogaan. Amarka `metadata` xiga ayaa soo celin doona dhammaan guryaha la heli karo.
258
+
259
+ ## Habka soo dejinta beddelka ah
260
+ Soo deji cutubka si buuxda u koobay oo isticmaal shaqada `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
+ ## Kaydinta
268
+ Mobiletto waxa uu si fiican ugu shaqeeyaa kaydka <a href="https://redis.io">rediska</a> .
269
+
270
+ Mobiletto waxay isku dayi doontaa inay ku xidho tusaale redis 127.0.0.1:6379
271
+
272
+ Waxaad ka saari kartaa mid ka mid ah kuwan:
273
+ * Deji `MOBILETTO_REDIS_HOST` env var, mobiletto ku xidh halkan halkii aad ka isticmaali lahayd localhost
274
+ * Deji `MOBILETTO_REDIS_PORT` env var, dekeddan waa la isticmaali doonaa
275
+
276
+ Mobiletto waxa ay ku kaydin doontaa dhamaan furayaashiisa rediska oo wata horgalaha `_mobiletto__` . Waad bedeli kartaa tan
277
+ adoo dejinaya `MOBILETTO_REDIS_PREFIX` env var.
278
+
279
+ Waxa kale oo aad dejin kartaa khasnad kasta oo ku xidhan shayga `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
+ ### Ma rabtaa inaad kaydiso redis?
291
+ Si aad u damiso: gudbi `enabled: false` ' shayga `opts.redisConfig` markaad samaysato xidhiidhkaaga.
292
+
293
+ Sida hoos looga hadlay, curyaaminta kaydinta waxay saameyn xun ku yeelan doontaa waxqabadka waxayna keeneysaa codsiyo badan
294
+ kaydinta aad runtii u baahan tahay.
295
+
296
+ ### hagida kaydinta
297
+ ** Kaydinta dahsoon ***: akhrinta/qorista kaydinta sir ah ayaa kayar ka yar sidii caadiga ahayd,
298
+ Laakin ku wareegitaanka hagayaasha (kuwaasi oo waxyaabaha qaarkood ay sameeyaan) waa qaali. Isticmaalka kaydka redis
299
+ waxay ku siin doontaa kor u qaadida waxqabadka muhiimka ah.
300
+
301
+ Cache-ga caadiga ah waa badbaado, laakiin si fiican uma shaqeeyo haddii aad leedahay wax badan oo qoraal ah / ka saar.
302
+ Hawl kasta oo qoraal ah ama ka saar ahi waxay burinaysaa kaydka oo dhan, iyada oo hubinaysa in akhrinta xigta ay arki doonto
303
+ isbedeladii ugu dambeeyay.
304
+
305
+ ### Qalabka CLI
306
+ Haddii aad isticmaalayso aaladda CLI sida [mobiletto-cli](https://www.npmjs.com/package/mobiletto-cli),
307
+ Xaqiiqdi waxaad u baahan doontaa in redis cache la furo, maadaama ay ku dhamaanayso `mo` amarka 'mo'.
308
+
309
+ ## Milicsiga
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
+ Amarka `mirror` waxa uu sameeyaa koobi hal mar ah dhammaan faylalka min mobiletto ilaa mid kale.
318
+ Ma socodsiiso hab kasta oo lagu ilaalinayo muraayadda waqti ka dib. `mirror` mar kale
319
+ si loo waafajiyo wixii faylal maqan.
320
+
321
+ Qiimaha soo celinta `mirror` waa shay fudud oo leh xisaabiye inta faylal si guul leh loo gaaray
322
+ miraayad leh iyo imisa faylal ayaa khaldamay:
323
+
324
+ {
325
+ success: count-of-files-mirrored,
326
+ errors: count-of-files-with-errors
327
+ }
328
+
329
+ DIGNIIN: Milicsiga xogaha waaweyn waxay noqon kartaa waqti-qaadasho iyo baaxad-weyn
330
+
331
+ `mirror` waxa ay mararka qaarkood noqon kartaa jahawareer in la fahmo cidda
332
+ akhriste iyo waa kuma qoraaga. Ka soo qaad sida qoraalka shaqada: "mobiletto-gacanta bidix"
333
+ waa waxa loo qoondeeyay (xogta muraayada la qoray), iyo "mobiletto gacanta midig" (the
334
+ doodda habka `mirror` ) waa qiimaha la qoondeeyey (xogta muraayadda waa la akhriyaa).
335
+
336
+ ## Sirin hufan
337
+ Daar si hufan oo dhinaca macmiilka ah:
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
+ Maxaa dhacaya? Meel gaar ah oo "galitaan tusaha" (dirent) hagaha ( sir ah) ayaa la socda waxa faylalka ku jira
357
+ tusaha (oo loo yaqaan tusaha tooska ah).
358
+ * Amarka `list` wuxuu akhriyaa galka galka tusaha, wuxuu furfuraa waddo kasta oo taxan; ka dibna u soo celisa xogta badan ee fayl kasta
359
+ * `list` waa kuwo aan waxtar lahayn, gaar ahaan hagayaasha leh tiro badan oo faylal ah
360
+ * Amarka `write` wuxuu ku qoraa faylal kala duwan tusaha tooska ah ee waalid kasta, si isdaba joog ah; markaas buu qorayaa faylka
361
+ * `write` waxay keenaysaa O(N) qorta, iyadoo N = qoto dheer ay ku jirto kala sareynta hagaha
362
+ * Amarka `remove` wuxuu meesha ka saarayaa faylka tooska ah ee u dhigma, iyo waalidkii haddii uu madhan yahay, si isdaba joog ah; ka dibna ka saara faylka
363
+ * `remove` ee aan soo noqnoqoneynin waxay keenaysaa O(N) akhrinta iyo suurtogalnimada in la tirtiro, iyadoo N = qoto dheer ay ku jirto kala sareynta hagaha
364
+ * `remove` ee soo noqnoqda ee nidaamyada faylalka waaweyn iyo kuwa qoto dheer waxay noqon karaan qaali
365
+
366
+ Ogsoonow in xitaa iyada oo sirta-dhinaca macmiilku karti u yeeshay, cadow si buuxda u muuqda dhanka server-kaaga sir ah
367
+ kaydinta, xitaa furaha la'aanteed, waxay weli arki kartaa tirada guud ee hagayaasha iyo inta fayl ee mid kasta ku jira, iyo la
368
+ xoogaa dadaal ah, hel qaar ama dhammaan qaab dhismeedka guud ee kala sareynta hagaha.
369
+ *Fiiro gaar ah: Isticmaal qaab dhismeed siman si aad u hesho ammaan wanaagsan.*
370
+ Cadawgu ma garan doono magacyada hagayaasha/faylalka ilaa ay sidoo kale ogaadaan sirtaada mooyaane
371
+ furaha ama haddii kale si guul leh u dillaacay sirta. Dhammaan khamaaradaha waa damsan yihiin markaa!
372
+
373
+ ### Waxqabadka iyo kaydinta
374
+ Hawlgallada kaydinta sirta ah waxay noqon karaan kuwo gaabis ah. Liisaska soo noqnoqda iyo ka saarista waxay noqon kartaa mid aad u gaabis ah.
375
+ Ku kaydinta redis aad bay u caawisaa, laakiin ogow in kaydku ku daatay wax kasta oo la qoro ama laga saaro.
376
+
377
+ ## Wareegtada furaha ah
378
+ Ku samee mobiltto furahaaga cusub, ka dibna u miiri xogtii hore:
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
+ ## interface darawalka
391
+ Darawalku waa fayl kasta oo JS ah oo dhoofiya shaqada 'kaydinta macmiilka' oo leh saxeexan:
392
+
393
+ function storageClient (key, secret, opts)
394
+
395
+ * `key` : xarig, furahaaga API (darawalka `local` ' kani waa tusaha saldhiga)
396
+ * `secret` : xarig, sirtaada API (waxaa laga saari karaa darawalka `local` ')
397
+ * `opts` : shay, alaabtu waa darawal kasta:
398
+ * Wixii `local` ah, `fileMode` iyo `dirMode` guryaha ayaa go'aamiya sida abuurista cusub ee faylasha iyo hagayaasha loo abuuray
399
+ * Wixii `s3` , hantida `bucket` ayaa loo baahan yahay. Guryaha ikhtiyaariga ah waa:
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
+ Shayga uu soo celiyo shaqada Macmiilku waa inuu qeexaa shaqooyinkan:
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
+ ## Gelida
431
+ Mobiletto waxa ay isticmaashaa [winston](https://www.npmjs.com/package/winston)
432
+
433
+ Logs ** waxay ka koobnaan doonaan wadooyin faylal iyo fariimo khalad ah, laakiin ** waligiis kama koobnaan doono furayaal, siro,
434
+ ama macluumaad kasta oo qaabeynta isku xirka kale.
435
+
436
+ ### Heer gal
437
+ Adeegso doorsoomaha deegaanka `MOBILETTO_LOG_LEVEL` si aad u dejiso heerka log, addoo isticmaalaya mid
438
+ ee heerarka `npm` ee lagu qeexay [https://www.npmjs.com/package/winston#logging-levels](https://www.npmjs.com/package/winston#logging-levels)
439
+
440
+ Heerka caadiga ah waa `error` . Heerka ugu afka badan waa `silly` , inkastoo hadda mobiletto
441
+ ma gasho heerarka ka hooseeya `debug`
442
+
443
+ MOBILETTO_LOG_LEVEL=silly # maximum logs!
444
+
445
+ ### Gal gal
446
+ Sida caadiga ah, loggerku wuxuu wax u qoraa console-ka. Si aad diiwaannada ugu dirto faylka, deji `MOBILETTO_LOG_FILE`
447
+ doorsooma deegaanka. Markaad galeyso fayl, diiwaannada laguma qori doono console-ka.
448
+
449
+ MOBILETTO_LOG_FILE=/var/my_mobiletto_log
450
+
451
+ Si aad u damiso goynta:
452
+
453
+ MOBILETTO_LOG_FILE=/dev/null
454
+
455
+ </pre>