mobiletto 1.2.1 → 2.0.1

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/ky/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-import-style)
16
- * [Кэштөө](#Кэштөө)
17
- * [Мирroring](#Mirroring)
18
- * [Тунук шифрлөө](#Transparent-шифрлөө)
19
- * [Ачкычты айландыруу](#Ачкычты айландыруу)
20
- * [Драйвер интерфейси](#Driver-интерфейс)
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
- [🇫🇷 French](../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` var, mobilet коюңуз
300
- * `MOBILETTO_REDIS_PORT` var орнотуңуз, бул порт колдонулат
301
-
302
- Mobiletto өзүнүн бардык redis ачкычтарын `_mobiletto__` префикси менен сактайт. Муну өзгөртө аласыз
303
- `MOBILETTO_REDIS_PREFIX` 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
- ## Mirroring
336
-
337
- // Copy a local filesystem mobiletto to S3
338
- s3.mirror(local)
339
-
340
- // Mirror a local subdirectory from one mobiletto to an S3 mobiletto, with it's own subdirectory
341
- local.mirror(s3, 'some/local-folder', 'some/s3-folder')
342
-
343
- `mirror` буйругу бардык файлдардын бир мобилдик телефондон экинчисине бир жолку көчүрмөсүн аткарат.
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
- дайындалган нерсе (жазылган күзгү маалыматтар) жана "оң кол мобилдик" (
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
- каталог (ака дирент каталогу).
384
- * `list` буйругу каталогдун файлдарын окуйт, тизмеленген ар бир жолдун шифрин чечет; андан кийин ар бир файл үчүн метадайындарды кайтарат
385
- * `list` буйруктары өзгөчө файлдардын саны көп каталогдор үчүн натыйжасызыраак
386
- * `write` командасы dirent файлдарды ар бир ата-эненин дирент каталогуна рекурсивдүү түрдө жазат; анан файлды жазат
387
- * `write` буйруктары каталогдун иерархиясында N = тереңдик менен O(N) жазууну талап кылат
388
- * `remove` буйругу тиешелүү dirent файлды, ал эми бош болсо анын ата-энесин рекурсивдүү түрдө жок кылат; андан кийин файлды жок кылат
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` , бирок азыркы учурда mobiletto
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>