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 як қабати абстраксияи нигаҳдории JavaScript мебошад, ки бо рамзгузории ихтиёрии шаффофи муштарӣ.
5
+
6
+ # Мундариҷа
7
+ * [Чаро Mobiletto?](#Why-Mobiletto?)
8
+ * [Оғози зуд](#Оғози зуд)
9
+ * [Mobiletto CLI](#mobiletto-cli)
10
+ * [Манбаъ](#Манбаъ)
11
+ * [Истифодаи асосӣ](#Истифодаи асосӣ)
12
+ * [Метамаълумот](#Метамаълумот)
13
+ * [Услуби воридоти алтернативӣ](#Alternate-import-style)
14
+ * [Кэшкунӣ](#Кэшкунӣ)
15
+ * [Оинакунӣ](#Оинакунӣ)
16
+ * [Рамзгузории шаффоф](#Шаффоф-рамзгузорӣ)
17
+ * [Ратсияи калид](#Калиди гардиш)
18
+ * [Интерфейси ронанда](#Драйвер-интерфейс)
19
+ * [Рӯйхатгирӣ](#Ҷорҷӯӣ)
20
+
21
+ # Инро ба забони дигар хонед
22
+ Ин ҳуҷҷати README.md тавассути [hokeylization](https://github.com/cobbzilla/hokeylization) ба забони тарҷума шудааст
23
+ **[ҳар забоне, ки аз ҷониби Google Translate дастгирӣ мешавад](https://cloud.google.com/translate/docs/languages)!**
24
+
25
+ Ман итминон дорам, ки ин комил нест, аммо ман умедворам, ки он аз ҳеҷ чиз беҳтар аст!
26
+
27
+ [🇸🇦 Арабӣ](../ar/README.md)
28
+ [🇧🇩 Бенгалӣ](../bn/README.md)
29
+ [🇩🇪 Олмон](../de/README.md)
30
+ [🇺🇸 англисӣ](../en/README.md)
31
+ [🇪🇸 испанӣ](../es/README.md)
32
+ [🇫🇷 Фаронса](../fr/README.md)
33
+ [🇹🇩 Hausa](../ha/README.md)
34
+ [🇮🇳 Ҳиндӣ](../hi/README.md)
35
+ [🇮🇩 Индонезия](../id/README.md)
36
+ [🇮🇹 Италия](../it/README.md)
37
+ [🇯🇵 Ҷопон](../ja/README.md)
38
+ [🇰🇷 Кореяи](../ko/README.md)
39
+ [🇮🇳 Марантӣ](../mr/README.md)
40
+ [🇵🇱 Лаҳистон](../pl/README.md)
41
+ [🇧🇷 португалӣ](../pt/README.md)
42
+ [🇷🇺 русӣ](../ru/README.md)
43
+ [🇰🇪 Суахили](../sw/README.md)
44
+ [🇵🇭 Тагалогӣ](../tl/README.md)
45
+ [🇹🇷 Туркӣ](../tr/README.md)
46
+ [🇵🇰 урду](../ur/README.md)
47
+ [🇻🇳 Ветнамӣ](../vi/README.md)
48
+ [🇨🇳 Чин](../zh/README.md)
49
+
50
+
51
+ **[📚 ... Ҳама забонҳо ...](../README.md)**
52
+ ----
53
+
54
+ ### Оё бо ин тарҷумаи README мушкилот вуҷуд дорад?
55
+ Ин тарҷумаи махсуси аслии [README](https://github.com/cobbzilla/mobiletto/blob/master/README.md)
56
+ метавонад хато бошад -- *ислоҳот хеле хуш омадед!* Лутфан [дархости кашидан дар GitHub](https://github.com/cobbzilla/mobiletto/pulls) фиристед.
57
+ ё агар шумо ин корро бароҳат надоред, [як масъаларо кушоед](https://github.com/cobbzilla/mobiletto/issues)
58
+
59
+ Вақте ки шумо дар бораи тарҷума масъалаи нави GitHub эҷод мекунед, лутфан амал кунед:
60
+ * URL-и саҳифаро дохил кунед (аз сатри суроғаҳои браузер нусхабардорӣ/часбонед)
61
+ * матни дақиқи нодурустро дохил кунед (аз браузер нусхабардорӣ/часбонед)
62
+ * лутфан шарҳ диҳед, ки чӣ хато аст -- тарҷума нодуруст аст? оё форматкунӣ ягон хел вайрон шудааст?
63
+ * лутфан пешниҳод кунед, ки тарҷумаи беҳтар ё чӣ гуна матн бояд дуруст формат карда шавад
64
+ * **Сипос!**
65
+
66
+ ## Чаро Mobiletto?
67
+
68
+ ### Хайр, фурӯшанда баста!
69
+ Провайдерҳои гуногуни нигаҳдории абр API-ҳои номувофиқ доранд. Ҳатто онҳое, ки барои "мутобиқати S3" мекӯшанд
70
+ рафтору кирдори хоса доранд.
71
+
72
+ Вақте ки шумо як фурӯшандаи махсуси нигаҳдории барномаро интихоб мекунед, агар шумо бевосита ба API-и онҳо рамзгузорӣ кунед, барномаи шумо
73
+ ҳоло ба он хидмат вобаста аст. Вақте ки вақт мегузарад ва код ҷамъ мешавад, фурӯшандагон иваз мешаванд
74
+ беш аз пеш нотавон аст. Хуш омадед ба ҷаҳони фароғатии бастабандии фурӯшанда!
75
+
76
+ Mobiletto барои ҳалли ин мушкилот тарҳрезӣ шудааст. Бо рамзгузории барномаи худ ба API-и mobiletto, шумо метавонед ба осонӣ
77
+ провайдерҳои анборро иваз кунед ва бидонед, ки қабати нигаҳдории барномаи шумо якхела рафтор хоҳад кард.
78
+
79
+ ### Санҷиши васеъ
80
+ Ҳама ронандагон барои рафтори якхела бо 60+ санҷиш барои ҳар як ронанда санҷида мешаванд.
81
+ Мо ҳамаи ронандагонро бо ҳар як комбинатсияи:
82
+ * Рамзгузорӣ: ҳам фаъол ва ҳам ғайрифаъол
83
+ * Кэши Redis: ҳам фаъол ва ҳам ғайрифаъол
84
+
85
+ Ин равиш ба мо оромиро медиҳад, ки mobiletto новобаста аз он ки шумо кадом ронандаро истифода мебаред, ҳамон рафтор хоҳад кард.
86
+ ва новобаста аз он ки шумо кэш ва/ё рамзгузориро фаъол мекунед.
87
+
88
+ ### Дастгирии ронанда
89
+ Драйверҳои ҷории нигаҳдории Mobiletto:
90
+ * `s3` : Amazon S3
91
+ * `b2` : Барқарор B2
92
+ * `local` : системаи файлии маҳаллӣ
93
+
94
+ *Ҳиссагузориҳо барои дастгирии провайдерҳои нигаҳдории абрӣ хеле хуш омадед!*
95
+
96
+ ## mobiletto-cli
97
+ Mobiletto пешбинӣ шудааст, ки ҳамчун китобхона бо дигар кодҳои JavaScript истифода шавад.
98
+
99
+ Барои кор бо mobiletto дар сатри фармон, истифода баред [mobiletto-cli](https://www.npmjs.com/package/mobiletto-cli)
100
+
101
+ ## Сарчашма
102
+ * [mobiletto дар GitHub](https://github.com/cobbzilla/mobiletto)
103
+ * [mobiletto дар npm](https://www.npmjs.com/package/mobiletto)
104
+
105
+ ## Оғози зуд
106
+ Намунаи кӯтоҳ бо истифода аз драйвери mobiletto `s3` .
107
+
108
+ Агар драйвер `b2` ё `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
+ ## Истифодаи асосӣ
139
+ Мисоли хеле васеътар, ки аксари хусусиятҳои пешниҳодшударо нишон медиҳад:
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
+ ## Метамаълумот
241
+ Фармони `metadata` метамаълумотро дар бораи як вуруди системаи файлӣ бармегардонад.
242
+ Ба ҳамин монанд, арзиши баргардонидани фармони `list` массиви объектҳои метамаълумот аст.
243
+
244
+ Объекти метамаълумот чунин менамояд:
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
+ Амволи `type` метавонад `file` ", `dir` ", `link` ё `special` .
255
+
256
+ Вобаста аз намуди драйвер, фармони `list` метавонад на ҳама майдонҳоро баргардонад. Хусусиятҳои `name` ва `type`
257
+ бояд ҳамеша ҳузур дошта бошад. Фармони минбаъдаи `metadata` ҳамаи хосиятҳои дастрасро бармегардонад.
258
+
259
+ ## Услуби алтернативии воридот
260
+ Модули мукаммалро ворид кунед ва функсияи `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
+ ## Кэш
268
+ Mobiletto бо кэши <a href="https://redis.io">redis</a> беҳтарин кор мекунад.
269
+
270
+ Mobiletto кӯшиш мекунад, ки ба як нусхаи redis дар 127.0.0.1:6379 пайваст шавад
271
+
272
+ Шумо метавонед яке аз инҳоро бекор кунед:
273
+ * Env var `MOBILETTO_REDIS_HOST` -ро насб кунед, барои пайваст шудан ба ин ҷо ба ҷои localhost
274
+ * Env var `MOBILETTO_REDIS_PORT` -ро танзим кунед, ин порт истифода мешавад
275
+
276
+ Mobiletto ҳамаи калидҳои redis-и худро бо префикси `_mobiletto__` . Шумо метавонед инро тағир диҳед
277
+ бо гузоштани `MOBILETTO_REDIS_PREFIX` env var.
278
+
279
+ Шумо инчунин метавонед кэшкунии ҳар як пайвастшавиро бо объекти `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
+ ### Оё кэшкунии дубораро намехоҳед?
291
+ Барои хомӯш кардан: ҳангоми барқарор кардани пайвастшавӣ дар объекти `opts.redisConfig` -и худ 'enabled `enabled: false` ' -ро гузаронед.
292
+
293
+ Тавре ки дар зер баррасӣ шуд, ғайрифаъол кардани кэш ба кор таъсири манфӣ мерасонад ва дархостҳои бештарро ба бор меорад
294
+ ба нигоҳдорӣ, ки ба шумо воқеан лозим аст.
295
+
296
+ ### Роҳнамои кэш
297
+ **Захираи рамзгузоришуда**: хондан/навиштани нигаҳдории рамзгузоришуда аз муқаррарӣ каме сусттар аст,
298
+ аммо паймоиш дар атрофи директорияҳо (ки баъзе чизҳо мекунанд) хеле гарон аст. Истифодаи кэши redis
299
+ ба шумо афзоиши назарраси иҷроиш медиҳад.
300
+
301
+ Кэши пешфарз бехатар аст, аммо агар шумо амалиёти зиёди навиштан/нест кардан дошта бошед, хуб кор намекунад.
302
+ Ҳама гуна амалиёти навиштан ё хориҷ кардан тамоми кэшро беэътибор мегардонад ва мутмаин аст, ки хонданҳои минбаъда
303
+ тағйироти охирин.
304
+
305
+ ### Воситаҳои CLI
306
+ Агар шумо асбоби CLI-ро истифода баред, ба монанди [mobiletto-cli](https://www.npmjs.com/package/mobiletto-cli),
307
+ шумо бешубҳа хоҳед, ки кэши redis фаъол карда шавад, зеро он дар тамоми даъватҳои фармони `mo` давом мекунад.
308
+
309
+ ## Зеркашӣ
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` нусхаи якдафъаинаи ҳамаи файлҳоро аз як mobiletto ба дигараш иҷро мекунад.
318
+ Он ягон равандро барои нигоҳ доштани оина бо мурури замон иҷро намекунад. Фармони `mirror` дубора иҷро кунед
319
+ барои ҳамоҳангсозии ҳама файлҳои гумшуда.
320
+
321
+ Қимати баргардонидани `mirror` як объекти оддӣ бо ҳисобкунакҳо барои бомуваффақият будани чанд файл мебошад
322
+ оинашуда ва чанд файл хатогӣ дошт:
323
+
324
+ {
325
+ success: count-of-files-mirrored,
326
+ errors: count-of-files-with-errors
327
+ }
328
+
329
+ ОГОҲ: Зеркашӣ кардани маҷмӯаҳои бузурги додаҳо метавонад хеле вақт ва фарохмаҷро талаб кунад
330
+
331
+ Бо семантикаи занги `mirror` баъзан фаҳмидани кист, метавонад печида бошад
332
+ хонанда ва нависанда кист. Онро ҳамчун як изҳороти супориш тасаввур кунед: "mobiletto дасти чап"
333
+ он чизест, ки ба он таъин карда мешавад (маълумоти оинашуда навишта шудааст) ва "mobiletto-дасти рост" (
334
+ аргумент ба усули `mirror` ) арзиши таъиншуда аст (маълумоти оина хонда мешавад).
335
+
336
+ ## Рамзгузории шаффоф
337
+ Рамзгузории шаффофи муштариро фаъол созед:
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
+ Чӣ мегузарад? Феҳристи алоҳидаи "дохили феҳрист" (дирентӣ) (рамзгузорӣ) пайгирӣ мекунад, ки дар он кадом файлҳо мавҷуданд
357
+ директория (ака директорияи dirent).
358
+ * Фармони `list` файлҳои вуруди феҳристҳоро мехонад, ҳар як роҳи рӯйхатшударо рамзкушо мекунад; баъд метамаълумотро барои ҳар як файл бармегардонад
359
+ * Фармонҳои `list` , махсусан барои директорияҳои дорои шумораи зиёди файлҳо
360
+ * Фармони `write` ҳар як волидайн ба таври рекурсивӣ менависад; баъд файлро менависад
361
+ * Фармонҳои `write` O(N) -ро дар бар мегиранд, бо N = амиқ дар иерархияи директория
362
+ * Фармони `remove` файли мувофиқро нест мекунад ва волидайни онро агар холӣ бошад, ба таври рекурсивӣ нест мекунад; баъд файлро нест мекунад
363
+ * Фармонҳои `remove` O(N) ва эҳтимолан ҳамон қадар ҳазф мешаванд, бо N = амиқ дар иерархияи директория
364
+ * Фармонҳои `remove` дар системаҳои файлии калон ва амиқ метавонанд гарон бошанд
365
+
366
+ Дар хотир доред, ки ҳатто ҳангоми фаъол кардани рамзгузории муштарӣ, рақиб бо дидани пурраи сервери рамзгузоришудаи шумо
367
+ нигоҳдорӣ, ҳатто бе калид, то ҳол метавонад шумораи умумии директорияҳо ва чанд файл дар ҳар як ва бо дидани
368
+ баъзе кӯшишҳо, кашф баъзе ё ҳамаи сохтори умумии иерархияи директория.
369
+ *Эзоҳ: Барои бехатарии беҳтар сохтори нисбатан ҳамворро истифода баред.*
370
+ Рақиб номи директорияҳо/файлҳоро намедонад, агар онҳо рамзгузории шуморо низ надонанд
371
+ калид ё ба таври дигар рамзкунониро бомуваффақият шикаста буд. Пас ҳама шартгузориҳо хомӯш мешаванд!
372
+
373
+ ### Иҷро ва кэш
374
+ Амалиёт дар нигаҳдории рамзгузорӣ метавонад суст бошад. Рӯйхатҳои рекурсивӣ ва хориҷкунӣ метавонанд хеле суст бошанд.
375
+ Кэшкунӣ тавассути redis хеле кӯмак мекунад, аммо қайд кунед, ки кэш ҳангоми навиштан ё нест кардан тоза карда мешавад.
376
+
377
+ ## Гардиши калид
378
+ Бо калиди нави худ як mobiletto эҷод кунед ва маълумоти кӯҳнаро дар он инъикос кунед:
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
+ ## Интерфейси ронанда
391
+ Драйвер ҳама гуна файли JS мебошад, ки функсияи 'storageClient'-ро бо ин имзо содир мекунад:
392
+
393
+ function storageClient (key, secret, opts)
394
+
395
+ * `key` : сатр, калиди API-и шумо (барои драйвери `local` ин феҳристи асосӣ аст)
396
+ * `secret` : сатр, сирри API-и шумо (метавонад барои драйвери `local` сарфи назар карда шавад)
397
+ * `opts` : объект, хосиятҳо барои як драйвер мебошанд:
398
+ * Барои `local` " хосиятҳои `fileMode` " ва `dirMode` муайян мекунанд, ки чӣ гуна файлҳо ва директорияҳои нав эҷод карда мешаванд
399
+ * Барои `s3` , хосияти `bucket` лозим аст. Хусусиятҳои ихтиёрӣ инҳоянд:
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
+ Объекте, ки функсияи storageClient бармегардонад, бояд ин вазифаҳоро муайян кунад:
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
+ ## Сабзавот
431
+ Mobiletto китобхонаи сабти [winston](https://www.npmjs.com/package/winston) -ро истифода мебарад.
432
+
433
+ Гузоришҳо ** дорои роҳҳои файл ва паёмҳои хатогӣ мебошанд, аммо ** ҳеҷ гоҳ ** калидҳо, асрорҳо,
434
+ ё ягон маълумоти дигари конфигуратсияи пайвастшавӣ.
435
+
436
+ ### Сатҳи сабт
437
+ Барои танзим кардани сатҳи гузориш бо истифода аз як тағирёбандаи муҳити `MOBILETTO_LOG_LEVEL` -ро истифода баред
438
+ сатҳҳои `npm` дар [https://www.npmjs.com/package/winston#logging-levels](https://www.npmjs.com/package/winston#logging-levels) муайян карда шудаанд.
439
+
440
+ Сатҳи пешфарз `error` аст. Сатҳи аз ҳама муфассалтар `silly` аст, гарчанде ки дар айни замон mobiletto
441
+ дар сатҳҳои зери `debug`
442
+
443
+ MOBILETTO_LOG_LEVEL=silly # maximum logs!
444
+
445
+ ### Файли сабт
446
+ Бо нобаёнӣ, сабткунанда ба консол менависад. Барои фиристодани гузоришҳо ба файл, `MOBILETTO_LOG_FILE` -ро танзим кунед
447
+ тағйирёбандаи муҳити зист. Ҳангоми ворид шудан ба файл, гузоришҳо дигар ба консол навишта намешаванд.
448
+
449
+ MOBILETTO_LOG_FILE=/var/my_mobiletto_log
450
+
451
+ Барои хомӯш кардани сабт:
452
+
453
+ MOBILETTO_LOG_FILE=/dev/null
454
+
455
+ </pre>