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-импорт стилі)
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
+ [🇮🇳 Maranthi](../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 осы мәселені шешуге арналған. Қолданбаңызды mobiletto API интерфейсіне кодтау арқылы сіз оңай жасай аласыз
77
+ сақтау провайдерлерін өзгертіңіз және қолданбаңыздың сақтау қабаты бірдей әрекет ететінін біліңіз.
78
+
79
+ ### Кең ауқымды тестілеу
80
+ Барлық драйверлер әр жүргізуші үшін 60-тан астам сынақпен бірдей мінез-құлыққа сыналады.
81
+ Біз барлық драйверлерді келесі комбинациялармен тексереміз:
82
+ * Шифрлау: қосылған және өшірілген
83
+ * Redis кэші: қосылған және өшірілген
84
+
85
+ Бұл тәсіл сізге қай драйверді пайдалансаңыз да, mobiletto бірдей әрекет ететініне тыныштық береді,
86
+ және кэштеуді және/немесе шифрлауды қосқаныңызға қарамастан.
87
+
88
+ ### Драйверге қолдау көрсету
89
+ Ағымдағы Mobiletto сақтау драйверлері:
90
+ * `s3` : Amazon S3
91
+ * `b2` : Backblaze 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
+ * [GitHub сайтындағы мобильді](https://github.com/cobbzilla/mobiletto)
103
+ * [mobiletto on 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 127.0.0.1:6379 нұсқасында redis данасына қосылуға әрекет жасайды.
271
+
272
+ Мыналардың кез келгенін қайта анықтауға болады:
273
+ * Localhost орнына осында қосылу үшін `MOBILETTO_REDIS_HOST` env var, mobilet орнатыңыз
274
+ * `MOBILETTO_REDIS_PORT` env var параметрін орнатыңыз, бұл порт пайдаланылады
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: false` ' мәнін өткізіңіз.
292
+
293
+ Төменде талқыланғандай, кэштеуді өшіру өнімділікке кері әсер етеді және көбірек сұрауларды тудырады
294
+ сізге шынымен қажет сақтау үшін.
295
+
296
+ ### Кэштеу бойынша нұсқаулық
297
+ **Шифрланған жад**: шифрланған жадты оқу/жазу қалыптыдан сәл ғана баяу,
298
+ бірақ каталогтарды шарлау (кейбір нәрселер жасайды) өте қымбат. Redis кэшін пайдалану
299
+ сізге айтарлықтай өнімділікті арттырады.
300
+
301
+ Әдепкі кэш қауіпсіз, бірақ жазу/жою әрекеттері көп болса, жақсы жұмыс істемейді.
302
+ Кез келген жазу немесе жою операциясы бүкіл кэшті жарамсыз етеді, бұл келесі оқулар көретінін қамтамасыз етеді
303
+ соңғы өзгерістер.
304
+
305
+ ### CLI құралдары
306
+ [mobiletto-cli](https://www.npmjs.com/package/mobiletto-cli) сияқты 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` пәрмені бір мобильді құрылғыдан екіншісіне барлық файлдардың бір реттік көшірмесін орындайды.
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
+ оқырман және жазушы кім. Мұны тапсырма туралы мәлімдеме сияқты елестетіп көріңіз: «сол жақ мобильді»
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
+ каталог (aka dirent каталогы).
358
+ * `list` пәрмені каталог енгізу файлдарын оқиды, тізімде көрсетілген әрбір жолдың шифрын шешеді; содан кейін әрбір файл үшін метадеректерді қайтарады
359
+ * `list` пәрмендері тиімсіз, әсіресе файлдар саны көп каталогтар үшін
360
+ * `write` пәрмені dirent файлдарды әрбір ата-ананың тікелей каталогына рекурсивті түрде жазады; содан кейін файлды жазады
361
+ * `write` пәрмендері каталог иерархиясында N = тереңдікпен O(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
+ Драйвер - бұл қолтаңбасы бар "storageClient" функциясын экспорттайтын кез келген JS файлы:
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
+ [https://www.npmjs.com/package/winston#logging-levels](https://www.npmjs.com/package/winston#logging-levels) ішінде анықталған `npm` деңгейлерінің
439
+
440
+ Әдепкі деңгей – `error` . Ең егжей-тегжейлі деңгей - бұл қазіргі уақытта `silly` болса да, «ақымақ».
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>