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/az/README.md DELETED
@@ -1,481 +0,0 @@
1
- Mobiletto
2
- =========
3
-
4
- Mobiletto isteğe bağlı şəffaf müştəri tərəfi şifrələməsi ilə JavaScript yaddaş abstraksiya qatıdır.
5
-
6
- # Məzmun
7
- * [Niyə Mobiletto?](#Why-Mobiletto?)
8
- * [Quick start](#Quick-start)
9
- * [Mobiletto CLI](#mobiletto-cli)
10
- * [Mənbə](#Mənbə)
11
- * [Quraşdırma](#Quraşdırma)
12
- * [Dəstək və Maliyyələşdirmə](#Dəstək və Maliyyələşdirmə)
13
- * [Əsas istifadə](#Basic-istifadə)
14
- * [Metadata](#Metadata)
15
- * [Alternativ idxal üslubu](#Alternativ idxal stili)
16
- * [Keşləmə](#Keşləmə)
17
- * [Yansıtma](#Aynatma)
18
- * [Şəffaf şifrələmə](#Şəffaf-şifrələmə)
19
- * [Açarların fırlanması](#Açarların fırlanması)
20
- * [Sürücü interfeysi](#Sürücü interfeysi)
21
- * [Giriş](#Giriş)
22
-
23
- # Bunu başqa dildə oxuyun
24
- Bu README.md sənədi [hokeylization](https://github.com/cobbzilla/hokeylization) vasitəsilə tərcümə olunub
25
- **[Google Translate tərəfindən dəstəklənən bütün dillər](https://cloud.google.com/translate/docs/languages)!**
26
-
27
- Əminəm ki, mükəmməl deyil, amma ümid edirəm ki, heç nədən yaxşıdır!
28
-
29
- [🇸🇦 Ərəb](../ar/README.md)
30
- [🇧🇩 Benqal dili](../bn/README.md)
31
- [🇩🇪 Almanca](../de/README.md)
32
- [🇺🇸 İngilis dili](../en/README.md)
33
- [🇪🇸 İspan](../es/README.md)
34
- [🇫🇷 Fransızca](../fr/README.md)
35
- [🇹🇩 Hausa](../ha/README.md)
36
- [🇮🇳 Hindi](../hi/README.md)
37
- [🇮🇩 İndoneziya dili](../id/README.md)
38
- [🇮🇹 İtalyanca](../it/README.md)
39
- [🇯🇵 Yapon](../ja/README.md)
40
- [🇰🇷 Koreya](../ko/README.md)
41
- [🇮🇳 Marathi](../mr/README.md)
42
- [🇵🇱 Polyak](../pl/README.md)
43
- [🇧🇷 Portuqal dili](../pt/README.md)
44
- [🇷🇺 Rus dili](../ru/README.md)
45
- [🇰🇪 Suahili](../sw/README.md)
46
- [🇵🇭 Taqaloq](../tl/README.md)
47
- [🇹🇷 Türkcə](../tr/README.md)
48
- [🇵🇰 Urdu](../ur/README.md)
49
- [🇻🇳 Vyetnam dili](../vi/README.md)
50
- [🇨🇳 Çin](../zh/README.md)
51
-
52
-
53
- **[📚 ... Bütün Dillər ...](../README.md)**
54
- ----
55
-
56
- ### README-nin bu tərcüməsində problem varmı?
57
- Orijinalın bu xüsusi tərcüməsi [README](https://github.com/cobbzilla/mobiletto/blob/master/README.md)
58
- qüsurlu ola bilər -- *düzəlişlər çox xoşdur!* Lütfən, [GitHub-da çəkmə sorğusu] göndərin (https://github.com/cobbzilla/mobiletto/pulls),
59
- və ya bunu etməkdə rahat deyilsinizsə, [məsələ açın](https://github.com/cobbzilla/mobiletto/issues)
60
-
61
- Tərcümə ilə bağlı yeni GitHub məsələsi yaratdığınız zaman, lütfən:
62
- * səhifənin URL-ni daxil edin (brauzerin ünvan çubuğundan kopyalayın/yapışdırın)
63
- * səhv olan mətni daxil edin (brauzerdən kopyalayın/yapışdırın)
64
- * zəhmət olmasa nəyin səhv olduğunu təsvir edin -- tərcümə səhvdir? formatlama birtəhər pozuldu?
65
- * lütfən daha yaxşı tərcümə təklifi və ya mətnin düzgün formatlaşdırılması ilə bağlı təklif verin
66
- * **Çox sağ ol!**
67
-
68
- ## Niyə Mobiletto?
69
-
70
- ### Əlvida satıcı kilidi!
71
- Müxtəlif bulud saxlama təminatçıları uyğun olmayan API-lərə malikdir. Hətta "S3 uyğunluğu" üçün səy göstərənlər
72
- özünəməxsus davranışlara malikdir.
73
-
74
- Tətbiqiniz üçün xüsusi yaddaş təchizatçısı seçdiyiniz zaman, birbaşa onların API-sinə kodlasanız, tətbiqiniz
75
- indi həmin xidmətdən asılıdır. Zaman keçdikcə və kod yığıldıqca dəyişən satıcılar olur
76
- getdikcə dözülməz olur. Satıcı kilidinin əyləncəli dünyasına xoş gəlmisiniz!
77
-
78
- Mobiletto bu problemi həll etmək üçün hazırlanmışdır. Tətbiqinizi mobiletto-nun API-yə kodlaşdırmaqla siz asanlıqla edə bilərsiniz
79
- yaddaş provayderlərini dəyişdirin və tətbiqinizin yaddaş təbəqəsinin eyni şəkildə davranacağını bilin.
80
-
81
- ### Geniş sınaq
82
- Bütün sürücülər hər bir sürücü üçün 60+ testlə eyni davranış üçün sınaqdan keçirilir.
83
- Biz bütün sürücüləri hər kombinasiya ilə sınaqdan keçiririk:
84
- * Şifrələmə: həm aktiv, həm də əlil
85
- * Redis keşi: həm aktiv, həm də qeyri-aktivdir
86
-
87
- Bu yanaşma bizə rahatlıq verir ki, hansı sürücüdən istifadə etməyinizdən asılı olmayaraq mobiletto eyni davranacaq.
88
- və keşləmə və/yaxud şifrələməni aktiv edib etməməyinizdən asılı olmayaraq.
89
-
90
- ### Sürücü dəstəyi
91
- Cari Mobiletto yaddaş sürücüləri:
92
- * `s3` : Amazon S3
93
- * `b2` : arxa yanma B2
94
- * `local` : yerli fayl sistemi
95
-
96
- *Daha çox bulud saxlama təminatçılarını dəstəkləmək üçün töhfələr çox xoşdur!*
97
-
98
- ## mobiletto-cli
99
- Mobiletto digər JavaScript kodu ilə kitabxana kimi istifadə olunmaq üçün nəzərdə tutulub.
100
-
101
- Komanda xəttində mobiletto ilə işləmək üçün [mobiletto-cli](https://www.npmjs.com/package/mobiletto-cli) istifadə edin.
102
-
103
- ## Mənbə
104
- * [GitHub-da mobiletto](https://github.com/cobbzilla/mobiletto)
105
- * [npm-də mobiletto](https://www.npmjs.com/package/mobiletto)
106
-
107
- ## Dəstək və Maliyyələşdirmə
108
- Mən peşəkar açıq mənbə proqram təminatı tərtibatçısı olmağa çalışıram. məndə işləmişəm
109
- Uzun illər proqram sektorunda müvəffəqiyyətli şirkətlər qurdum və onları açıq şirkətlərə satdım.
110
- Bu yaxınlarda işimi itirdim və başqa işim yoxdur
111
-
112
- Beləliklə, mən faydalı proqram yazmağa çalışacağam və bunun işlədiyini görəcəyəm
113
-
114
- Bu proqramdan istifadə etməkdən zövq alırsınızsa, mən hətta bu proqram üçün çox minnətdar olaram
115
- ən kiçik [Patreon vasitəsilə aylıq töhfə](https://www.patreon.com/cobbzilla)
116
-
117
- *Çox sağ ol!*
118
-
119
- ## Quraşdırma
120
- `npm` və ya `yarn` istifadə edərək quraşdırın. Siz yəqin ki, hamısını daxil etməyən `lite` versiyasını istəyirsiniz
121
- tərcümə edilmiş README faylları:
122
-
123
- npm install mobiletto-lite
124
- yarn add mobiletto-lite
125
-
126
- Həqiqətən hər dildə README fayllarını istəyirsinizsə, tam versiyanı quraşdırın:
127
-
128
- npm install mobiletto
129
- yarn add mobiletto
130
-
131
- ## Tez Başlanğıc
132
- mobiletto `s3` sürücüsündən istifadə edən qısa bir nümunə.
133
-
134
- Sürücü `b2` və ya `local` olsaydı, bu kod eyni işləyəcəkdi.
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
- ## Əsas istifadə
165
- Təklif olunan xüsusiyyətlərin əksəriyyətini göstərən daha geniş bir nümunə:
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
- ## Metadata
267
- `metadata` əmri bir fayl sistemi girişi haqqında metadata qaytarır.
268
- Eynilə, `list` əmrindən qaytarılan dəyər metadata obyektlərinin massividir.
269
-
270
- Metadata obyekti belə görünür:
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` xüsusiyyəti `file` , `dir` , `link` və ya `special` ola bilər.
281
-
282
- Sürücünün növündən asılı olaraq, `list` əmri bütün sahələri qaytarmaya bilər. `name` və `type` xassələri
283
- həmişə mövcud olmalıdır. Sonrakı `metadata` əmri bütün mövcud xassələri qaytaracaq.
284
-
285
- ## Alternativ idxal üslubu
286
- Tam əhatəli modulu idxal edin və `connect` funksiyasından istifadə edin:
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
- ## Keşləmə
294
- Mobiletto <a href="https://redis.io">redis</a> keşi ilə yaxşı işləyir.
295
-
296
- Mobiletto 127.0.0.1:6379-da redis instansiyasına qoşulmağa çalışacaq.
297
-
298
- Bunlardan hər hansı birini ləğv edə bilərsiniz:
299
- * Localhost əvəzinə buraya qoşulmaq üçün `MOBILETTO_REDIS_HOST` var, mobilet seçin
300
- * `MOBILETTO_REDIS_PORT` var seçin, bu port istifadə olunacaq
301
-
302
- Mobiletto bütün redis açarlarını `_mobiletto__` prefiksi ilə saxlayacaq. Bunu dəyişə bilərsiniz
303
- `MOBILETTO_REDIS_PREFIX` var.
304
-
305
- Siz həmçinin `opts.redisConfig` obyekti ilə hər qoşulma keşini təyin edə bilərsiniz:
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
- ### Redis caching istəmirsiniz?
317
- Deaktiv etmək üçün `opts.redisConfig` obyektinizdə `enabled: false` ' düyməsini keçirin.
318
-
319
- Aşağıda müzakirə edildiyi kimi, keşləşdirməni söndürmək performansa mənfi təsir göstərəcək və daha çox sorğuya səbəb olacaq
320
- həqiqətən ehtiyacınız olan saxlama üçün.
321
-
322
- ### Keşləmə təlimatı
323
- **Şifrələnmiş yaddaş**: şifrələnmiş yaddaşın oxunması/yazılması normaldan bir qədər yavaşdır,
324
- lakin kataloqlar ətrafında naviqasiya (bəzi şeylər bunu edir) kifayət qədər bahalıdır. Redis keşindən istifadə
325
- sizə əhəmiyyətli performans təkan verəcək.
326
-
327
- Defolt keş təhlükəsizdir, lakin çoxlu yazma/silmə əməliyyatlarınız varsa, yaxşı işləmir.
328
- İstənilən yazma və ya silmə əməliyyatı bütün önbelleği etibarsız edir və sonrakı oxunuşların görəcəyini təmin edir
329
- son dəyişikliklər.
330
-
331
- ### CLI alətləri
332
- Əgər [mobiletto-cli](https://www.npmjs.com/package/mobiletto-cli) kimi bir CLI alətindən istifadə edirsinizsə,
333
- siz mütləq redis keşinin aktiv olmasını istəyəcəksiniz, çünki o, `mo` əmrinin çağırışları arasında davam edir.
334
-
335
- ## Yansıtma
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` əmri bütün faylların bir mobildən digərinə birdəfəlik surətini çıxarır.
344
- Zamanla güzgü saxlamaq üçün heç bir proses işlətmir. `mirror` əmrini yenidən yerinə yetirin
345
- itkin faylları sinxronlaşdırmaq üçün.
346
-
347
- `mirror` -dən qaytarılan dəyər neçə faylın uğurla alındığını göstərən sayğacları olan sadə obyektdir
348
- yansıtılmış və neçə faylda xəta var:
349
-
350
- {
351
- success: count-of-files-mirrored,
352
- errors: count-of-files-with-errors
353
- }
354
-
355
- XƏBƏRDARLIQ: Böyük məlumat dəstlərinin əks etdirilməsi çox vaxt aparan və bant genişliyi tələb edə bilər
356
-
357
- `mirror` çağırış semantikası ilə kimin olduğunu anlamaq bəzən çaşqın ola bilər
358
- oxucu və yazıçı kimdir. Bunu bir tapşırıq bəyanatı kimi təsəvvür edin: "sol əl mobiltto"
359
- təyin olunan şeydir (yazılan güzgü məlumatı) və "sağ tərəfdən mobiletto" (
360
- `mirror` metodunun arqumenti) təyin olunan dəyərdir (güzgü məlumatı oxunur).
361
-
362
- ## Şəffaf şifrələmə
363
- Müştəri tərəfində şəffaf şifrələməni aktivləşdirin:
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
- Nə baş verir? Ayrı bir "kataloq girişi" (birbaşa) kataloq (şifrlənmiş) orada hansı faylların olduğunu izləyir
383
- kataloq (aka dirent kataloq).
384
- * `list` əmri kataloqa daxil olan faylları oxuyur, sadalanan hər yolun şifrəsini açır; sonra hər bir fayl üçün metadata qaytarır
385
- * `list` əmrləri xüsusilə çox sayda faylı olan qovluqlar üçün daha səmərəsizdir
386
- * `write` əmri rekursiv şəkildə hər bir valideynin dirent kataloquna dirent faylları yazır; sonra faylı yazır
387
- * `write` əmrləri qovluq iyerarxiyasında N = dərinlik ilə O(N) yazılarına səbəb olacaq
388
- * `remove` əmri müvafiq dirent faylı və onun əsas faylını boşdursa, rekursiv şəkildə silir; sonra faylı silir
389
- * Qeyri-rekursiv `remove` əmrləri O(N) oxumağa və potensial olaraq bir o qədər çox silməyə səbəb olacaq, N = kataloq iyerarxiyasında dərinlik
390
- * Böyük və dərin fayl sistemlərində `remove` əmrləri bahalı ola bilər
391
-
392
- Nəzərə alın ki, hətta müştəri tərəfində şifrələmə aktiv olsa belə, şifrələnmiş server tərəfinizdə tam görünən bir rəqib
393
- yaddaş, açar olmadan belə, yenə də qovluqların ümumi sayını və hər birində neçə fayl olduğunu görə bilər
394
- bir az səy göstərin, kataloq iyerarxiyasının ümumi strukturunun bir hissəsini və ya hamısını kəşf edin.
395
- *Qeyd: Daha yaxşı təhlükəsizlik üçün nisbətən düz strukturdan istifadə edin.*
396
- Rəqib şifrləmənizi bilməsə, kataloqların/faylların adlarını bilməyəcək
397
- açarı və ya şifrələməni müvəffəqiyyətlə sındırıb. O zaman bütün mərclər dayandırılır!
398
-
399
- ### Performans və keşləmə
400
- Şifrələnmiş yaddaşda əməliyyatlar yavaş ola bilər. Rekursiv siyahılar və silinmələr çox yavaş ola bilər.
401
- Redis vasitəsilə keşləmə çox kömək edir, lakin qeyd edin ki, hər hansı yazı və ya silinmə zamanı keş silinir.
402
-
403
- ## Açarın fırlanması
404
- Yeni açarınızla mobiletto yaradın, sonra köhnə məlumatları ona əks etdirin:
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
- ## Sürücü interfeysi
417
- Sürücü bu imza ilə 'storageClient' funksiyasını ixrac edən istənilən JS faylıdır:
418
-
419
- function storageClient (key, secret, opts)
420
-
421
- * `key` : sətir, sizin API açarınız ( `local` sürücü üçün bu əsas kataloqdur)
422
- * `secret` : sətir, sizin API sirriniz ( `local` sürücü üçün buraxıla bilər)
423
- * `opts` : obyekt, xassələr hər sürücü üçün:
424
- * `local` üçün `fileMode` və `dirMode` xassələri yeni yaradılan fayl və qovluqların necə yaradıldığını müəyyən edir.
425
- * `s3` üçün `bucket` xüsusiyyəti tələb olunur. İsteğe bağlı xüsusiyyətlər bunlardır:
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 funksiyasının qaytardığı obyekt bu funksiyaları müəyyən etməlidir:
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
- ## Giriş
457
- Mobiletto [winston](https://www.npmjs.com/package/winston) giriş kitabxanasından istifadə edir.
458
-
459
- Qeydlər **fayl yollarını və səhv mesajlarını ehtiva edəcək, lakin **heç vaxt** açarları, sirləri,
460
- və ya hər hansı digər əlaqə konfiqurasiyası məlumatı.
461
-
462
- ### Qeyd səviyyəsi
463
- Birindən istifadə edərək jurnal səviyyəsini təyin etmək üçün `MOBILETTO_LOG_LEVEL` mühit dəyişənindən istifadə edin
464
- [https://www.npmjs.com/package/winston#logging-levels](https://www.npmjs.com/package/winston#logging-levels) saytında müəyyən edilmiş `npm` səviyyələrinin
465
-
466
- Defolt səviyyə `error` . Hal-hazırda mobiletto olsa da, ən ətraflı səviyyə `silly` '
467
- `debug` aşağı səviyyələrdə daxil olmur
468
-
469
- MOBILETTO_LOG_LEVEL=silly # maximum logs!
470
-
471
- ### Günlük faylı
472
- Varsayılan olaraq, logger konsola yazır. Qeydləri fayla göndərmək üçün `MOBILETTO_LOG_FILE`
473
- mühit dəyişəni. Fayla daxil olarkən loglar artıq konsola yazılmayacaq.
474
-
475
- MOBILETTO_LOG_FILE=/var/my_mobiletto_log
476
-
477
- Girişi söndürmək üçün:
478
-
479
- MOBILETTO_LOG_FILE=/dev/null
480
-
481
- </pre>