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/kk/README.md DELETED
@@ -1,481 +0,0 @@
1
- Mobiletto
2
- =========
3
-
4
- Mobiletto – қосымша мөлдір клиенттік шифрлауы бар JavaScript сақтау абстракциялық қабаты.
5
-
6
- # Мазмұны
7
- * [Неге Mobiletto?](#Why-Mobiletto?)
8
- * [Жылдам бастау](#Жылдам бастау)
9
- * [Mobiletto CLI](#mobiletto-cli)
10
- * [Дереккөз](#Дереккөз)
11
- * [Орнату](#Орнату)
12
- * [Қолдау және қаржыландыру](#Қолдау және қаржыландыру)
13
- * [Негізгі қолдану](#Негізгі қолдану)
14
- * [Метадеректер](#Метадеректер)
15
- * [Баламалы импорт стилі](#Alternate-импорт стилі)
16
- * [Кэштеу](#Кэштеу)
17
- * [Айналау](#Айна)
18
- * [Мөлдір шифрлау](#Мөлдір-шифрлау)
19
- * [Кілттерді айналдыру](#Кілттерді айналдыру)
20
- * [Драйвер интерфейсі](#Драйвер интерфейсі)
21
- * [Журнау](#Журнау)
22
-
23
- # Мұны басқа тілде оқыңыз
24
- Бұл README.md құжаты [hokeylization](https://github.com/cobbzilla/hokeylization) арқылы аударылған.
25
- **[Google Translate қолдайтын барлық тіл](https://cloud.google.com/translate/docs/languages)!**
26
-
27
- Мен бұл мінсіз емес екеніне сенімдімін, бірақ бұл жоқтан жақсы деп үміттенемін!
28
-
29
- [🇸🇦 араб](../ar/README.md)
30
- [🇧🇩 Бенгал](../bn/README.md)
31
- [🇩🇪 неміс тілі](../de/README.md)
32
- [🇺🇸 Ағылшын тілі](../en/README.md)
33
- [🇪🇸 испан](../es/README.md)
34
- [🇫🇷 Француз](../fr/README.md)
35
- [🇹🇩 Hausa](../ha/README.md)
36
- [🇮🇳 хинди](../hi/README.md)
37
- [🇮🇩 Индонезия](../id/README.md)
38
- [🇮🇹 Итальяндық](../it/README.md)
39
- [🇯🇵 жапон](../ja/README.md)
40
- [🇰🇷 Корей тілі](../ko/README.md)
41
- [🇮🇳 Marathi](../mr/README.md)
42
- [🇵🇱 Поляк](../pl/README.md)
43
- [🇧🇷 Португалша](../pt/README.md)
44
- [🇷🇺 Орысша](../ru/README.md)
45
- [🇰🇪 суахили](../sw/README.md)
46
- [🇵🇭 Тагалог](../tl/README.md)
47
- [🇹🇷 Түрікше](../tr/README.md)
48
- [🇵🇰 урду](../ur/README.md)
49
- [🇻🇳 вьетнамдық](../vi/README.md)
50
- [🇨🇳 Қытай](../zh/README.md)
51
-
52
-
53
- **[📚 ... Барлық тілдер ...](../README.md)**
54
- ----
55
-
56
- ### README аудармасында ақау бар ма?
57
- Түпнұсқаның бұл нақты аудармасы [README](https://github.com/cobbzilla/mobiletto/blob/master/README.md)
58
- ақаулы болуы мүмкін -- *түзетулер өте құпталады!* [GitHub сайтындағы тарту сұрауы](https://github.com/cobbzilla/mobiletto/pulls) жіберіңіз.
59
- немесе мұны істеу ыңғайсыз болса, [мәселені ашыңыз](https://github.com/cobbzilla/mobiletto/issues)
60
-
61
- Аударма туралы жаңа GitHub мәселесін жасағанда, мынаны орындаңыз:
62
- * беттің URL мекенжайын қосу (браузердің мекенжай жолағынан көшіру/қою)
63
- * қате мәтінді қосыңыз (браузерден көшіру/қою)
64
- * ненің дұрыс емес екенін сипаттаңыз -- аударма дұрыс емес пе? пішімдеу қандай да бір түрде бұзылды ма?
65
- * жақсырақ аударманы немесе мәтінді қалай дұрыс пішімдеу керектігін ұсыныңыз
66
- * **Рақмет сізге!**
67
-
68
- ## Неліктен Mobiletto?
69
-
70
- ### Сау болыңыз сатушы құлпы!
71
- Әртүрлі бұлтты сақтау провайдерлерінің API интерфейстері үйлеспейді. Тіпті «S3 үйлесімділігіне» ұмтылатындар да
72
- тән мінез-құлықтары бар.
73
-
74
- Қолданбаңыз үшін белгілі бір сақтау жеткізушісін таңдаған кезде, олардың API интерфейсіне тікелей код берсеңіз, қолданбаңыз
75
- енді сол қызметке тәуелді. Уақыт өтіп, код жинақталған сайын, жеткізушілер өзгереді
76
- барған сайын қолайсыз. Жеткізушілерді құлыптау қызықты әлеміне қош келдіңіз!
77
-
78
- Mobiletto осы мәселені шешуге арналған. Қолданбаңызды mobiletto API интерфейсіне кодтау арқылы сіз оңай жасай аласыз
79
- сақтау провайдерлерін өзгертіңіз және қолданбаңыздың сақтау қабаты бірдей әрекет ететінін біліңіз.
80
-
81
- ### Кең ауқымды тестілеу
82
- Барлық драйверлер әр жүргізуші үшін 60-тан астам сынақпен бірдей мінез-құлыққа сыналады.
83
- Біз барлық драйверлерді келесі комбинациялармен тексереміз:
84
- * Шифрлау: қосылған және өшірілген
85
- * Redis кэші: қосылған және өшірілген
86
-
87
- Бұл тәсіл сізге қай драйверді пайдалансаңыз да, mobiletto бірдей әрекет ететініне тыныштық береді,
88
- және кэштеуді және/немесе шифрлауды қосқаныңызға қарамастан.
89
-
90
- ### Драйверге қолдау көрсету
91
- Ағымдағы Mobiletto сақтау драйверлері:
92
- * `s3` : Amazon S3
93
- * `b2` : Backblaze B2
94
- * `local` жергілікті`: жергілікті файлдық жүйе
95
-
96
- *Көбірек бұлтты сақтау провайдерлеріне қолдау көрсету үшін үлестер құпталады!*
97
-
98
- ## mobiletto-cli
99
- Mobiletto басқа JavaScript коды арқылы кітапхана ретінде пайдалануға арналған.
100
-
101
- Пәрмен жолында mobiletto-мен жұмыс істеу үшін [mobiletto-cli](https://www.npmjs.com/package/mobiletto-cli) пайдаланыңыз.
102
-
103
- ## Дереккөз
104
- * [GitHub сайтындағы мобильді](https://github.com/cobbzilla/mobiletto)
105
- * [mobiletto on npm](https://www.npmjs.com/package/mobiletto)
106
-
107
- ## Қолдау және қаржыландыру
108
- Мен кәсіби ашық бастапқы бағдарламалық жасақтаманы әзірлеуші болуға тырысамын. Мен жұмыс істеп келемін
109
- көптеген жылдар бойы бағдарламалық қамтамасыз ету индустриясында мен табысты компанияларды бастадым және оларды ашық компанияларға саттым.
110
- Жақында мен жұмыссыз қалдым, басқа жұмысым жоқ
111
-
112
- Сондықтан мен пайдалы бағдарламалық құрал жазуға тырысамын және оның жұмыс істейтінін көремін
113
-
114
- Егер сіз осы бағдарламалық жасақтаманы пайдалануды ұнатсаңыз, мен тіпті үшін өте ризамын
115
- ең аз [Patreon арқылы ай сайынғы жарна](https://www.patreon.com/cobbzilla)
116
-
117
- *Рақмет сізге!*
118
-
119
- ## Орнату
120
- `npm` немесе `yarn` арқылы орнатыңыз. Сізге барлығын қамтымайтын `lite` нұсқасы қажет болуы мүмкін
121
- аударылған README файлдары:
122
-
123
- npm install mobiletto-lite
124
- yarn add mobiletto-lite
125
-
126
- Әрбір тілде README файлдарын шынымен қаласаңыз, толық нұсқасын орнатыңыз:
127
-
128
- npm install mobiletto
129
- yarn add mobiletto
130
-
131
- ## Жылдам бастау
132
- mobiletto `s3` драйверін пайдаланудың қысқаша мысалы.
133
-
134
- Драйвер `b2` немесе `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
- ## Негізгі қолдану
165
- Ұсынылған мүмкіндіктердің көпшілігін көрсететін анағұрлым кеңірек мысал:
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
- ## Метадеректер
267
- " `metadata` " пәрмені бір файлдық жүйе жазбасы туралы метадеректерді қайтарады.
268
- Сол сияқты, `list` пәрменінен қайтарылатын мән метадеректер нысандарының жиымы болып табылады.
269
-
270
- Метадеректер нысаны келесідей көрінеді:
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
- `type` сипаты `file` , `dir` , `link` немесе `special` болуы мүмкін.
281
-
282
- Драйвер түріне байланысты `list` пәрмені барлық өрістерді қайтармауы мүмкін. `name` және `type` сипаттары
283
- әрқашан болуы керек. Келесі `metadata` пәрмені барлық қолжетімді сипаттарды қайтарады.
284
-
285
- ## Баламалы импорт мәнері
286
- Толық ауқымды модульді импорттаңыз және `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
- ## Кэштеу
294
- Mobiletto <a href="https://redis.io">redis кэшімен</a> жақсы жұмыс істейді.
295
-
296
- Mobiletto 127.0.0.1:6379 нұсқасында redis данасына қосылуға әрекет жасайды.
297
-
298
- Мыналардың кез келгенін қайта анықтауға болады:
299
- * Localhost орнына осында қосылу үшін `MOBILETTO_REDIS_HOST` env var, mobilet орнатыңыз
300
- * `MOBILETTO_REDIS_PORT` env var параметрін орнатыңыз, бұл порт пайдаланылады
301
-
302
- Mobiletto өзінің барлық redis кілттерін `_mobiletto__` префиксімен сақтайды. Сіз мұны өзгерте аласыз
303
- `MOBILETTO_REDIS_PREFIX` env var параметрін орнату арқылы.
304
-
305
- Сондай-ақ, `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
- ### Қайта кэштеуді қаламайсыз ба?
317
- Өшіру үшін: қосылымды орнатқан кезде `opts.redisConfig` нысанында `enabled: false` ' мәнін өткізіңіз.
318
-
319
- Төменде талқыланғандай, кэштеуді өшіру өнімділікке кері әсер етеді және көбірек сұрауларды тудырады
320
- сізге шынымен қажет сақтау үшін.
321
-
322
- ### Кэштеу бойынша нұсқаулық
323
- **Шифрланған жад**: шифрланған жадты оқу/жазу қалыптыдан сәл ғана баяу,
324
- бірақ каталогтарды шарлау (кейбір нәрселер жасайды) өте қымбат. Redis кэшін пайдалану
325
- сізге айтарлықтай өнімділікті арттырады.
326
-
327
- Әдепкі кэш қауіпсіз, бірақ жазу/жою әрекеттері көп болса, жақсы жұмыс істемейді.
328
- Кез келген жазу немесе жою операциясы бүкіл кэшті жарамсыз етеді, бұл келесі оқулар көретінін қамтамасыз етеді
329
- соңғы өзгерістер.
330
-
331
- ### CLI құралдары
332
- [mobiletto-cli](https://www.npmjs.com/package/mobiletto-cli) сияқты CLI құралын пайдалансаңыз,
333
- Сіз міндетті түрде redis кэшінің қосылғанын қалайсыз, себебі ол `mo` пәрменінің шақыруларында созылады.
334
-
335
- ## Айналау
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` пәрмені бір мобильді құрылғыдан екіншісіне барлық файлдардың бір реттік көшірмесін орындайды.
344
- Ол уақыт өте келе айнаны сақтау үшін ешқандай процесті орындамайды. `mirror` пәрменін қайта іске қосыңыз
345
- кез келген жетіспейтін файлдарды синхрондау үшін.
346
-
347
- `mirror` » қайтарылатын мән – қанша файл сәтті болғанын есептегіштері бар қарапайым нысан
348
- шағылыстырылған және қанша файлда қателер бар:
349
-
350
- {
351
- success: count-of-files-mirrored,
352
- errors: count-of-files-with-errors
353
- }
354
-
355
- ЕСКЕРТУ: Үлкен деректер жиынын көшіру өте көп уақытты және өткізу қабілеттілігін қажет етуі мүмкін
356
-
357
- `mirror` шақыру семантикасымен кейде кім екенін түсіну шатасуы мүмкін
358
- оқырман және жазушы кім. Мұны тапсырма туралы мәлімдеме сияқты елестетіп көріңіз: «сол жақ мобильді»
359
- тағайындалған нәрсе (жазылған айнадағы деректер) және «оң жақтағы mobiletto» (
360
- `mirror` әдісінің аргументі) тағайындалатын мән (айналанған деректер оқылады).
361
-
362
- ## Мөлдір шифрлау
363
- Мөлдір клиенттік шифрлауды қосыңыз:
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
- Не болып жатыр? Бөлек «каталог жазбасы» (тікелей) каталог (шифрланған) онда қандай файлдар бар екенін бақылайды
383
- каталог (aka dirent каталогы).
384
- * `list` пәрмені каталог енгізу файлдарын оқиды, тізімде көрсетілген әрбір жолдың шифрын шешеді; содан кейін әрбір файл үшін метадеректерді қайтарады
385
- * `list` пәрмендері тиімсіз, әсіресе файлдар саны көп каталогтар үшін
386
- * `write` пәрмені dirent файлдарды әрбір ата-ананың тікелей каталогына рекурсивті түрде жазады; содан кейін файлды жазады
387
- * `write` пәрмендері каталог иерархиясында N = тереңдікпен O(N) жазуды талап етеді
388
- * `remove` файлды, ал бос болса оның ата-анасын рекурсивті түрде жояды; содан кейін файлды жояды
389
- * Рекурсивті емес `remove` пәрмендері O(N) оқылады және ықтимал көп жойылады, N = каталог иерархиясының тереңдігі
390
- * Үлкен және терең файлдық жүйелердегі рекурсивті `remove` пәрмендері қымбат болуы мүмкін
391
-
392
- Клиенттік шифрлау қосулы болса да, шифрланған сервер жағына толық көрінетін қарсылас екенін ескеріңіз.
393
- жад, тіпті кілтсіз де, каталогтардың жалпы санын және әрқайсысында қанша файл бар екенін көре алады
394
- біраз күш жұмсап, каталог иерархиясының жалпы құрылымының кейбірін немесе барлығын ашыңыз.
395
- *Ескертпе: Қауіпсіздікті жақсарту үшін салыстырмалы түрде тегіс құрылымды пайдаланыңыз.*
396
- Қарсылас сіздің шифрлауыңызды білмейінше, каталогтардың/файлдардың атауларын білмейді
397
- кілті немесе шифрлауды басқа жолмен сәтті бұзған. Сонда барлық ставкалар өшіріледі!
398
-
399
- ### Өнімділік және кэштеу
400
- Шифрланған жадтағы әрекеттер баяу болуы мүмкін. Рекурсивті тізімдер мен жоюлар өте баяу болуы мүмкін.
401
- Redis арқылы кэштеу өте жақсы көмектеседі, бірақ кэш кез келген жазу немесе жою кезінде тазартылатынын ескеріңіз.
402
-
403
- ## Пернені айналдыру
404
- Жаңа кілтпен mobiletto жасаңыз, содан кейін оған ескі деректерді қайталаңыз:
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
- ## Драйвер интерфейсі
417
- Драйвер - бұл қолтаңбасы бар "storageClient" функциясын экспорттайтын кез келген JS файлы:
418
-
419
- function storageClient (key, secret, opts)
420
-
421
- * `key` : жол, сіздің API кілтіңіз ( `local` драйвер үшін бұл негізгі каталог)
422
- * `secret` : жол, сіздің API құпияңыз ( `local` драйвер үшін өткізілмеуі мүмкін)
423
- * `opts` : нысан, сипаттар әр драйверге арналған:
424
- * "Жергілікті" үшін " `local` " және " `fileMode` " сипаттары жаңа файлдар мен каталогтардың `dirMode` анықтайды
425
- * `s3` үшін `bucket` сипаты қажет. Қосымша сипаттар:
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
- storageClient функциясы қайтаратын нысан мына функцияларды анықтауы керек:
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
- ## Ағаш жазу
457
- Mobiletto [winston](https://www.npmjs.com/package/winston) журнал жүргізу кітапханасын пайдаланады.
458
-
459
- Журналдар **файл жолдары мен қате туралы хабарларды қамтиды, бірақ **ешқашан** кілттерді, құпияларды,
460
- немесе кез келген басқа қосылым конфигурациясы.
461
-
462
- ### Журнал деңгейі
463
- Журнал деңгейін орнату үшін " `MOBILETTO_LOG_LEVEL` ортасының айнымалы мәнін пайдаланыңыз.
464
- [https://www.npmjs.com/package/winston#logging-levels](https://www.npmjs.com/package/winston#logging-levels) ішінде анықталған `npm` деңгейлерінің
465
-
466
- Әдепкі деңгей – `error` . Ең егжей-тегжейлі деңгей - қазіргі уақытта `silly` болса да, «ақымақ».
467
- `debug` » төмен деңгейлерде тіркелмейді
468
-
469
- MOBILETTO_LOG_LEVEL=silly # maximum logs!
470
-
471
- ### Журнал файлы
472
- Әдепкі бойынша тіркеуші консольге жазады. Журналдарды файлға жіберу үшін " `MOBILETTO_LOG_FILE` " файлын орнатыңыз
473
- ортаның айнымалысы. Файлға кіру кезінде журналдар енді консольге жазылмайды.
474
-
475
- MOBILETTO_LOG_FILE=/var/my_mobiletto_log
476
-
477
- Тіркеуді өшіру үшін:
478
-
479
- MOBILETTO_LOG_FILE=/dev/null
480
-
481
- </pre>