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/mt/README.md DELETED
@@ -1,481 +0,0 @@
1
- Mobiletto
2
- =========
3
-
4
- Mobiletto huwa saff ta 'estrazzjoni tal-ħażna JavaScript, b'kriptaġġ trasparenti mhux obbligatorju min-naħa tal-klijent.
5
-
6
- # Kontenut
7
- * [Għaliex Mobiletto?](#Għaliex-Mobiletto?)
8
- * [Bidu ta' malajr](#Bidu ta' malajr)
9
- * [Mobiletto CLI](#mobiletto-cli)
10
- * [Sors](#Sors)
11
- * [Installazzjoni](#Installazzjoni)
12
- * [Appoġġ u Finanzjament](#Appoġġ-u-Finanzjament)
13
- * [Użu Bażiku](#Użu Bażiku)
14
- * [Metadata](#Metadata)
15
- * [Stil ta' importazzjoni alternattiv](#Stil ta' importazzjoni alternattiv)
16
- * [Caching](#Caching)
17
- * [Mirroring](#Mirroring)
18
- * [Encryption trasparenti](#Transparent-encryption)
19
- * [Rotazzjoni taċ-ċavetta](#Rotazzjoni taċ-ċavetta)
20
- * [Interfaċċja tas-sewwieq](#Interface tas-sewwieq)
21
- * [Logging](#Logging)
22
-
23
- # Aqra dan b'lingwa oħra
24
- Dan id-dokument README.md ġie tradott, permezz ta’ [hokeylization](https://github.com/cobbzilla/hokeylization), fi
25
- **[kull lingwa appoġġjata minn Google Translate](https://cloud.google.com/translate/docs/languages)!**
26
-
27
- Jien ċert li mhuwiex perfett, imma nispera li huwa aħjar minn xejn!
28
-
29
- [🇸🇦 Għarbi](../ar/README.md)
30
- [🇧🇩 Bengali](../bn/README.md)
31
- [🇩🇪 Ġermaniż](../de/README.md)
32
- [🇺🇸 Ingliż](../en/README.md)
33
- [🇪🇸 Spanjol](../es/README.md)
34
- [🇫🇷 Franċiż](../fr/README.md)
35
- [🇹🇩 Hausa](../ha/README.md)
36
- [🇮🇳 Ħindi](../hi/README.md)
37
- [🇮🇩 Indoneżjan](../id/README.md)
38
- [🇮🇹 Taljan](../it/README.md)
39
- [🇯🇵 Ġappuniż](../ja/README.md)
40
- [🇰🇷 Korean](../ko/README.md)
41
- [🇮🇳 Marathi](../mr/README.md)
42
- [🇵🇱 Pollakk](../pl/README.md)
43
- [🇧🇷 Portugiż](../pt/README.md)
44
- [🇷🇺 Russu](../ru/README.md)
45
- [🇰🇪 Swaħili](../sw/README.md)
46
- [🇵🇭 Tagalog](../tl/README.md)
47
- [🇹🇷 Tork](../tr/README.md)
48
- [🇵🇰 Urdu](../ur/README.md)
49
- [🇻🇳 Vjetnamiż](../vi/README.md)
50
- [🇨🇳 Ċiniż](../zh/README.md)
51
-
52
-
53
- **[📚 ... Il-Lingwi kollha ...](../README.md)**
54
- ----
55
-
56
- ### Hemm problema b'din it-traduzzjoni tar-README?
57
- Din it-traduzzjoni partikolari tal-oriġinal [README](https://github.com/cobbzilla/mobiletto/blob/master/README.md)
58
- jista 'jkun difettuż -- *korrezzjonijiet huma milqugħa ħafna!* Jekk jogħġbok ibgħat [pull request fuq GitHub](https://github.com/cobbzilla/mobiletto/pulls),
59
- jew jekk m'intix komdu tagħmel dan, [iftaħ kwistjoni](https://github.com/cobbzilla/mobiletto/issues)
60
-
61
- Meta toħloq kwistjoni ġdida ta' GitHub dwar traduzzjoni, jekk jogħġbok agħmel:
62
- * inkludi l-URL tal-paġna (kopja/pejst mill-bar tal-indirizz tal-browser)
63
- * inkludi t-test eżatt li huwa ħażin (ikkopja/pejst mill-browser)
64
- * jekk jogħġbok iddeskrivi x'inhu ħażin -- it-traduzzjoni hija żbaljata? l-ifformattjar huwa miksur b'xi?
65
- * ġentilment toffri suġġeriment għal traduzzjoni aħjar, jew kif it-test għandu jkun ifformattjat kif suppost
66
- * **Grazzi!**
67
-
68
- ## Għaliex Mobiletto?
69
-
70
- ### Goodbye lock-in tal-bejjiegħ!
71
- Id-diversi fornituri tal-ħażna tas-sħab għandhom APIs inkompatibbli. Anke dawk li jistinkaw għal "kompatibilità S3"
72
- għandhom imġieba idjosinkratika.
73
-
74
- Meta tagħżel bejjiegħ tal-ħażna partikolari għall-app tiegħek, jekk tikkodifika direttament għall-API tagħhom, l-app tiegħek
75
- issa hija dipendenti fuq dak is-servizz. Hekk kif jgħaddi ż-żmien u jakkumula l-kodiċi, il-bejjiegħa jinbidlu jsiru
76
- dejjem aktar insostenibbli. Merħba fid-dinja divertenti tal-lokk tal-bejjiegħ!
77
-
78
- Mobiletto kien iddisinjat biex isolvi din il-problema. Billi tikkodifika l-app tiegħek għall-API ta' mobiletto, tista' faċilment
79
- ibdel il-fornituri tal-ħażna u kun af li s-saff tal-ħażna tal-app tiegħek se jġib ruħu b'mod identiku.
80
-
81
- ### Ittestjar estensiv
82
- Is-sewwieqa kollha huma ttestjati għal imġieba identika b'60+ test għal kull sewwieq.
83
- Aħna nittestjaw is-sewwieqa kollha b'kull kombinazzjoni ta':
84
- * Encryption: kemm attivat kif ukoll diżattivat
85
- * Redis cache: kemm attivat kif ukoll diżattivat
86
-
87
- Dan l-approċċ jagħtina s-serħan tal-moħħ li mobiletto se jġib ruħu l-istess irrispettivament minn liema sewwieq tuża,
88
- u irrispettivament minn jekk tippermettix il-caching u/jew l-encryption.
89
-
90
- ### Appoġġ għas-sewwieq
91
- Is-sewwieqa attwali tal-ħażna tal-Mobiletto:
92
- * `s3` : Amazon S3
93
- * `b2` : Backblaze B2
94
- * `local` : sistema ta' fajls lokali
95
-
96
- *Kontribuzzjonijiet biex jappoġġjaw aktar fornituri tal-ħażna tas-sħab huma milqugħa ħafna!*
97
-
98
- ## mobiletto-cli
99
- Mobiletto huwa maħsub biex jintuża bħala librerija minn kodiċi JavaScript ieħor.
100
-
101
- Biex taħdem ma 'mobiletto fil-linja tal-kmand, uża [mobiletto-cli](https://www.npmjs.com/package/mobiletto-cli)
102
-
103
- ## Sors
104
- * [mobiletto fuq GitHub](https://github.com/cobbzilla/mobiletto)
105
- * [mobiletto fuq npm](https://www.npmjs.com/package/mobiletto)
106
-
107
- ## Appoġġ u Finanzjament
108
- Qed nipprova nkun żviluppatur professjonali ta' software open source. Ilni naħdem fiha
109
- l-industrija tas-softwer għal ħafna snin, bdejt kumpaniji ta 'suċċess u biegħhom lil kumpaniji pubbliċi.
110
- Dan l-aħħar tlift ix-xogħol tiegħi, u ma tantx għandi xogħol ieħor imħejji
111
-
112
- Allura jien ser nipprova nikteb softwer utli u nara jekk dan jaħdem
113
-
114
- Jekk inti tgawdi tuża dan is-software, inkun ferm thankful anke għall-
115
- l-iżgħar [kontribuzzjoni ta' kull xahar permezz ta' Patreon](https://www.patreon.com/cobbzilla)
116
-
117
- *Grazzi!*
118
-
119
- ## Installazzjoni
120
- Installa bl-użu ta `npm` " jew `yarn` . Probabilment trid il-verżjoni `lite` li ma tinkludix il-
121
- fajls README tradotti:
122
-
123
- npm install mobiletto-lite
124
- yarn add mobiletto-lite
125
-
126
- Jekk verament trid il-fajls README f'kull lingwa, installa l-verżjoni sħiħa:
127
-
128
- npm install mobiletto
129
- yarn add mobiletto
130
-
131
- ## Quick Start
132
- Eżempju qasir bl-użu tas-sewwieq tal-mobiletto `s3` .
133
-
134
- Dan il-kodiċi jaħdem bl-istess mod jekk is-sewwieq ikun `b2` " jew `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
- ## Użu bażiku
165
- Eżempju ħafna aktar estensiv, li juri ħafna mill-karatteristiċi offruti:
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
- Il-kmand tal- `metadata` ' jirritorna metadata dwar dħul wieħed tas-sistema tal-fajls.
268
- Bl-istess mod, il-valur tar-ritorn mill-kmand tal- `list` huwa firxa ta' oġġetti ta' metadejta.
269
-
270
- Oġġett tal-metadejta jidher bħal dan:
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
- Il-proprjetà `type` tista' tkun `file` file", `dir` ", `link` , jew `special` .
281
-
282
- Skont it-tip ta' sewwieq, kmand `list` jista' ma jirritornax l-oqsma kollha. Il-proprjetajiet `name` u `type` .
283
- għandhom dejjem ikunu preżenti. Kmand ta `metadata` sussegwenti se jirritorna l-proprjetajiet kollha disponibbli.
284
-
285
- ## Stil ta' importazzjoni alternattiv
286
- Importa l-modulu b'ambitu sħiħ u uża l-funzjoni `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
- ## Caching
294
- Mobiletto jaħdem l-aħjar <a href="https://redis.io">b'redis</a> cache.
295
-
296
- Mobiletto se jipprova jikkonnettja ma 'istanza redis fuq 127.0.0.1:6379
297
-
298
- Tista' tegħleb xi waħda minn dawn:
299
- * Issettja l-env var `MOBILETTO_REDIS_HOST` , mobiletto tikkonnettja hawn minflok localhost
300
- * Issettja l-env var `MOBILETTO_REDIS_PORT` , dan il-port se jintuża
301
-
302
- Mobiletto se jaħżen iċ-ċwievet redis kollha tiegħu bil-prefiss `_mobiletto__` . Tista' tibdel dan
303
- billi tissettja l-env var `MOBILETTO_REDIS_PREFIX` .
304
-
305
- Tista' wkoll tissettja caching għal kull konnessjoni bl-oġġett `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
- ### Ma tridx redis caching?
317
- Biex tiddiżattiva: għaddi `enabled: false` fl-oġġett `opts.redisConfig` tiegħek meta tistabbilixxi l-konnessjoni tiegħek.
318
-
319
- Kif diskuss hawn taħt, id-diżattivazzjoni tal-caching se jkollha effett negattiv fuq il-prestazzjoni u se twassal għal aktar talbiet
320
- għall-ħażna li int verament bżonn.
321
-
322
- ### Gwida dwar il-caching
323
- **Ħażna encrypted**: il-qari/kitba tal-ħażna encrypted hija biss ftit aktar bil-mod min-normal,
324
- iżda n-navigazzjoni madwar id-direttorji (li jagħmlu xi affarijiet) hija pjuttost għalja. Uża redis cache
325
- jagħtik spinta sinifikanti fil-prestazzjoni.
326
-
327
- Il-cache default huwa sigur, iżda ma jwettaqx tajjeb jekk għandek ħafna operazzjonijiet ta 'kitba/tneħħija.
328
- Kwalunkwe operazzjoni ta 'kitba jew tneħħija tinvalida l-cache kollu, u tiżgura li qari sussegwenti se tara l-
329
- l-aħħar bidliet.
330
-
331
- ### Għodod CLI
332
- Jekk qed tuża għodda CLI bħal [mobiletto-cli](https://www.npmjs.com/package/mobiletto-cli),
333
- definittivament trid li l-cache redis tkun attivata, peress li ddum matul invokazzjonijiet tal-kmand `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
- Il-kmand `mirror` jagħmel kopja ta' darba tal-fajls kollha minn mobiletto għal ieħor.
344
- Ma tmexxi l-ebda proċess biex iżżomm il-mera maż-żmien. Mexxi l-kmand `mirror` mill-ġdid
345
- biex tissinkronizza kwalunkwe fajl nieqes.
346
-
347
- Il-valur tar-ritorn minn `mirror` huwa oġġett sempliċi b'counters għal kemm fajls kienu b'suċċess
348
- riflessi u kemm fajls kellhom żbalji:
349
-
350
- {
351
- success: count-of-files-mirrored,
352
- errors: count-of-files-with-errors
353
- }
354
-
355
- TWISSIJA: Il-mirroring ta' settijiet ta' dejta kbar jista' jieħu ħafna ħin u juża ħafna bandwidth
356
-
357
- Bis-semantika tas-sejħiet `mirror` drabi tista' tkun konfuża biex tifhem min hu
358
- qarrej u min hu l-kittieb. Immaġinaha bħal dikjarazzjoni ta' assenjazzjoni: il-"mobiletto tax-xellug"
359
- hija l-ħaġa li qed tiġi assenjata lil (data riflessa bil-miktub), u l-"mobiletto tal-lemin" (il-
360
- argument għall-metodu `mirror` ) huwa l-valur li qed jiġi assenjat (id-data riflessa tinqara).
361
-
362
- ## Encryption trasparenti
363
- Ippermetti kodifikazzjoni trasparenti min-naħa tal-klijent:
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
- X'qiegħed jiġri? Direttorju separat ta' "dħul fid-direttorju" (direttorju) (kodifikat) isegwi liema fajls hemm f'dak
383
- direttorju (magħruf ukoll bħala d-direttorju dirent).
384
- * Il-kmand `list` jaqra l-fajls tad-dħul tad-direttorju, jiddeċifra kull mogħdija elenkata; imbagħad jirritorna metadata għal kull fajl
385
- * Kmandi tal- `list` huma aktar ineffiċjenti, speċjalment għal direttorji b'numru kbir ta' fajls
386
- * Il-kmand `write` jikteb fajls dirent fid-direttorju dirent ta' kull ġenitur, b'mod rikorsiv; imbagħad jikteb il-fajl
387
- * `write` se jġibu O(N) writes, b'N = depth fil-ġerarkija tad-direttorju
388
- * Il-kmand `remove` ineħħi l-fajl dirent korrispondenti, u l-ġenitur tiegħu jekk vojt, b'mod rikorsiv; imbagħad tneħħi l-fajl
389
- * Kmandi ta `remove` mhux rikursivi se jġarrbu qari O(N) u potenzjalment daqstant tħassir, b'N = fond fil-ġerarkija tad-direttorju
390
- * `remove` rikursivi fuq sistemi ta' fajls kbar u profondi jistgħu jkunu għaljin
391
-
392
- Innota li anke bil-kriptaġġ min-naħa tal-klijent attivat, avversarju b'viżibilità sħiħa fin-naħa tas-server kriptat tiegħek
393
- ħażna, anki mingħajr iċ-ċavetta, xorta jistgħu jaraw in-numru totali ta 'direttorji u kemm fajls huma f'kull wieħed, u ma
394
- xi sforz, skopri ftit jew l-istruttura ġenerali tal-ġerarkija tad-direttorju.
395
- *Nota: Uża struttura relattivament ċatta għal sigurtà aħjar.*
396
- L-avversarju ma jkunx jaf l-ismijiet tad-direttorji/fajls sakemm ma jkunux jafu wkoll l-encryption tiegħek
397
- ċavetta jew inkella kien ikkrekkjat b'suċċess l-encryption. L-imħatri kollha huma mitfija allura!
398
-
399
- ### Prestazzjoni u caching
400
- L-operazzjonijiet fuq il-ħażna kriptata jistgħu jkunu bil-mod. Listi u tneħħija rikorsivi jistgħu jkunu bil-mod ħafna.
401
- Il-caching permezz ta' redis jgħin bil-kbir, iżda innota li l-cache titlaħlaħ fuq kwalunkwe kitba jew tneħħija.
402
-
403
- ## Rotazzjoni taċ-ċavetta
404
- Oħloq mobiletto biċ-ċavetta l-ġdida tiegħek, imbagħad immarka d-dejta l-antika fiha:
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
- ## Interfaċċja tas-sewwieq
417
- Driver huwa kwalunkwe fajl JS li jesporta funzjoni 'storageClient' b'din il-firma:
418
-
419
- function storageClient (key, secret, opts)
420
-
421
- * `key` : string, iċ-ċavetta API tiegħek (għax-sewwieq `local` dan huwa d-direttorju bażi)
422
- * `secret` : string, is-sigriet tal-API tiegħek (jista' jitħalla barra għas-sewwieq `local` )
423
- * `opts` : oġġett, il-proprjetajiet huma għal kull sewwieq:
424
- * Għal `local` , il- `fileMode` " u `dirMode` jiddeterminaw kif jinħolqu fajls u direttorji ġodda li joħolqu
425
- * Għal `s3` , il-proprjetà `bucket` hija meħtieġa. Proprjetajiet fakultattivi huma:
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
- L-oġġett li l-funzjoni storageClient jirritorna għandu jiddefinixxi dawn il-funzjonijiet:
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
- ## Logging
457
- Mobiletto juża l-librerija tal-illoggjar [winston](https://www.npmjs.com/package/winston).
458
-
459
- Iz-zkuk **se** ikun fihom mogħdijiet tal-fajls u messaġġi ta' żball, iżda **qatt** se jkun fihom ċwievet, sigrieti,
460
- jew kwalunkwe informazzjoni oħra dwar il-konfigurazzjoni tal-konnessjoni.
461
-
462
- ### Livell ta’ log
463
- Uża l-varjabbli tal-ambjent `MOBILETTO_LOG_LEVEL` biex tissettja l-livell tal-log, billi tuża waħda
464
- tal-livelli `npm` definiti fi [https://www.npmjs.com/package/winston#logging-levels](https://www.npmjs.com/package/winston#logging-levels)
465
-
466
- Il-livell default huwa `error` . L-aktar livell verbose huwa `silly` , għalkemm bħalissa mobiletto
467
- ma jilloggjax f'livelli taħt `debug`
468
-
469
- MOBILETTO_LOG_LEVEL=silly # maximum logs!
470
-
471
- ### Log file
472
- B'mod awtomatiku, il-logger jikteb fuq il-console. Biex tibgħat zkuk għal fajl, issettja l- `MOBILETTO_LOG_FILE`
473
- varjabbli ambjentali. Meta tilloggja għal fajl, zkuk ma jibqgħux jinkitbu fuq il-console.
474
-
475
- MOBILETTO_LOG_FILE=/var/my_mobiletto_log
476
-
477
- Biex itfi l-illoggjar:
478
-
479
- MOBILETTO_LOG_FILE=/dev/null
480
-
481
- </pre>