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 shine Layer Abstraction na ajiya na JavaScript, tare da ɓoye ɓoyayyen gefen abokin ciniki na zaɓi na zaɓi.
5
+
6
+ # Abubuwan ciki
7
+ * [Me yasa Mobiletto?](#Me yasa Mobiletto?)
8
+ * [Farawa cikin sauri](#Farawa da sauri)
9
+ * [Mobiletto CLI](#mobiletto-cli)
10
+ * [Madogararsa](#Source)
11
+ * [Amfani na asali](#Basic-amfani)
12
+ * [Metadata](#Metadata)
13
+ * [Salon shigo da na dabam](#Salo-Salo-Salo-Salo)
14
+ * [Caching](#Caching)
15
+ * [Mirroring](#Mirroring)
16
+ * [Transparent encryption](#Transparent-encryption)
17
+ * [Maɓalli na juyawa](#Maɓalli-juyawa)
18
+ * [Driver interface](#Driver-interface)
19
+ * [Logging](#Logging)
20
+
21
+ # Karanta wannan a wani yare
22
+ An fassara wannan takaddar README.md, ta [hokeylization](https://github.com/cobbzilla/hokeylization), zuwa
23
+ **[kowane harshe yana da tallafin Google Translate](https://cloud.google.com/translate/docs/languages)!**
24
+
25
+ Na tabbata ba cikakke ba ne, amma ina fata ya fi komai kyau!
26
+
27
+ [🇸🇦 Larabci](../ar/README.md)
28
+ [🇧🇩 Bengali](../bn/README.md)
29
+ [🇩🇪 Jamusanci](../de/README.md)
30
+ [🇺🇸 Turanci](../ha/README.md)
31
+ [🇪🇸 Mutanen Espanya](../es/README.md)
32
+ [🇫🇷 Faransanci](../fr/README.md)
33
+ [🇹🇩 Hausa](../ha/README.md)
34
+ [🇮🇳 Hindi](../hi/README.md)
35
+ [🇮🇩 Indonesian](../id/README.md)
36
+ [🇮🇹 Italiyanci](../it/README.md)
37
+ [🇯🇵 Jafananci](../ja/README.md)
38
+ [🇰🇷 Korean](../ko/README.md)
39
+ [🇮🇳 Maranthi](../mr/README.md)
40
+ [🇵🇱 Yaren mutanen Poland](../pl/README.md)
41
+ [🇧🇷 Portuguese](../pt/README.md)
42
+ [🇷🇺 Rashanci](../ru/README.md)
43
+ [🇰🇪 Swahili](../sw/README.md)
44
+ [🇵🇭 Tagalog](../tl/README.md)
45
+ [🇹🇷 Baturke](../tr/README.md)
46
+ [🇵🇰 Urdu](../ur/README.md)
47
+ [🇻🇳 Vietnamese](../vi/README.md)
48
+ [🇨🇳 Sinanci](../zh/README.md)
49
+
50
+
51
+ **[📚 ... Duk Harsuna ...](../README.md)**
52
+ ----
53
+
54
+ ### Akwai matsala da wannan fassarar README?
55
+ Wannan fassarar ta asali ta asali [README](https://github.com/cobbzilla/mobiletto/blob/master/README.md)
56
+ na iya zama aibi - * ana maraba da gyare-gyare!* Da fatan za a aika [buƙatun ja akan GitHub](https://github.com/cobbzilla/mobiletto/pulls),
57
+ ko kuma idan ba ku ji daɗin yin hakan ba, [buɗe batun](https://github.com/cobbzilla/mobiletto/issues)
58
+
59
+ Lokacin da kuka ƙirƙiri sabon batun GitHub game da fassarar, da fatan za a yi:
60
+ * hada da URL na shafi (kwafi / manna daga mashaya adireshin mashigin)
61
+ * hada da ainihin rubutun da ba daidai ba (kwafi / manna daga mai bincike)
62
+ * don Allah bayyana abin da ba daidai ba -- shin fassarar ba daidai ba ce? an karye tsarin ko ta yaya?
63
+ * a hankali ba da shawarar mafi kyawun fassarar, ko yadda ya kamata a tsara rubutun yadda ya kamata
64
+ * **Na gode!**
65
+
66
+ ## Me yasa Mobiletto?
67
+
68
+ ### Barka da kulle-kulle mai siyarwa!
69
+ Daban-daban masu samar da ajiyar girgije suna da APIs marasa jituwa. Ko da waɗanda ke ƙoƙari don "S3 dacewa"
70
+ suna da halaye na ban mamaki.
71
+
72
+ Lokacin da kuka zaɓi takamaiman mai siyar da ajiya don app ɗinku, idan kun yi code kai tsaye zuwa API ɗin su, app ɗin ku
73
+ yanzu ya dogara da wannan sabis ɗin. Yayin da lokaci ya wuce kuma code yana tarawa, canza dillalai ya zama
74
+ ƙara rashin ƙarfi. Barka da zuwa duniyar nishaɗin kulle-kulle mai siyarwa!
75
+
76
+ An ƙera Mobiletto don magance wannan matsalar. Ta hanyar yin codeing app ɗin ku zuwa API ɗin mobiletto, kuna iya sauƙi
77
+ canza masu samar da ma'ajiya kuma ku sani cewa Layer ɗin ajiyar app ɗin ku zai yi aiki iri ɗaya.
78
+
79
+ ### Gwaji mai yawa
80
+ Ana gwada duk direbobi don halaye iri ɗaya tare da gwaje-gwaje 60+ ga kowane direba.
81
+ Muna gwada duk direbobi tare da kowane haɗuwa na:
82
+ * Rufewa: duka an kunna kuma an kashe
83
+ * Redis cache: duka an kunna kuma an kashe su
84
+
85
+ Wannan hanyar tana ba mu kwanciyar hankali cewa wayar hannu za ta kasance iri ɗaya ba tare da la'akari da direban da kuke amfani da shi ba,
86
+ kuma ko da kun kunna caching da/ko ɓoyewa.
87
+
88
+ ### Tallafin direba
89
+ Direbobin ajiya na Mobiletto na yanzu:
90
+ * `s3` : Amazon S3
91
+ * `b2` : Bakin baya B2
92
+ * `local` na gida': tsarin fayil na gida
93
+
94
+ *Taimako don tallafawa ƙarin masu samar da ajiyar girgije ana maraba da su!*
95
+
96
+ ## mobiletto-cli
97
+ Mobiletto ana nufin amfani da shi azaman ɗakin karatu ta wasu lambar JavaScript.
98
+
99
+ Don aiki tare da mobiletto a layin umarni, yi amfani da [mobiletto-cli](https://www.npmjs.com/package/mobiletto-cli)
100
+
101
+ ## Source
102
+ * [mobiletto akan GitHub](https://github.com/cobbzilla/mobiletto)
103
+ * [mobiletto akan npm](https://www.npmjs.com/package/mobiletto)
104
+
105
+ ## Gaggauta Farawa
106
+ Wani ɗan gajeren misali ta amfani da direban mobiletto `s3` .
107
+
108
+ Wannan lambar zata yi aiki iri ɗaya idan direban `b2` ko `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
+ ## Asalin amfani
139
+ Misali mafi fa'ida, yana nuna yawancin abubuwan da aka bayar:
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
+ Umurnin `metadata` yana dawo da metadata game da shigarwar tsarin fayil guda ɗaya.
242
+ Hakazalika, ƙimar dawowa daga umurnin `list` jeri' jerin abubuwa ne na metadata.
243
+
244
+ Abun metadata yayi kama da haka:
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
+ Kayan `type` ' na iya zama `file` ' , `dir` , `link` , ko `special` .
255
+
256
+ Dangane da nau'in direba, umarni `list` bazai dawo da duk filayen ba. Abubuwan `name` suna' da `type`
257
+ ya kamata a kasance a koyaushe. Umurnin `metadata` na gaba zai dawo da duk kaddarorin da ke akwai.
258
+
259
+ ## Madadin salon shigo da kaya
260
+ Shigo da cikakken tsari kuma yi amfani da aikin `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 yana aiki mafi kyau tare da <a href="https://redis.io">redis</a> cache.
269
+
270
+ Mobiletto zai yi ƙoƙarin haɗawa zuwa misalin redis akan 127.0.0.1:6379
271
+
272
+ Kuna iya soke ɗaya daga cikin waɗannan:
273
+ * Saita `MOBILETTO_REDIS_HOST` env var, mobiletto haɗi anan maimakon localhost
274
+ * Saita `MOBILETTO_REDIS_PORT` env var, za a yi amfani da wannan tashar jiragen ruwa
275
+
276
+ Mobiletto zai adana duk maɓallan redis tare da prefix `_mobiletto__` . Kuna iya canza wannan
277
+ ta hanyar saita `MOBILETTO_REDIS_PREFIX` env var.
278
+
279
+ Hakanan zaka iya saita caching ta hanyar haɗin kai tare da abun `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
+ ### Ba kwa son redis caching?
291
+ Don kashe: wuce `enabled: false` a cikin abun `opts.redisConfig` lokacin da kuka kafa haɗin ku.
292
+
293
+ Kamar yadda aka tattauna a ƙasa, kashe caching zai yi mummunan tasiri akan aiki kuma ya haifar da ƙarin buƙatun
294
+ zuwa ajiyar da kuke buƙatar gaske.
295
+
296
+ ### Jagorar caching
297
+ ** Rufaffen ma'auni ***: karantawa/rubutun rufaffen ma'ajin yana ɗan ɗan hankali fiye da na al'ada,
298
+ amma kewaya cikin kundin adireshi (wanda wasu abubuwa suke yi) yana da tsada sosai. Amfani da redis cache
299
+ zai ba ku gagarumin haɓaka aiki.
300
+
301
+ Tsohuwar cache mai lafiya ne, amma baya aiki da kyau idan kuna da yawa na rubutu/cire ayyuka.
302
+ Duk wani aiki na rubutu ko cirewa yana lalata duk cache ɗin, yana tabbatar da karantawa na gaba zai ga
303
+ sabbin canje-canje.
304
+
305
+ ### kayan aikin CLI
306
+ Idan kana amfani da kayan aikin CLI kamar [mobiletto-cli](https://www.npmjs.com/package/mobiletto-cli),
307
+ tabbas za ku so a kunna ma'ajin redis, saboda yana wucewa cikin `mo` .
308
+
309
+ ## Mirroring
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` yana aiwatar da kwafin duk fayiloli na lokaci ɗaya daga wayar hannu zuwa wancan.
318
+ Ba ya gudanar da kowane tsari don kula da madubi akan lokaci. sake gudanar da umurnin `mirror`
319
+ don daidaita duk fayilolin da suka ɓace.
320
+
321
+ Ƙimar dawowa daga `mirror` ne mai sauƙi tare da ƙididdiga don fayilolin nawa aka yi nasara
322
+ madubi da fayiloli nawa ne suka sami kurakurai:
323
+
324
+ {
325
+ success: count-of-files-mirrored,
326
+ errors: count-of-files-with-errors
327
+ }
328
+
329
+ GARGAƊI: Nuna manyan saitin bayanai na iya zama mai cin lokaci sosai kuma mai saurin bandwidth
330
+
331
+ Tare da ma'anar kiran `mirror` wani lokaci yana iya zama da rudani don fahimtar wanene
332
+ mai karatu kuma wanene marubuci. Ka yi tunanin shi kamar bayanin aiki: "mobiletto hannun hagu"
333
+ shine abin da ake sanyawa (babban bayanan da aka rubuta), da kuma "mobiletto hannun dama" (da
334
+ hujja ga hanyar `mirror` ) shine ƙimar da ake sanyawa (ana karanta bayanan madubi).
335
+
336
+ ## boye boye boye
337
+ Kunna ɓoye ɓoyayyen gefen abokin ciniki:
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
+ Me ke faruwa? Wani keɓantaccen littafin "shigarwar kundin adireshi" (mai rufaffiyar) yana bin abin da fayiloli ke cikin wancan
357
+ directory (wanda aka fi sani da directory).
358
+ * `list` yana karanta fayilolin shigarwar kundin adireshi, yana lalata kowane hanyar da aka jera; sannan ya dawo da metadata ga kowane fayil
359
+ * `list` sun fi rashin inganci, musamman ga kundin adireshi masu yawan fayiloli
360
+ * `write` rubuta fayilolin da ba su dace ba a cikin kundin adireshi na kowane iyaye, akai-akai; sannan ya rubuta fayil din
361
+ * `write` za su haifar da O(N) ya rubuta, tare da N = zurfin a cikin matsayi na shugabanci
362
+ * Umurnin `remove` cire' yana cire babban fayil ɗin daidai, kuma iyayensa idan babu komai, akai-akai; sannan ya cire fayil din
363
+ * `remove` za su haifar da karatun O(N) da yuwuwar sharewa da yawa, tare da N = zurfi a cikin tsarin shugabanci.
364
+ * `remove` akan manyan fayilolin fayiloli masu zurfi na iya zama tsada
365
+
366
+ Lura cewa ko da tare da ɓoyayyen ɓoyayyen abokin ciniki, abokin gaba mai cikakken gani a cikin ɓoyayyen uwar garken ku.
367
+ ajiya, ko da ba tare da maɓalli ba, har yanzu yana iya ganin jimlar adadin kundayen adireshi da fayiloli nawa a cikin kowannensu, tare da
368
+ wani yunƙuri, gano wasu ko duk tsarin gaba ɗaya na matsayi na shugabanci.
369
+ *Lura: Yi amfani da siffa mai faɗi don ingantaccen tsaro.*
370
+ Abokan gaba ba zai san sunayen kundayen adireshi/fayil ɗin ba sai dai idan sun san ɓoyewar ku
371
+ maɓalli ko kuma an sami nasarar fashe ɓoyayyen ɓoyayyen. An kashe duk fare to!
372
+
373
+ ### Aiki da caching
374
+ Ayyuka akan rufaffiyar ma'ajiyar na iya zama a hankali. Lissafin maimaitawa da cirewa na iya zama a hankali.
375
+ Caching ta hanyar redis yana taimakawa sosai, amma lura cewa cache ɗin yana goge akan kowane rubutu ko cirewa.
376
+
377
+ ## Juyawa Maɓalli
378
+ Ƙirƙiri wayar hannu tare da sabon maɓalli, sannan madubi tsohon bayanai a ciki:
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
+ ## Driver interface
391
+ Direba shine kowane fayil na JS wanda ke fitar da aikin 'abokin ajiya' tare da wannan sa hannu:
392
+
393
+ function storageClient (key, secret, opts)
394
+
395
+ * `key` : kirtani, maɓallin API ɗinku (na direban `local` na gida' wannan shine tushen jagorar)
396
+ * `secret` : kirtani, sirrin API ɗinku (ana iya barin direban `local` na gida')
397
+ * `opts` : abu, kaddarorin kowane direba ne:
398
+ * Don `local` na gida', kayan `fileMode` da `dirMode` ƙayyade yadda ake ƙirƙirar sabbin fayiloli da kundayen adireshi
399
+ * Don `s3` , ana buƙatar kadarorin `bucket` . Kaddarorin na zaɓi sune:
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
+ Abinda aikin Abokin ciniki ya dawo dashi dole ne ya ayyana waɗannan ayyuka:
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
+ ## Shiga
431
+ Mobiletto yana amfani da ɗakin karatu na [winston](https://www.npmjs.com/package/winston).
432
+
433
+ Logs **zai ƙunshi hanyoyin fayil da saƙonnin kuskure, amma ** ba zai taɓa ƙunshi maɓalli, sirri ba,
434
+ ko duk wani bayanin haɗin kai.
435
+
436
+ ### Matsayin shiga
437
+ Yi amfani da madaidaicin mahallin `MOBILETTO_LOG_LEVEL` don saita matakin log, ta amfani da ɗaya
438
+ na matakan `npm` da aka ayyana a [https://www.npmjs.com/package/winston#logging-levels](https://www.npmjs.com/package/winston#logging-levels)
439
+
440
+ Matsayin tsoho shine `error` . Mafi girman matakin magana shine `silly` , kodayake a halin yanzu wayar hannu
441
+ baya shiga a matakan da ke ƙasa `debug`
442
+
443
+ MOBILETTO_LOG_LEVEL=silly # maximum logs!
444
+
445
+ ### Shiga fayil
446
+ Ta hanyar tsoho, mai shiga yana rubutawa ga na'ura mai kwakwalwa. Don aika rajistan ayyukan zuwa fayil, saita `MOBILETTO_LOG_FILE`
447
+ m yanayi. Lokacin shiga fayil, ba za a ƙara rubuta rajistan ayyukan zuwa na'ura wasan bidiyo ba.
448
+
449
+ MOBILETTO_LOG_FILE=/var/my_mobiletto_log
450
+
451
+ Don kashe shiga:
452
+
453
+ MOBILETTO_LOG_FILE=/dev/null
454
+
455
+ </pre>