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 bụ oyi akwa abstraction nchekwa Javascript, nwere nhọrọ nzuzo nzuzo-n'akụkụ ndị ahịa.
5
+
6
+ # ọdịnaya
7
+ * [Gịnị kpatara Mobiletto?](#Gịnị kpatara-Mobiletto?)
8
+ * [Bido ngwa ngwa](#Bido ngwa ngwa)
9
+ * [Mobiletto CLI](#mobiletto-cli)
10
+ * [Isi Iyi](#Isi Iyi)
11
+ * [Ojiji isi](#Basic-usage)
12
+ * [Metadata](#Metadata)
13
+ * [Ụdị mbubata ọzọ](#Ọzọ-import-style)
14
+ * [Caching](#Caching)
15
+ * [Mirroring](#Ego)
16
+ * [Transparent encryption](#Transparent-encryption)
17
+ * [Igodo ntụgharị](#Igodo-ntụgharị)
18
+ * [Ntụgharị ọkwọ ụgbọ ala](#Driver-interface)
19
+ * [Ịbanye](#Ịbanye)
20
+
21
+ # Gụọ nke a n'asụsụ ọzọ
22
+ Atụgharịrị asụsụ README.md akwụkwọ a, site na [hokeylization](https://github.com/cobbzilla/hokeylization), ka ọ bụrụ
23
+ **[Google Translate na-akwado asụsụ ọ bụla](https://cloud.google.com/translate/docs/languages)!**
24
+
25
+ Eji m n'aka na ọ zughị oke, mana enwere m olileanya na ọ ka mma karịa ihe ọ bụla!
26
+
27
+ [🇸🇦 Arabic](../ar/README.md)
28
+ [🇧🇩 Bengali](../bn/README.md)
29
+ [🇩🇪 German](../de/README.md)
30
+ [🇺🇸 Bekee](../en/README.md)
31
+ [🇪🇸 Spanish](../es/README.md)
32
+ [🇫🇷 French](../fr/README.md)
33
+ [🇹🇩 Hausa](../ha/README.md)
34
+ [🇮🇳 Hindi](../hi/README.md)
35
+ [🇮🇩 Indonesian](../id/README.md)
36
+ [🇮🇹 Italian](../it/README.md)
37
+ [🇯🇵 Japanese](../ja/README.md)
38
+ [🇰🇷 Korean](../ko/README.md)
39
+ [🇮🇳 Maranthi](../mr/README.md)
40
+ [🇵🇱 Polish](../pl/README.md)
41
+ [🇧🇷 Portuguese](../pt/README.md)
42
+ [🇷🇺 Russian](../ru/README.md)
43
+ [🇰🇪 Swahili](../sw/README.md)
44
+ [🇵🇭 Tagalog](../tl/README.md)
45
+ [🇹🇷 Turkish](../tr/README.md)
46
+ [🇵🇰 Urdu](../ur/README.md)
47
+ [🇻🇳 Vietnamese](../vi/README.md)
48
+ [🇨🇳 Chinese](../zh/README.md)
49
+
50
+
51
+ **[📚 ... Asụsụ niile ...](../README.md)**
52
+ ----
53
+
54
+ ### Enwere nsogbu na ntụgharị asụsụ README a?
55
+ Ntụgharị asụsụ nke izizi [README](https://github.com/cobbzilla/mobiletto/blob/master/README.md)
56
+ nwere ike inwe ntụpọ -- * A nabatara mgbazi!* Biko ziga arịrịọ [pull arịrịọ na GitHub](https://github.com/cobbzilla/mobiletto/pulls),
57
+ ma ọ bụ ọ bụrụ na ahụ adịghị gị mma ime nke ahụ, [mepee mbipụta](https://github.com/cobbzilla/mobiletto/issues)
58
+
59
+ Mgbe ị mepụtara mbipụta GitHub ọhụrụ gbasara ntụgharị asụsụ, biko mee:
60
+ * tinye URL ibe (detuo / mado site na ebe adreesị ihe nchọgharị)
61
+ * tinye ederede ezighi ezi (detuo / mado site na ihe nchọgharị)
62
+ * biko kọwaa ihe adịghị mma -- ntụgharị asụsụ ezighi ezi? Agbajiri usoro nhazi ahụ n'ụzọ ụfọdụ?
63
+ * jiri obiọma nye ntụnye nke ntụgharị asụsụ ka mma, ma ọ bụ ka esi ahazi ederede nke ọma
64
+ * **Daalụ!**
65
+
66
+ ## Gịnị kpatara Mobiletto?
67
+
68
+ ### Mkpọchi onye na-ere ihe ọma!
69
+ Ndị na-eweta nchekwa igwe ojii dị iche iche nwere API na-adakọghị ọnụ. Ọbụna ndị na-agbalị maka "S3 ndakọrịta"
70
+ nwere àgwà nzuzu.
71
+
72
+ Mgbe ịhọrọ otu onye na-ere nchekwa maka ngwa gị, ọ bụrụ na ị tinye koodu ozugbo na API ha, ngwa gị
73
+ ugbu a dabere na ọrụ ahụ. Ka oge na-aga na koodu na-agbakọta, ndị na-ere ahịa na-agbanwe agbanwe na-aghọ
74
+ na-esiwanye ike. Nnọọ n'ime ụwa ihe ụtọ nke mkpọchi ndị na-ere ahịa!
75
+
76
+ Emebere Mobiletto iji dozie nsogbu a. Site na itinye koodu gị ngwa na mobiletto's API, ị nwere ike mfe
77
+ gbanwee ndị na-eweta nchekwa wee mara na oyi akwa nchekwa ngwa gị ga-eme otu ihe.
78
+
79
+ ### Nnwale sara mbara
80
+ A na-anwale ndị ọkwọ ụgbọ ala niile maka otu omume ahụ yana ule 60+ maka onye ọkwọ ụgbọ ala ọ bụla.
81
+ Anyị na-anwale ndị ọkwọ ụgbọala niile na ngwakọta ọ bụla:
82
+ * Izo ya ezo: ma enyere ma gbanyụọ
83
+ * Redis cache: enyere ma nwee nkwarụ
84
+
85
+ Usoro a na-enye anyị obi iru ala na mobiletto ga-eme otu ihe ahụ n'agbanyeghị onye ọkwọ ụgbọ ala ị na-eji,
86
+ na n'agbanyeghị ma ị na-enyere caching na/ma ọ bụ izo ya ezo.
87
+
88
+ ### Nkwado ọkwọ ụgbọ ala
89
+ Ndị ọkwọ ụgbọala nchekwa Mobiletto dị ugbu a:
90
+ * `s3` : Amazon S3
91
+ * `b2` : Backblaze B2
92
+ * `local` : sistemụ faịlụ mpaghara
93
+
94
+ * A na-anabata onyinye iji kwado ndị na-eweta nchekwa igwe ojii!*
95
+
96
+ ## mobiletto-cli
97
+ Ezubere Mobiletto ka ọ bụrụ ọba akwụkwọ site na koodu Javascript ndị ọzọ.
98
+
99
+ Iji rụọ ọrụ na mobiletto na ahịrị iwu, jiri [mobiletto-cli](https://www.npmjs.com/package/mobiletto-cli)
100
+
101
+ ## Isi mmalite
102
+ * [mobiletto na GitHub](https://github.com/cobbzilla/mobiletto)
103
+ * [mobiletto na npm](https://www.npmjs.com/package/mobiletto)
104
+
105
+ ## Mmalite ngwa ngwa
106
+ Ihe atụ dị mkpirikpi na-eji ọkwọ ụgbọala mobiletto `s3` .
107
+
108
+ Koodu a ga-eme otu ihe ahụ ma ọ bụrụ na ọkwọ ụgbọ ala bụ `b2` ma ọ bụ `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
+ ## Ihe eji eme ihe
139
+ Ọmụmaatụ sara mbara karị, na-egosi ọtụtụ atụmatụ enyere:
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
+ Iwu `metadata` na-eweghachi metadata gbasara otu ntinye sistemụ faịlụ.
242
+ N'otu aka ahụ, uru nloghachi sitere na iwu `list` bụ ọtụtụ ihe metadata.
243
+
244
+ Ihe metadata dị ka nke a:
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
+ Ụdị `type` nwere ike ịbụ `file` ' , `dir` , `link` , ma ọ bụ `special` .
255
+
256
+ Dabere n'ụdị ọkwọ ụgbọ ala, iwu `list` nwere ike ọ gaghị eweghachi mpaghara niile. Njirimara `name` ' na `type`
257
+ kwesịrị ịdị mgbe niile. Iwu `metadata` na-esote ga-eweghachite akụrụngwa niile dị.
258
+
259
+ ## Ụdị mbubata ọzọ
260
+ Bubata modul zuru oke wee jiri ọrụ `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 na-arụ ọrụ kacha mma na <a href="https://redis.io">redis</a> cache.
269
+
270
+ Mobiletto ga-anwa ijikọ na ihe atụ redis na 127.0.0.1:6379
271
+
272
+ Ị nwere ike ịkwụsị nke ọ bụla n'ime ndị a:
273
+ * Tọọ `MOBILETTO_REDIS_HOST` env var, mobiletto jikọọ ebe a kama localhost
274
+ * Tọọ `MOBILETTO_REDIS_PORT` env var, ọdụ ụgbọ mmiri a ga-eji
275
+
276
+ Mobiletto ga-eji prefix `_mobiletto__` igodo redis ya niile. Ị nwere ike ịgbanwe nke a
277
+ site na ịtọ `MOBILETTO_REDIS_PREFIX` env var.
278
+
279
+ Ị nwekwara ike iji ihe `opts.redisConfig` caching njikọ ọ bụla:
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
+ ### Ịchọghị caching redis?
291
+ Iji gbanyụọ: nyefee `enabled: false` ' n'ime ihe `opts.redisConfig` gị mgbe ị mebere njikọ gị.
292
+
293
+ Dị ka a tụlere n'okpuru, ịkwụsị caching ga-enwe mmetụta ọjọọ na arụmọrụ ma weta arịrịọ ndị ọzọ
294
+ na nchekwa nke ị chọrọ n'ezie.
295
+
296
+ ### ntụzịaka caching
297
+ ** Nchekwa ezoro ezo ***: ịgụ / ide nchekwa ezoro ezo bụ naanị ntakịrị nwayọ karịa ka ọ dị,
298
+ mana ịgagharị gburugburu akwụkwọ ndekọ aha (nke ụfọdụ ihe na-eme) dị oke ọnụ. Iji redis cache
299
+ ga-enye gị nkwalite arụmọrụ dị ịrịba ama.
300
+
301
+ Cache ndabara adịghị mma, mana ọ naghị arụ ọrụ nke ọma ma ọ bụrụ na ị nwere ọtụtụ ọrụ ide/wepụ.
302
+ Edemede ma ọ bụ wepu ọrụ ọ bụla na-emebi cache niile, na-ahụ na agụ ga-esochi ga-ahụ ya
303
+ ọhụrụ mgbanwe.
304
+
305
+ ### Ngwa CLI
306
+ Ọ bụrụ na ị na-eji ngwa CLI dị ka [mobiletto-cli](https://www.npmjs.com/package/mobiletto-cli),
307
+ ị ga-achọ ka agbanyere cache redis, ebe ọ na-aga n'ofe arịrịọ nke iwu `mo` .
308
+
309
+ ## Ngosipụta
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
+ Iwu `mirror` na-arụ otu oge faịlụ niile site na otu mobiletto gaa na nke ọzọ.
318
+ Ọ naghị agba usoro ọ bụla iji nọgide na-enyo enyo ka oge na-aga. Gbaa iwu `mirror` ọzọ
319
+ imekọrịta faịlụ ọ bụla na-efu.
320
+
321
+ Uru nloghachi sitere na `mirror` bụ ihe dị mfe nwere ọnụọgụ maka faịlụ ole emere nke ọma
322
+ enyo enyo na faịlụ ole nwere mperi:
323
+
324
+ {
325
+ success: count-of-files-mirrored,
326
+ errors: count-of-files-with-errors
327
+ }
328
+
329
+ ỊDỌ AKA NA NTỊ: Igosipụta nnukwu data tent nwere ike na-ewe oge na bandwit-akpa ike
330
+
331
+ Site na semantics oku `mirror` ọ nwere ike bụrụ ihe mgbagwoju anya mgbe ụfọdụ ịghọta onye bụ
332
+ onye na-agụ na onye bụ onye edemede. Were ya dị ka nkwupụta ọrụ: "mobiletto aka ekpe"
333
+ bụ ihe a na-ekenye na (ederede enyo enyo), yana "mobiletto aka nri" (the
334
+ arụmụka na usoro `mirror` ) bụ uru a na-ekenye (a na-agụ data enyo).
335
+
336
+ ## nzuzo nzuzo
337
+ Kwado ihe nzuzo n'akụkụ ndị ahịa nke ọma:
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
+ Kedu nke na-eme? Akwụkwọ ndekọ aha "ntinye ndekọ" dị iche (ezoro ezo) na-esochi ihe faịlụ dị na nke ahụ
357
+ akwụkwọ ndekọ aha (aka nke dient directory).
358
+ * Iwu `list` na-agụ faịlụ ntinye akwụkwọ ndekọ aha, mebie ụzọ ọ bụla edepụtara; wee weghachi metadata maka faịlụ ọ bụla
359
+ * `list` adịghị arụ ọrụ nke ọma, ọkachasị maka akwụkwọ ndekọ aha nwere nnukwu faịlụ
360
+ * Iwu `write` dere' na-ede faịlụ dị iche iche na ndekọ ndekọ aha nne na nna ọ bụla, na-emegharị ugboro ugboro; wee dee faịlụ ahụ
361
+ `write` ga-ebute O(N) dere, yana N = omimi n'ime usoro ndekọ aha.
362
+ * Iwu `remove` na-ewepu faịlụ dient kwekọrọ, yana nne na nna ya ọ bụrụ na ọ tọgbọrọ chakoo, na-emegharị ugboro ugboro; wee wepụ faịlụ ahụ
363
+ * Iwu `remove` na-anaghị emegharị emegharị ga-ebute O(N) agụ yana nwee ike ihichapụ, yana N = omimi n'ime usoro ndekọ aha.
364
+ * `remove` na-emegharị na sistemụ faịlụ buru ibu ma dị omimi nwere ike ịdị ọnụ
365
+
366
+ Rịba ama na ọbụlagodi na-enyere onye ahịa aka izo ya ezo, onye mmegide nwere ọhụhụ zuru oke n'ime akụkụ sava gị ezoro ezo.
367
+ nchekwa, ọbụlagodi na-enweghị igodo, ka nwere ike ịhụ ọnụọgụ akwụkwọ ndekọ aha na faịlụ ole dị na nke ọ bụla, yana ya
368
+ mgbalị ụfọdụ, chọpụta ụfọdụ ma ọ bụ ihe niile n'ozuzu nhazi nke usoro ndekọ aha.
369
+ *Rịba ama: Jiri usoro dị larịị maka nchekwa ka mma.*
370
+ Onye mmegide ahụ agaghị ama aha akwụkwọ ndekọ aha/faịlụ ma ọ bụrụ na ha makwara izo ya ezo
371
+ igodo ma ọ bụ ma ọ bụghị nke ọma gbawara ezoro ezo. Nzọ niile apụọla mgbe ahụ!
372
+
373
+ ### Arụmọrụ na caching
374
+ Ọrụ na nchekwa ezoro ezo nwere ike ịdị nwayọ. Ndepụta ndetu na mwepụ nwere ike ịdị ngwa ngwa.
375
+ Caching site na redis na-enyere aka nke ukwuu, mana rịba ama na ebe nchekwa ahụ na-agbanye na ihe ọ bụla edere ma ọ bụ wepụ ya.
376
+
377
+ ## ntụgharị igodo
378
+ Jiri igodo ọhụrụ gị mepụta mobiletto, wee gosipụta data ochie n'ime ya:
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 ọkwọ ụgbọ ala
391
+ Onye ọkwọ ụgbọ ala bụ faịlụ JS ọ bụla na-ebupụ ọrụ 'storageClient' na mbinye aka a:
392
+
393
+ function storageClient (key, secret, opts)
394
+
395
+ * `key` : eriri, igodo API gị (maka onye ọkwọ ụgbọ ala `local` nke a bụ ndekọ ntọala)
396
+ * `secret` : eriri, nzuzo API gị (enwere ike ịhapụ maka ọkwọ ụgbọ ala `local` mpaghara')
397
+ * `opts` : ihe, akụrụngwa bụ onye ọkwọ ụgbọ ala:
398
+ * Maka `local` , njirimara `fileMode` na `dirMode` na-ekpebi ka esi emepụta faịlụ na akwụkwọ ndekọ aha ọhụrụ.
399
+ * Maka `s3` , a chọrọ `bucket` . Njirimara nhọrọ bụ:
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
+ Ihe nchekwa ọrụ onye ahịa ga-eweghachi ga-akọwapụta ọrụ ndị a:
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
+ ## Ịbanye
431
+ Mobiletto na-eji ọba akwụkwọ ndekọ [winston](https://www.npmjs.com/package/winston).
432
+
433
+ Ndekọ ** ga-enwe ụzọ faịlụ na ozi njehie, mana agaghị enwe igodo, nzuzo,
434
+ ma ọ bụ ozi nhazi njikọ ọ bụla ọzọ.
435
+
436
+ ### ndekọ ọkwa
437
+ Jiri mgbanwe gburugburu `MOBILETTO_LOG_LEVEL` ka ịtọọ ọkwa ndekọ, na-eji otu
438
+ nke `npm` ọkwa akọwapụtara na [https://www.npmjs.com/package/winston#logging-levels](https://www.npmjs.com/package/winston#logging-levels)
439
+
440
+ Ọkwa ndabara bụ `error` . Ọkwa kacha ekwu okwu bụ `silly` , ọ bụ ezie na ugbu a mobiletto
441
+ adịghị abanye n'ọkwa dị n'okpuru `debug`
442
+
443
+ MOBILETTO_LOG_LEVEL=silly # maximum logs!
444
+
445
+ ### Tinye faịlụ
446
+ Site na ndabara, onye na-edebanye aha na-edegara console. Iji zipu ndekọ na faịlụ, tọọ `MOBILETTO_LOG_FILE`
447
+ mgbanwe gburugburu ebe obibi. Mgbe ị na-abanye na faịlụ, agaghịzi ede ndekọ na njikwa.
448
+
449
+ MOBILETTO_LOG_FILE=/var/my_mobiletto_log
450
+
451
+ Iji gbanyụọ osisi:
452
+
453
+ MOBILETTO_LOG_FILE=/dev/null
454
+
455
+ </pre>