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
+ I-Mobiletto ngumaleko wogcino weJavaScript, kunye noguqulelo oluyimfihlo lomthengi olusecaleni.
5
+
6
+ # Imixholo
7
+ * [Kutheni iMobiletto?](#Kutheni-iMobiletto?)
8
+ * [Isiqalo esiKhawulezayo](#Ukuqala ngokukhawuleza)
9
+ * [Mobiletto CLI](#mobiletto-cli)
10
+ * [Umthombo](#Umthombo)
11
+ * [Usetyenziso olusisiseko](#Usetyenziso oluSiseko)
12
+ * [Metadata](#Metadata)
13
+ * [Esinye isimbo sokungenisa](#Esinye-isimbo sokungenisa)
14
+ * [Caching](#Caching)
15
+ * [Mirroring](#Mirroring)
16
+ * [Uguqulelo oluntsonkothileyo elubala](#Uguqulelo olungafihlwayo)
17
+ * [Ukujikeleziswa kweSitshixo](#Ukujikeleziswa kweSitshixo)
18
+ * [Ujongano lomqhubi](#Ujongano lomqhubi)
19
+ * [Logging](#Logging)
20
+
21
+ # Funda oku ngolunye ulwimi
22
+ Olu xwebhu README.md luguqulelwe, kusetyenziswa [hokeylization](https://github.com/cobbzilla/hokeylization), kwi
23
+ **[lonke ulwimi luxhaswa yiToliki kaGoogle](https://cloud.google.com/translate/docs/languages)!**
24
+
25
+ Ndiqinisekile ukuba ayifezekanga, kodwa ndiyathemba ukuba ingcono kunanto!
26
+
27
+ [🇸🇦 isiArabhu](amaxwebhu/ar/README.md)
28
+ [🇧🇩 Bengali](../bn/README.md)
29
+ [🇩🇪 isiJamani](../de/README.md)
30
+ [🇺🇸 IsiNgesi](../en/README.md)
31
+ [🇪🇸 ISpanish](amaxwebhu/es/README.md)
32
+ [🇫🇷 isiFrentshi](../fr/README.md)
33
+ [🇹🇩 Hausa](../ha/README.md)
34
+ [🇮🇳 Hindi](../hi/README.md)
35
+ [🇮🇩 isi-Indonesian](../id/README.md)
36
+ [🇮🇹 IsiTaliyane](amaxwebhu/it/README.md)
37
+ [🇯🇵 Japanese](../ja/README.md)
38
+ [🇰🇷 isiKorea](amaxwebhu/ko/README.md)
39
+ [🇮🇳 Maranthi](../mr/README.md)
40
+ [🇵🇱 Polish](../pl/README.md)
41
+ [🇧🇷 IsiPhuthukezi](amaxwebhu/pt/README.md)
42
+ [🇷🇺 IsiRashiya](../ru/README.md)
43
+ [🇰🇪 IsiSwahili](amaxwebhu/sw/README.md)
44
+ [🇵🇭 Tagalog](../tl/README.md)
45
+ [🇹🇷 IsiTurkey](../tr/README.md)
46
+ [🇵🇰 Urdu](amaxwebhu/ur/README.md)
47
+ [🇻🇳 Vietnamese](../vi/README.md)
48
+ [🇨🇳 isiTshayina](../zh/README.md)
49
+
50
+
51
+ **[📚 ... Zonke Iilwimi ...](amaxwebhu/README.md)**
52
+ ----
53
+
54
+ ### Ngaba kukho ingxaki ngoluguqulelo lwe-FUNDA?
55
+ Le nguqulelo yoqobo [README](https://github.com/cobbzilla/mobiletto/blob/master/README.md)
56
+ isenokuba neziphene -- *izilungiso zamkelekile kakhulu!* Nceda uthumele [isicelo sokutsalwa kwi-GitHub](https://github.com/cobbzilla/mobiletto/pulls),
57
+ okanye ukuba awukhululekanga ukwenza loo nto, [vula umcimbi](https://github.com/cobbzilla/mobiletto/issues)
58
+
59
+ Xa usenza umba omtsha weGitHub malunga nenguqulelo, nceda wenze:
60
+ * bandakanya i-URL yephepha (ikopi/uncamathisele kwibar yedilesi yomkhangeli zincwadi)
61
+ * bandakanya isicatshulwa kanye esingalunganga (khuphela/uncamathisele kwisikhangeli)
62
+ * Nceda uchaze ukuba yintoni engalunganga -- ingaba uguqulelo aluchanekanga? Ngaba ukufomatha kwaphukile ngandlela ithile?
63
+ * ngobubele nikela icebiso lenguqulelo engcono, okanye indlela umbhalo ofanele ubhalwe ngokufanelekileyo
64
+ * **Enkosi!**
65
+
66
+ ## Kutheni iMobiletto?
67
+
68
+ ### Sala kakuhle kumthengisi ukutshixa!
69
+ Ababoneleli abahlukeneyo bokugcina ifu bane-APIs engahambelaniyo. Kwanabo balwela "ukuhambelana kwe-S3"
70
+ babe neendlela zokuziphatha ezingaqhelekanga.
71
+
72
+ Xa ukhetha umthengisi othile wokugcina usetyenziso lwakho, ukuba ukhowudi ngqo kwi-API yabo, usetyenziso lwakho
73
+ ngoku ixhomekeke kuloo nkonzo. Njengoko ixesha lihamba kwaye ikhowudi iqokelela, ukutshintsha abathengisi kuba
74
+ iya ingakwazi ukwenzeka. Wamkelekile kwihlabathi elimnandi lokutshixa kwabathengisi!
75
+
76
+ I-Mobiletto yenzelwe ukusombulula le ngxaki. Ngokufaka ikhowudi iapp yakho kwimobiletto's API, ungalula
77
+ tshintsha ababoneleli ngogcino kwaye wazi ukuba umaleko wogcino lweapp yakho uya kuziphatha ngokufanayo.
78
+
79
+ ### Uvavanyo olubanzi
80
+ Bonke abaqhubi bavavanyelwa ukuziphatha okufanayo kunye novavanyo lwe-60+ kumqhubi ngamnye.
81
+ Sivavanya bonke abaqhubi ngayo yonke indibaniselwano:
82
+ * Uguqulelo oluntsonkothileyo: zombini zivuliwe kwaye zikhubazekile
83
+ * I-Redis cache: zombini ivuliwe kwaye ivaliwe
84
+
85
+ Le ndlela isinika uxolo lwengqondo yokuba i-mobiletto iya kuziphatha ngendlela efanayo nokuba usebenzisa umqhubi weyiphi na.
86
+ kwaye nokuba wenza i-caching kunye/okanye uguqulelo oluntsonkothileyo.
87
+
88
+ ### Inkxaso yomqhubi
89
+ Abaqhubi bangoku beMobiletto yokugcina:
90
+ * `s3` : Amazon S3
91
+ * `b2` : I-Backblaze B2
92
+ * `local` : inkqubo yefayile yendawo
93
+
94
+ *Amagalelo okuxhasa ababoneleli abaninzi bokugcina ilifu bamkelekile kakhulu!*
95
+
96
+ ## mobiletto-cli
97
+ IMobiletto yenzelwe ukuba isetyenziswe njengethala leencwadi ngenye ikhowudi yeJavaScript.
98
+
99
+ Ukusebenza nge-mobiletto kumgca womyalelo, sebenzisa [mobiletto-cli](https://www.npmjs.com/package/mobiletto-cli)
100
+
101
+ ## Umthombo
102
+ * [mobiletto kwi-GitHub](https://github.com/cobbzilla/mobiletto)
103
+ * [mobiletto kwi-npm](https://www.npmjs.com/package/mobiletto)
104
+
105
+ ## Ukuqala ngokukhawuleza
106
+ Umzekelo omfutshane usebenzisa imobiletto `s3` umqhubi.
107
+
108
+ Le khowudi iyakuqhuba ngendlela efanayo ukuba umqhubi `b2` okanye `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
+ ## Usetyenziso olusisiseko
139
+ Umzekelo obanzi ngakumbi, obonisa uninzi lweempawu ezibonelelwayo:
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
+ Umyalelo `metadata` ubuyisela imetadata malunga nongeno lwesixokelelwano esinye.
242
+ Ngokunjalo, ixabiso `list` lomyalelo luludwe lwezinto zemetadata.
243
+
244
+ Into yemetadata ibonakala ngolu hlobo:
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
+ I `type` ipropathi inokuba `file` , `dir` , `link` , okanye `special` .
255
+
256
+ Kuxhomekeka kudidi lomqhubi, `list` umyalelo awunakubuyisela zonke iindawo. I `name` kunye `type` iimpawu
257
+ kufuneka ahlale ekho. Umyalelo olandelayo `metadata` zonke iipropati ezikhoyo.
258
+
259
+ ## Esinye isimbo sokungenisa
260
+ Thatha ngaphandle imodyuli enomda ngokupheleleyo kwaye usebenzise umsebenzi `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
+ ## Ugcino
268
+ I-Mobiletto isebenza kakuhle nge-cache ye- <a href="https://redis.io">redis</a> .
269
+
270
+ I-Mobiletto iya kuzama ukudibanisa kumzekelo we-redis kwi-127.0.0.1: 6379
271
+
272
+ Ungabhala ngaphezulu kwezi:
273
+ * Cwangcisa i `MOBILETTO_REDIS_HOST` env var, imobiletto qhagamshela apha endaweni yehostela yendawo
274
+ * Cwangcisa i `MOBILETTO_REDIS_PORT` env var, elizibuko liza kusetyenziswa
275
+
276
+ I-Mobiletto izakugcina zonke izitshixo zayo zeredis kunye nesiqalo `_mobiletto__` . Ungatshintsha oku
277
+ ngokucwangcisa i `MOBILETTO_REDIS_PREFIX` env var.
278
+
279
+ Ungakwazi nokuseta uqhagamshelo lwe-caching nganye kunye nento ethi `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
+ ### Awufuni redis caching?
291
+ Ukuyekisa: dlula `enabled: false` kwinto yakho `opts.redisConfig` xa useka umdibaniso wakho.
292
+
293
+ Njengoko kuxoxwe ngezantsi, ukukhubaza i-caching kuya kuba nefuthe elibi ekusebenzeni kwaye kubangele izicelo ezininzi
294
+ kugcino olufuna ngokwenene.
295
+
296
+ ### Isikhokelo se-caching
297
+ **Ugcino oluntsonkothileyo**: ukufunda/ukubhala ugcino olufihliweyo lucotha kancinci kunesiqhelo,
298
+ kodwa ukuzulazula kuluhlu lwezalathisi (ezinye izinto ezizenzayo) kubiza kakhulu. Ukusebenzisa i-redis cache
299
+ iya kukunika ukonyuswa okubalulekileyo kokusebenza.
300
+
301
+ I-cache engagqibekanga ikhuselekile, kodwa ayisebenzi kakuhle ukuba unokuninzi kokubhala/ukususa imisebenzi.
302
+ Nakuphi na ukubhala okanye ukususa umsebenzi kuyenza ingasebenzi i-cache yonke, ukuqinisekisa ukuba ufundo olulandelayo luya kubona
303
+ utshintsho lwamva nje.
304
+
305
+ ### izixhobo zeCLI
306
+ Ukuba usebenzisa isixhobo se-CLI esinje [mobiletto-cli](https://www.npmjs.com/package/mobiletto-cli),
307
+ ngokuqinisekileyo uya kufuna ukuba i-redis cache yenziwe, njengoko iqhubeka ngapha kwezicelo zomyalelo `mo` .
308
+
309
+ ## Isipili
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
+ Umyalelo `mirror` wenza ikopi yexesha elinye yazo zonke iifayile ukusuka kwimobiletto enye ukuya kwenye.
318
+ Ayiqhubeki nayiphi na inkqubo yokugcina isibuko ngexesha. Sebenzisa `mirror` umyalelo kwakhona
319
+ ukulungelelanisa naziphi na iifayile ezingekhoyo.
320
+
321
+ Ixabiso lembuyekezo elisuka `mirror` yinto elula enezinto zokubala zokuba zingaphi iifayile eziphumeleleyo
322
+ ezibonisiweyo kwaye zingaphi iifayile ezineempazamo:
323
+
324
+ {
325
+ success: count-of-files-mirrored,
326
+ errors: count-of-files-with-errors
327
+ }
328
+
329
+ ISILUMKISO: Ukujonga iiseti zedatha enkulu kunokutya ixesha elininzi kunye ne-bandwidth
330
+
331
+ Nge `mirror` sokufowuna semantiki ngamanye amaxesha kunokubhida ukuqonda ukuba ngubani
332
+ umfundi kwaye ngubani umbhali. Yiba nomfanekiso wengxelo yesabelo: "isandla sasekhohlo mobiletto"
333
+ yinto eyabelwa kuyo (idatha ebonisiweyo ebhaliweyo), kunye ne "right-hand mobiletto" (i
334
+ Ingxoxo `mirror` ) lixabiso elabelweyo (idatha ebonisiweyo iyafundwa).
335
+
336
+ ## Uguqulelo oluntsonkothileyo
337
+ Yenza uguqulelo oluntsonkothileyo kwicala lomxhasi:
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
+ Kwenzekani? Indawo eyahlukileyo "yengeniso kavimba weefayili" (dirent) uvimba weefayili (ofihliweyo) ulandelela ukuba zeziphi iifayile ezikuloo nto
357
+ uvimba weefayili (aka uvimba weefayili).
358
+ * Umyalelo `list` lufunda uvimba weefayili zongeno, icoca indlela nganye edwelisiweyo; emva koko ibuyisela imetadata yefayile nganye
359
+ `list` ayisebenzi ngakumbi, ingakumbi kubalawuli abanenani elikhulu leefayile
360
+ * Umyalelo othi `write` ubhala iifayile ezizii-dirent kuluhlu lomzali ngamnye, ngokuphindaphindiweyo; emva koko ibhale ifayile
361
+ * `write` imiyalelo iya kwenza u-O(N) ubhale, nge-N = ubunzulu kuluhlu lolawulo
362
+ * Umyalelo `remove` ususa ifayile ehambelanayo ehambelanayo, kwaye umzali wayo ukuba akananto, ngokuphindaphindiweyo; emva koko isuse ifayile
363
+ * Imiyalelo `remove` -O(N) ifundeke kwaye kunokwenzeka ucime oluninzi, nge N = ubunzulu kuluhlu lwenkqubo
364
+ * Imiyalelo ephindaphindayo `remove`
365
+
366
+ Qaphela ukuba nofihlo lwecala lomxhasi luvuliwe, umchasi onokubonakala okupheleleyo kwicala leseva elifihliweyo.
367
+ ugcino, nangaphandle kwesitshixo, usengabona inani lilonke labalawuli kunye nokuba zingaphi iifayile kwindawo nganye, kwaye nge
368
+ umzamo othile, fumana enye okanye sonke isakhelo esipheleleyo soluhlu lweqela leefayili.
369
+ *Qaphela: Sebenzisa isakhiwo esithe tyaba ukwenzela ukhuseleko olungcono.
370
+ Utshaba alunakwazi amagama abalawuli/iifayile ngaphandle kokuba nabo bayalwazi ufihlo lwakho
371
+ isitshixo okanye ngenye indlela iqhekeze ngempumelelo uguqulelo oluntsonkothileyo. Zonke iibheji zicinyiwe ngoko!
372
+
373
+ ### Ukusebenza kunye ne-caching
374
+ Imisebenzi kugcino oluntsonkothileyo lungacotha. Uluhlu oluphindayo kunye nokususwa kunokucotha kakhulu.
375
+ Ukugcinwa kwe-cache nge-redis kunceda kakhulu, kodwa qaphela ukuba i-cache igutyungelwe nakuphi na okubhaliweyo okanye okususayo.
376
+
377
+ ## Ujikelezo olungundoqo
378
+ Yenza i-mobiletto ngesitshixo sakho esitsha, emva koko ubonise idatha endala kuyo:
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
+ ## Ujongano lomqhubi
391
+ Umqhubi yiyo nayiphi na ifayile ye-JS ethumela ngaphandle umsebenzi we-'storageClient' ngolu tyikityo:
392
+
393
+ function storageClient (key, secret, opts)
394
+
395
+ * `key` : umtya, isitshixo sakho se-API ( `local` olu luluhlu lwesiseko)
396
+ * `secret` : umtya, imfihlo yakho ye-API (inokushiywa kumqhubi `local` )
397
+ * `opts` : into, iipropati ngomqhubi ngamnye:
398
+ * `local` , `fileMode` kunye ne `dirMode` iipropati zimisela indlela entsha yokudala iifayile kunye nabalawuli benziwa
399
+ * Kwi `s3` , ipropathi `bucket` iyafuneka. Iipropati ezikhethwayo zezi:
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
+ Into ebuyiswa ngumsebenzi weClient kufuneka ichaze le misebenzi:
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
+ ## Ukugawulwa kwemithi
431
+ I-Mobiletto isebenzisa [winston](https://www.npmjs.com/package/winston) ilayibrari yokugawulwa kwemithi.
432
+
433
+ Iilogi ** ziya kuqulatha iindlela zefayile kunye nemiyalezo yempazamo, kodwa ayisayi kuba **nakuze ** iqulathe izitshixo, iimfihlo,
434
+ okanye naluphi na olunye ulwazi loqwalaselo loqhagamshelwano.
435
+
436
+ ### Inqanaba lokuloga
437
+ Sebenzisa `MOBILETTO_LOG_LEVEL` ukuguquguquka kwemekobume ukuseta umgangatho welog, usebenzisa enye
438
+ `npm` achazwe kwi [https://www.npmjs.com/package/winston#logging-levels](https://www.npmjs.com/package/winston#logging-levels)
439
+
440
+ Umphakamo omiselweyo uthi `error` . Elona nqanaba `silly` , nangona okwangoku mobiletto
441
+ ayilogi kumanqanaba asezantsi `debug`
442
+
443
+ MOBILETTO_LOG_LEVEL=silly # maximum logs!
444
+
445
+ ### Ifayile yelog
446
+ Ngokungagqibekanga, umgawuli ubhalela ikhonsoli. Ukuthumela iilog kwifayile, seta i `MOBILETTO_LOG_FILE`
447
+ ukuguquguquka kokusingqongileyo. Xa ungena kwifayile, iilog azisayi kuphinda zibhalelwe kwi-console.
448
+
449
+ MOBILETTO_LOG_FILE=/var/my_mobiletto_log
450
+
451
+ Ukucima ukugawulwa kwemithi:
452
+
453
+ MOBILETTO_LOG_FILE=/dev/null
454
+
455
+ </pre>