mobiletto 1.2.1 → 2.0.0

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 (124) hide show
  1. package/lib/cjs/index.d.ts +2 -0
  2. package/lib/cjs/index.js +30 -0
  3. package/lib/cjs/package.json +16 -0
  4. package/lib/esm/index.d.ts +2 -0
  5. package/lib/esm/index.js +12 -0
  6. package/package.json +27 -13
  7. package/.babelrc +0 -5
  8. package/.eslintrc.js +0 -14
  9. package/docs/README.md +0 -113
  10. package/docs/af/README.md +0 -481
  11. package/docs/am/README.md +0 -481
  12. package/docs/ar/README.md +0 -481
  13. package/docs/az/README.md +0 -481
  14. package/docs/be/README.md +0 -481
  15. package/docs/bg/README.md +0 -481
  16. package/docs/bn/README.md +0 -481
  17. package/docs/bs/README.md +0 -481
  18. package/docs/ca/README.md +0 -481
  19. package/docs/ceb/README.md +0 -481
  20. package/docs/co/README.md +0 -481
  21. package/docs/cs/README.md +0 -481
  22. package/docs/cy/README.md +0 -481
  23. package/docs/da/README.md +0 -481
  24. package/docs/de/README.md +0 -481
  25. package/docs/el/README.md +0 -481
  26. package/docs/eo/README.md +0 -481
  27. package/docs/es/README.md +0 -481
  28. package/docs/et/README.md +0 -481
  29. package/docs/eu/README.md +0 -481
  30. package/docs/fa/README.md +0 -481
  31. package/docs/fi/README.md +0 -481
  32. package/docs/fr/README.md +0 -481
  33. package/docs/fy/README.md +0 -481
  34. package/docs/ga/README.md +0 -481
  35. package/docs/gd/README.md +0 -481
  36. package/docs/gl/README.md +0 -481
  37. package/docs/gu/README.md +0 -481
  38. package/docs/ha/README.md +0 -481
  39. package/docs/haw/README.md +0 -481
  40. package/docs/he/README.md +0 -481
  41. package/docs/hi/README.md +0 -481
  42. package/docs/hmn/README.md +0 -481
  43. package/docs/hr/README.md +0 -481
  44. package/docs/ht/README.md +0 -481
  45. package/docs/hu/README.md +0 -481
  46. package/docs/hy/README.md +0 -481
  47. package/docs/id/README.md +0 -481
  48. package/docs/ig/README.md +0 -481
  49. package/docs/is/README.md +0 -481
  50. package/docs/it/README.md +0 -481
  51. package/docs/iw/README.md +0 -481
  52. package/docs/ja/README.md +0 -481
  53. package/docs/jv/README.md +0 -481
  54. package/docs/ka/README.md +0 -481
  55. package/docs/kk/README.md +0 -481
  56. package/docs/km/README.md +0 -481
  57. package/docs/kn/README.md +0 -481
  58. package/docs/ko/README.md +0 -481
  59. package/docs/ku/README.md +0 -481
  60. package/docs/ky/README.md +0 -481
  61. package/docs/la/README.md +0 -481
  62. package/docs/lb/README.md +0 -481
  63. package/docs/lo/README.md +0 -481
  64. package/docs/lt/README.md +0 -481
  65. package/docs/lv/README.md +0 -481
  66. package/docs/mg/README.md +0 -481
  67. package/docs/mi/README.md +0 -481
  68. package/docs/mk/README.md +0 -481
  69. package/docs/ml/README.md +0 -481
  70. package/docs/mn/README.md +0 -481
  71. package/docs/mr/README.md +0 -481
  72. package/docs/ms/README.md +0 -481
  73. package/docs/mt/README.md +0 -481
  74. package/docs/my/README.md +0 -481
  75. package/docs/ne/README.md +0 -481
  76. package/docs/nl/README.md +0 -481
  77. package/docs/no/README.md +0 -481
  78. package/docs/ny/README.md +0 -481
  79. package/docs/or/README.md +0 -481
  80. package/docs/pa/README.md +0 -481
  81. package/docs/pl/README.md +0 -481
  82. package/docs/ps/README.md +0 -481
  83. package/docs/pt/README.md +0 -481
  84. package/docs/ro/README.md +0 -481
  85. package/docs/ru/README.md +0 -481
  86. package/docs/rw/README.md +0 -481
  87. package/docs/sd/README.md +0 -481
  88. package/docs/si/README.md +0 -481
  89. package/docs/sk/README.md +0 -481
  90. package/docs/sl/README.md +0 -481
  91. package/docs/sm/README.md +0 -481
  92. package/docs/sn/README.md +0 -481
  93. package/docs/so/README.md +0 -481
  94. package/docs/sq/README.md +0 -481
  95. package/docs/sr/README.md +0 -481
  96. package/docs/st/README.md +0 -481
  97. package/docs/su/README.md +0 -481
  98. package/docs/sv/README.md +0 -481
  99. package/docs/sw/README.md +0 -481
  100. package/docs/ta/README.md +0 -481
  101. package/docs/te/README.md +0 -481
  102. package/docs/tg/README.md +0 -481
  103. package/docs/th/README.md +0 -481
  104. package/docs/tk/README.md +0 -481
  105. package/docs/tl/README.md +0 -481
  106. package/docs/tr/README.md +0 -481
  107. package/docs/tt/README.md +0 -481
  108. package/docs/ug/README.md +0 -481
  109. package/docs/uk/README.md +0 -481
  110. package/docs/ur/README.md +0 -481
  111. package/docs/uz/README.md +0 -481
  112. package/docs/vi/README.md +0 -481
  113. package/docs/xh/README.md +0 -481
  114. package/docs/yi/README.md +0 -481
  115. package/docs/yo/README.md +0 -481
  116. package/docs/zh/README.md +0 -481
  117. package/docs/zu/README.md +0 -481
  118. package/drivers/b2/index.js +0 -451
  119. package/drivers/local/index.js +0 -315
  120. package/drivers/s3/index.js +0 -316
  121. package/hokey.json +0 -16
  122. package/index.js +0 -29
  123. package/test/api.spec.js +0 -512
  124. package/test/crypt.spec.js +0 -67
package/docs/ha/README.md DELETED
@@ -1,481 +0,0 @@
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
- * [Shigarwa](#Shigarwa)
12
- * [Tallafawa da Kuɗi](#Taimako-da-Kudade)
13
- * [Amfani na asali](#Basic-amfani)
14
- * [Metadata](#Metadata)
15
- * [Salon shigo da na dabam](#Salo-Salo-Salo-Salo)
16
- * [Caching](#Caching)
17
- * [Mirroring](#Mirroring)
18
- * [Transparent encryption](#Transparent-encryption)
19
- * [Maɓalli na juyawa](#Maɓalli-juyawa)
20
- * [Driver interface](#Driver-interface)
21
- * [Logging](#Logging)
22
-
23
- # Karanta wannan a wani yare
24
- An fassara wannan takaddar README.md, ta [hokeylization](https://github.com/cobbzilla/hokeylization), zuwa
25
- **[kowane harshe yana da tallafin Google Translate](https://cloud.google.com/translate/docs/languages)!**
26
-
27
- Na tabbata ba cikakke ba ne, amma ina fata ya fi komai kyau!
28
-
29
- [🇸🇦 Larabci](../ar/README.md)
30
- [🇧🇩 Bengali](../bn/README.md)
31
- [🇩🇪 Jamusanci](../de/README.md)
32
- [🇺🇸 Turanci](../ha/README.md)
33
- [🇪🇸 Mutanen Espanya](../es/README.md)
34
- [🇫🇷 Faransanci](../fr/README.md)
35
- [🇹🇩 Hausa](../ha/README.md)
36
- [🇮🇳 Hindi](../hi/README.md)
37
- [🇮🇩 Indonesian](../id/README.md)
38
- [🇮🇹 Italiyanci](../it/README.md)
39
- [🇯🇵 Jafananci](../ja/README.md)
40
- [🇰🇷 Korean](../ko/README.md)
41
- [🇮🇳 Marathi](../mr/README.md)
42
- [🇵🇱 Yaren mutanen Poland](../pl/README.md)
43
- [🇧🇷 Portuguese](../pt/README.md)
44
- [🇷🇺 Rashanci](../ru/README.md)
45
- [🇰🇪 Swahili](../sw/README.md)
46
- [🇵🇭 Tagalog](../tl/README.md)
47
- [🇹🇷 Baturke](../tr/README.md)
48
- [🇵🇰 Urdu](../ur/README.md)
49
- [🇻🇳 Vietnamese](../vi/README.md)
50
- [🇨🇳 Sinanci](../zh/README.md)
51
-
52
-
53
- **[📚 ... Duk Harsuna ...](../README.md)**
54
- ----
55
-
56
- ### Akwai matsala da wannan fassarar README?
57
- Wannan fassarar ta asali ta asali [README](https://github.com/cobbzilla/mobiletto/blob/master/README.md)
58
- 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),
59
- ko kuma idan ba ku ji daɗin yin hakan ba, [buɗe batun](https://github.com/cobbzilla/mobiletto/issues)
60
-
61
- Lokacin da kuka ƙirƙiri sabon batun GitHub game da fassarar, da fatan za a yi:
62
- * hada da URL na shafi (kwafi / manna daga mashaya adireshin mashigin)
63
- * hada da ainihin rubutun da ba daidai ba (kwafi / manna daga mai bincike)
64
- * don Allah bayyana abin da ba daidai ba -- shin fassarar ba daidai ba ce? an karye tsarin ko ta yaya?
65
- * a hankali ba da shawarar mafi kyawun fassarar, ko yadda ya kamata a tsara rubutun yadda ya kamata
66
- * **Na gode!**
67
-
68
- ## Me yasa Mobiletto?
69
-
70
- ### Barka da kulle-kulle mai siyarwa!
71
- Daban-daban masu samar da ajiyar girgije suna da APIs marasa jituwa. Ko da waɗanda ke ƙoƙari don "S3 dacewa"
72
- suna da halaye na ban mamaki.
73
-
74
- 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
75
- yanzu ya dogara da wannan sabis ɗin. Yayin da lokaci ya wuce kuma code yana tarawa, canza dillalai ya zama
76
- ƙara rashin ƙarfi. Barka da zuwa duniyar nishaɗin kulle-kulle mai siyarwa!
77
-
78
- An ƙera Mobiletto don magance wannan matsalar. Ta hanyar yin codeing app ɗin ku zuwa API ɗin mobiletto, kuna iya sauƙi
79
- canza masu samar da ma'ajiya kuma ku sani cewa Layer ɗin ajiyar app ɗin ku zai yi aiki iri ɗaya.
80
-
81
- ### Gwaji mai yawa
82
- Ana gwada duk direbobi don halaye iri ɗaya tare da gwaje-gwaje 60+ ga kowane direba.
83
- Muna gwada duk direbobi tare da kowane haɗuwa na:
84
- * Rufewa: duka an kunna kuma an kashe
85
- * Redis cache: duka an kunna kuma an kashe su
86
-
87
- 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,
88
- kuma ko da kun kunna caching da/ko ɓoyewa.
89
-
90
- ### Tallafin direba
91
- Direbobin ajiya na Mobiletto na yanzu:
92
- * `s3` : Amazon S3
93
- * `b2` : Bakin baya B2
94
- * `local` : tsarin fayil na gida
95
-
96
- *Taimako don tallafawa ƙarin masu samar da ajiyar girgije ana maraba da su!*
97
-
98
- ## mobiletto-cli
99
- Mobiletto ana nufin amfani da shi azaman ɗakin karatu ta wasu lambar JavaScript.
100
-
101
- Don aiki tare da mobiletto a layin umarni, yi amfani da [mobiletto-cli](https://www.npmjs.com/package/mobiletto-cli)
102
-
103
- ## Source
104
- * [mobiletto akan GitHub](https://github.com/cobbzilla/mobiletto)
105
- * [mobiletto akan npm](https://www.npmjs.com/package/mobiletto)
106
-
107
- ## Tallafi da Kudi
108
- Ina ƙoƙari in zama ƙwararren mai haɓaka tushen software. Na kasance ina aiki a ciki
109
- masana'antar software tsawon shekaru da yawa, na fara kamfanoni masu nasara kuma na sayar da su ga kamfanonin jama'a.
110
- Kwanan nan na rasa aiki, kuma ba ni da wani aiki a layi daya
111
-
112
- Don haka zan gwada rubuta software mai taimako don ganin ko hakan yana aiki
113
-
114
- Idan kuna jin daɗin amfani da wannan software, zan yi godiya sosai don har ma da
115
- mafi ƙanƙanta [gudunmawar wata-wata ta hanyar Patreon](https://www.patreon.com/cobbzilla)
116
-
117
- *Na gode!*
118
-
119
- ## Shigarwa
120
- Shigar ta amfani da `npm` ko `yarn` . Wataƙila kuna son sigar `lite` ba ta haɗa da duka ba
121
- Fassarar README fayiloli:
122
-
123
- npm install mobiletto-lite
124
- yarn add mobiletto-lite
125
-
126
- Idan da gaske kuna son fayilolin README a kowane harshe, shigar da cikakken sigar:
127
-
128
- npm install mobiletto
129
- yarn add mobiletto
130
-
131
- ## Gaggauta Farawa
132
- Wani ɗan gajeren misali ta amfani da direban mobiletto `s3` .
133
-
134
- Wannan lambar zata yi aiki iri ɗaya idan direban `b2` ko `local` .
135
-
136
- const storage = require('mobiletto')
137
- const bucket = await storage.connect('s3', aws_key, aws_secret, {bucket: 'bk'})
138
-
139
- // list objects: returns array of metadata objects
140
- const listing = await bucket.list()
141
- const dirList = await bucket.list('some/dir/')
142
- const everything = await bucket.list('', {recursive: true})
143
-
144
- // write an entire file
145
- let bytesWritten = await bucket.writeFile('some/path', someBufferOfData)
146
-
147
- // write a file from a stream/generator
148
- bytesWritten = await bucket.write('some/path', streamOrGenerator)
149
-
150
- // read an entire file
151
- // returns null if an exception would otherwise be thrown
152
- const bufferOrNull = await bucket.safeReadFile('some/path')
153
-
154
- // stream-read a file, passing data to callback
155
- const bytesRead = await bucket.read('some/path', (chunk) => { ...do something with chunk... } )
156
-
157
- // remove a file, returns the path removed
158
- let removed = await bucket.remove('some/path') // removed is a string
159
-
160
- // remove a directory, returns array of paths removed
161
- removed = await bucket.remove('some/directory', {recursive: true}) // removed is now an array!
162
-
163
- ----
164
- ## Asalin amfani
165
- Misali mafi fa'ida, yana nuna yawancin abubuwan da aka bayar:
166
-
167
- const { mobiletto } = require('mobiletto')
168
-
169
- // General usage
170
- const api = await mobiletto(driverName, key, secret, opts)
171
-
172
- // To use 'local' driver:
173
- // * key: base directory
174
- // * secret: ignored, can be null
175
- // * opts object:
176
- // * readOnly: optional, never change anything on the filesystem; default is false
177
- // * fileMode: optional, permissions used when creating new files, default is 0600. can be string or integer
178
- // * dirMode: optional, permissions used when creating new directories, default is 0700. can be string or integer
179
- const local = await mobiletto('local', '/home/ubuntu/tmp', null, {fileMode: 0o0600, dirMode: '0700'})
180
-
181
- // To use 's3' driver:
182
- // * key: AWS Access Key ID
183
- // * secret: AWS Secret Key
184
- // * opts object:
185
- // * readOnly: optional, never change anything on the bucket; default is false
186
- // * bucket: required, name of the S3 bucket
187
- // * region: optional, the AWS region to communicate with, default is us-east-1
188
- // * prefix: optional, all read/writes within the S3 bucket will be under this prefix
189
- // * delimiter: optional, directory delimiter, default is '/' (note: always '/' when encryption is enabled)
190
- const s3 = await mobiletto('s3', aws_key, aws_secret, {bucket: 'bk', region: 'us-east-1'})
191
-
192
- // To use 'b2' driver:
193
- // * key: Backblaze Key ID
194
- // * secret: Backblaze Application Key
195
- // * opts object:
196
- // * readOnly: optional, never change anything on the bucket; default is false
197
- // * bucket: required, the ID (**not the name**) of the B2 bucket
198
- // * prefix: optional, all read/writes within the B2 bucket will be under this prefix
199
- // * delimiter: optional, directory delimiter, default is '/' (note: always '/' when encryption is enabled)
200
- // * partSize: optional, large files will be split into chunks of this size when uploading
201
- const b3 = await mobiletto('b2', b2_key_id, b2_app_key, {bucket: 'bk', partSize: 10000000})
202
-
203
- // List files
204
- api.list() // --> returns an array of metadata objects
205
-
206
- // List files recursively
207
- api.list({ recursive: true })
208
-
209
- // List files in a directory
210
- const path = 'some/path'
211
- api.list(path)
212
- api.list(path, { recursive: true }) // also supports recursive flag
213
-
214
- // Visit files in a directory -- visitor function must be async
215
- api.list(path, { visitor: myAsyncFunc })
216
- api.list(path, { visitor: myAsyncFunc, recursive: true })
217
-
218
- // The `list` method throws MobilettoNotFoundError if the path does not exist
219
- // When you call `safeList` on a non-existent path, it returns an empty array
220
- api.safeList('/path/that/does/not/exist') // returns []
221
-
222
- // Read metadata for a file
223
- api.metadata(path) // returns metadata object
224
-
225
- // The `metadata` method throws MobilettoNotFoundError if the path does not exist
226
- // When you call `safeMetadata` on a non-existent path, it returns null
227
- api.safeMetadata('/tmp/does_not_exist') // returns null
228
-
229
- // Read a file
230
- // Provide a callback that writes the data someplace
231
- const callback = (chunk) => { ... write chunk somewhere ... }
232
- api.read(path, callback) // returns count of bytes read
233
-
234
- // Read an entire file at once
235
- const data = await api.readFile(path) // returns a byte Buffer of the file contents
236
-
237
- // Read an entire file at once
238
- // returns null if an exception would otherwise be thrown
239
- const bufferOrNull = await bucket.safeReadFile('some/path')
240
-
241
- // Write a file
242
- // Provide a generator function that yields chunks of data
243
- const generator = function* () {
244
- while ( ... more-data-to-return ... ) {
245
- data = ... load-data ...
246
- yield data
247
- }
248
- }
249
- local.api(path, generator) // returns count of bytes written
250
-
251
- // Write an entire file at once (convenience method)
252
- await api.writeFile(path, bufferOrString) // returns count of bytes written
253
-
254
- // Delete a file
255
- // Quiet param is optional (default false), when set errors will not be thrown if the path does not exist
256
- // Always returns a value or throws an error.
257
- // Return value may be a single string of the file removed, or an array of all files removed (driver-dependent)
258
- const quiet = true
259
- api.remove(path, {quiet}) // returns single path removed
260
-
261
- // Recursively delete a directory and do it quietly (do not report errors)
262
- const recursive = true
263
- const quiet = true
264
- api.remove(path, {recursive, quiet}) // returns array of paths removed
265
-
266
- ## Metadata
267
- Umurnin `metadata` yana dawo da metadata game da shigarwar tsarin fayil guda ɗaya.
268
- Hakazalika, ƙimar dawowa daga umurnin `list` jeri' jerin abubuwa ne na metadata.
269
-
270
- Abun metadata yayi kama da haka:
271
-
272
- {
273
- "name": "fully/qualified/path/to/file",
274
- "type": "entry-type",
275
- "size": size-in-bytes,
276
- "ctime": creation-time-epoch-millis,
277
- "mtime": modification-time-epoch-millis
278
- }
279
-
280
- Kayan `type` ' na iya zama `file` ' , `dir` , `link` , ko `special` .
281
-
282
- Dangane da nau'in direba, umarni `list` bazai dawo da duk filayen ba. Abubuwan `name` suna' da `type`
283
- ya kamata a kasance a koyaushe. Umurnin `metadata` na gaba zai dawo da duk kaddarorin da ke akwai.
284
-
285
- ## Madadin salon shigo da kaya
286
- Shigo da cikakken tsari kuma yi amfani da aikin `connect` :
287
-
288
- const storage = require('mobiletto')
289
- const opts = {bucket: 'bk', region: 'us-east-1'}
290
- const s3 = await storage.connect('s3', aws_key, aws_secret, opts)
291
- const objectData = await s3.readFile('some/path')
292
-
293
- ## Caching
294
- Mobiletto yana aiki mafi kyau tare da <a href="https://redis.io">redis</a> cache.
295
-
296
- Mobiletto zai yi ƙoƙarin haɗawa zuwa misalin redis akan 127.0.0.1:6379
297
-
298
- Kuna iya soke ɗaya daga cikin waɗannan:
299
- * Saita `MOBILETTO_REDIS_HOST` env var, mobiletto haɗi anan maimakon localhost
300
- * Saita `MOBILETTO_REDIS_PORT` env var, za a yi amfani da wannan tashar jiragen ruwa
301
-
302
- Mobiletto zai adana duk maɓallan redis tare da prefix `_mobiletto__` . Kuna iya canza wannan
303
- ta hanyar saita `MOBILETTO_REDIS_PREFIX` env var.
304
-
305
- Hakanan zaka iya saita caching ta hanyar haɗin kai tare da abun `opts.redisConfig` :
306
-
307
- const redisConfig = {
308
- enabled: true, // optional, default is true. if false other props are ignored
309
- host: '127.0.0.1',
310
- port: 6379,
311
- prefix: '_mobiletto__'
312
- }
313
- const opts = { redisConfig, bucket: 'bk', region: 'us-east-1' }
314
- const s3 = await storage.connect('s3', aws_key, aws_secret, opts)
315
-
316
- ### Ba kwa son redis caching?
317
- Don kashe: wuce `enabled: false` a cikin abun `opts.redisConfig` lokacin da kuka kafa haɗin ku.
318
-
319
- Kamar yadda aka tattauna a ƙasa, kashe caching zai yi mummunan tasiri akan aiki kuma ya haifar da ƙarin buƙatun
320
- zuwa ajiyar da kuke buƙatar gaske.
321
-
322
- ### Jagorar caching
323
- ** Rufaffen ma'auni ***: karantawa/rubutun rufaffen ma'ajin yana ɗan ɗan hankali fiye da na al'ada,
324
- amma kewaya cikin kundin adireshi (wanda wasu abubuwa suke yi) yana da tsada sosai. Amfani da redis cache
325
- zai ba ku gagarumin haɓaka aiki.
326
-
327
- Tsohuwar cache mai lafiya ne, amma baya aiki da kyau idan kuna da yawa na rubutu/cire ayyuka.
328
- Duk wani aiki na rubutu ko cirewa yana lalata duk cache ɗin, yana tabbatar da karantawa na gaba zai ga
329
- sabbin canje-canje.
330
-
331
- ### kayan aikin CLI
332
- Idan kana amfani da kayan aikin CLI kamar [mobiletto-cli](https://www.npmjs.com/package/mobiletto-cli),
333
- tabbas za ku so a kunna ma'ajin redis, saboda yana wucewa cikin `mo` .
334
-
335
- ## Mirroring
336
-
337
- // Copy a local filesystem mobiletto to S3
338
- s3.mirror(local)
339
-
340
- // Mirror a local subdirectory from one mobiletto to an S3 mobiletto, with it's own subdirectory
341
- local.mirror(s3, 'some/local-folder', 'some/s3-folder')
342
-
343
- `mirror` yana aiwatar da kwafin duk fayiloli na lokaci ɗaya daga wayar hannu zuwa wancan.
344
- Ba ya gudanar da kowane tsari don kula da madubi akan lokaci. sake gudanar da umurnin `mirror`
345
- don daidaita duk fayilolin da suka ɓace.
346
-
347
- Ƙimar dawowa daga `mirror` ne mai sauƙi tare da ƙididdiga don fayilolin nawa aka yi nasara
348
- madubi da fayiloli nawa ne suka sami kurakurai:
349
-
350
- {
351
- success: count-of-files-mirrored,
352
- errors: count-of-files-with-errors
353
- }
354
-
355
- GARGAƊI: Nuna manyan saitin bayanai na iya zama mai cin lokaci sosai kuma mai saurin bandwidth
356
-
357
- Tare da ma'anar kiran `mirror` wani lokaci yana iya zama da rudani don fahimtar wanene
358
- mai karatu kuma wanene marubuci. Ka yi tunanin shi kamar bayanin aiki: "mobiletto hannun hagu"
359
- shine abin da ake sanyawa (babban bayanan da aka rubuta), da kuma "mobiletto hannun dama" (da
360
- hujja ga hanyar `mirror` ) shine ƙimar da ake sanyawa (ana karanta bayanan madubi).
361
-
362
- ## boye boye boye
363
- Kunna ɓoyayyen ɓoyayyen abokin ciniki:
364
-
365
- // Pass encryption parameters
366
- const encryption = {
367
- // key is required, must be >= 16 chars
368
- key: randomstring.generate(128),
369
-
370
- // optional, the default is to derive IV from key
371
- // when set, IV must be >= 16 chars
372
- iv: randomstring.generate(128),
373
-
374
- // optional, the default is aes-256-cbc
375
- algo: 'aes-256-cbc'
376
- }
377
- const api = await mobiletto(driverName, key, secret, opts, encryption)
378
-
379
- // Subsequent write operations will encrypt data (client side) when writing
380
- // Subsequent read operations will decrypt data (client side) when reading
381
-
382
- Me ke faruwa? Wani keɓantaccen littafin "shigarwar kundin adireshi" (mai rufaffiyar) yana bin abin da fayiloli ke cikin wancan
383
- directory (wanda aka fi sani da directory).
384
- * `list` yana karanta fayilolin shigarwar kundin adireshi, yana lalata kowane hanyar da aka jera; sannan ya dawo da metadata ga kowane fayil
385
- * `list` sun fi rashin inganci, musamman ga kundin adireshi masu yawan fayiloli
386
- * `write` rubuta fayilolin da ba su dace ba a cikin kundin adireshi na kowane iyaye, akai-akai; sannan ya rubuta fayil din
387
- * `write` za su haifar da O(N) ya rubuta, tare da N = zurfin a cikin matsayi na shugabanci
388
- * Umurnin `remove` cire' yana cire babban fayil ɗin daidai, kuma iyayensa idan babu komai, akai-akai; sannan ya cire fayil din
389
- * `remove` za su haifar da karatun O(N) da yuwuwar sharewa da yawa, tare da N = zurfi a cikin tsarin shugabanci.
390
- * `remove` akan manyan fayilolin fayiloli masu zurfi na iya zama tsada
391
-
392
- Lura cewa ko da tare da ɓoyayyen ɓoyayyen abokin ciniki, abokin gaba mai cikakken gani a cikin ɓoyayyen uwar garken ku.
393
- 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
394
- wani yunƙuri, gano wasu ko duk tsarin gaba ɗaya na matsayi na shugabanci.
395
- *Lura: Yi amfani da siffa mai faɗi don ingantaccen tsaro.*
396
- Abokan gaba ba zai san sunayen kundayen adireshi/fayil ɗin ba sai dai idan sun san ɓoyewar ku
397
- maɓalli ko kuma an sami nasarar fashe ɓoyayyen ɓoyayyen. An kashe duk fare to!
398
-
399
- ### Aiki da caching
400
- Ayyuka akan ma'ajiyar rufaffiyar na iya zama a hankali. Lissafin maimaitawa da cirewa na iya zama a hankali.
401
- Caching ta hanyar redis yana taimakawa sosai, amma lura cewa cache ɗin yana goge akan kowane rubutu ko cirewa.
402
-
403
- ## Juyawa Maɓalli
404
- Ƙirƙiri wayar hannu tare da sabon maɓalli, sannan madubi tsohon bayanai a ciki:
405
-
406
- const storage = require('mobiletto')
407
-
408
- const oldEncryption = { key: .... }
409
- const oldStorage = await storage.connect('s3', aws_key, aws_secret, {bucket: 'bk', region: 'us-east-1'}, oldEncryption)
410
-
411
- const newEncryption = { key: .... }
412
- const newStorage = await storage.connect('s3', aws_key, aws_secret, {bucket: 'zz', region: 'us-east-1'}, newEncryption)
413
-
414
- newStorage.mirror(oldStorage) // if oldStorage is very large, this may take a looooooong time...
415
-
416
- ## Driver interface
417
- Direba shine kowane fayil na JS wanda ke fitar da aikin 'abokin ajiya' tare da wannan sa hannu:
418
-
419
- function storageClient (key, secret, opts)
420
-
421
- * `key` : kirtani, maɓallin API ɗinku (na direban `local` na gida' wannan shine tushen jagorar)
422
- * `secret` : kirtani, sirrin API ɗinku (ana iya barin direban `local` na gida')
423
- * `opts` : abu, kaddarorin kowane direba ne:
424
- * Don `local` na gida', kayan `fileMode` da `dirMode` ƙayyade yadda ake ƙirƙirar sabbin fayiloli da kundayen adireshi
425
- * Don `s3` , ana buƙatar kadarorin `bucket` . Kaddarorin na zaɓi sune:
426
- * `region`: the S3 region, default is us-east-1
427
- * `prefix`: a prefix to prepend to all S3 paths, default is the empty string
428
- * `delimiter`: the directory delimiter, default is '/'
429
-
430
- Abinda aikin Abokin ciniki ya dawo dashi dole ne ya ayyana waɗannan ayyuka:
431
-
432
- // Test the driver before using, ensure proper configuration
433
- async testConfig ()
434
-
435
- // List files in path (or from base-directory)
436
- // If recursive is true, list recursively
437
- // If visitor is defined, it will be an async function. await the visitor function on each file found
438
- // Otherwise, perform the listing and return an array of objects
439
- async list (path, recursive = false, visitor = null) // path may be omitted
440
-
441
- // Read metadata for a path
442
- async metadata (path)
443
-
444
- // Read a file
445
- // callback receives a chunk of data. endCallback is called at end-of-stream
446
- async read (path, callback, endCallback = null)
447
-
448
- // Write a file
449
- // driver must be able to handle a generator or a stream
450
- async write (path, generatorOrReadableStream)
451
-
452
- // Remove a file, or recursively delete a directory
453
- // returns a string of a single path removed, or an array of multiple paths removed
454
- async remove (path, recursive = false, quiet = false)
455
-
456
- ## Shiga
457
- Mobiletto yana amfani da ɗakin karatu na [winston](https://www.npmjs.com/package/winston).
458
-
459
- Logs **zai ƙunshi hanyoyin fayil da saƙonnin kuskure, amma ** ba zai taɓa ƙunshi maɓalli, sirri ba,
460
- ko duk wani bayanin haɗin kai.
461
-
462
- ### Matsayin shiga
463
- Yi amfani da madaidaicin mahallin `MOBILETTO_LOG_LEVEL` don saita matakin log, ta amfani da ɗaya
464
- na matakan `npm` da aka ayyana a [https://www.npmjs.com/package/winston#logging-levels](https://www.npmjs.com/package/winston#logging-levels)
465
-
466
- Matsayin tsoho shine `error` . Mafi girman matakin magana shine `silly` , kodayake a halin yanzu wayar hannu
467
- baya shiga a matakan da ke ƙasa `debug`
468
-
469
- MOBILETTO_LOG_LEVEL=silly # maximum logs!
470
-
471
- ### Shiga fayil
472
- Ta hanyar tsoho, mai shiga yana rubutawa ga na'ura mai kwakwalwa. Don aika rajistan ayyukan zuwa fayil, saita `MOBILETTO_LOG_FILE`
473
- m yanayi. Lokacin shiga fayil, ba za a ƙara rubuta rajistan ayyukan zuwa na'ura wasan bidiyo ba.
474
-
475
- MOBILETTO_LOG_FILE=/var/my_mobiletto_log
476
-
477
- Don kashe shiga:
478
-
479
- MOBILETTO_LOG_FILE=/dev/null
480
-
481
- </pre>