mobiletto 1.2.0 → 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 (127) 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 -10
  123. package/test/api.spec.js +0 -512
  124. package/test/crypt.spec.js +0 -67
  125. package/util/crypt.js +0 -80
  126. package/util/logger.js +0 -27
  127. package/util/redis.js +0 -233
package/docs/sw/README.md DELETED
@@ -1,481 +0,0 @@
1
- Mobiletto
2
- ==========
3
-
4
- Mobiletto ni safu ya uondoaji ya hifadhi ya JavaScript, iliyo na usimbaji fiche wa hiari wa uwazi wa upande wa mteja.
5
-
6
- # Yaliyomo
7
- * [Kwa nini Mobiletto?](#Kwa nini-Mobiletto?)
8
- * [Kuanza kwa haraka](#Kuanza kwa haraka)
9
- * [Mobiletto CLI](#mobiletto-cli)
10
- * [Chanzo](#Chanzo)
11
- * [Usakinishaji](#Usakinishaji)
12
- * [Msaada na Ufadhili](#Msaada-na-Ufadhili)
13
- * [Matumizi ya kimsingi](#Matumizi-msingi)
14
- * [Metadata](#Metadata)
15
- * [Mtindo mbadala wa uingizaji](#Mtindo-Mbadala-kuagiza)
16
- * [Ukihifadhi](#Uhifadhi)
17
- * [Kuakisi](#Kuakisi)
18
- * [Usimbaji fiche wa Uwazi](#Usimbaji fiche kwa Uwazi)
19
- * [Mzunguko muhimu](#Mzunguko wa ufunguo)
20
- * [Kiolesura cha dereva](#Kiolesura cha kiendeshi)
21
- * [Kuweka kumbukumbu](#Kuweka kumbukumbu)
22
-
23
- # Soma hii kwa lugha nyingine
24
- Hati hii ya README.md imetafsiriwa, kupitia [hokeylization](https://github.com/cobbzilla/hokeylization), hadi
25
- **[kila lugha inayotumika na Google Tafsiri](https://cloud.google.com/translate/docs/languages)!**
26
-
27
- Nina hakika sio kamili, lakini natumai ni bora kuliko chochote!
28
-
29
- [🇸🇦 Kiarabu](hati/ar/README.md)
30
- [🇧🇩 Kibengali](hati/bn/README.md)
31
- [🇩🇪 Kijerumani](../de/README.md)
32
- [🇺🇸 Kiingereza]( hati/sw/README.md)
33
- [🇪🇸 Kihispania](hati/es/README.md)
34
- [🇫🇷 Kifaransa](../fr/README.md)
35
- [🇹🇩 Kihausa](hati/ha/README.md)
36
- [🇮🇳 Kihindi](hati/hi/README.md)
37
- [🇮🇩 Kiindonesia](hati/id/README.md)
38
- [🇮🇹 Kiitaliano](hati/it/README.md)
39
- [🇯🇵 Kijapani](hati/ja/README.md)
40
- [🇰🇷 Kikorea](hati/ko/README.md)
41
- [🇮🇳 Marathi](hati/mr/README.md)
42
- [🇵🇱 Kipolandi](hati/pl/README.md)
43
- [🇧🇷 Kireno](hati/pt/README.md)
44
- [🇷🇺 Kirusi](hati/ru/README.md)
45
- [🇰🇪 Kiswahili](hati/sw/README.md)
46
- [🇵🇭 Tagalog](../tl/README.md)
47
- [🇹🇷 Kituruki](hati/tr/README.md)
48
- [🇵🇰 Kiurdu](hati/ur/README.md)
49
- [🇻🇳 Kivietinamu](hati/vi/README.md)
50
- [🇨🇳 Kichina](hati/zh/README.md)
51
-
52
-
53
- **[📚 ... Lugha Zote ...](hati/README.md)**
54
- ----
55
-
56
- ### Je, kuna tatizo katika tafsiri hii ya README?
57
- Tafsiri hii mahususi ya [README](https://github.com/cobbzilla/mobiletto/blob/master/README.md)
58
- inaweza kuwa na dosari -- *marekebisho yanakaribishwa sana!* Tafadhali tuma [ombi la kuvuta kwenye GitHub](https://github.com/cobbzilla/mobiletto/pulls),
59
- au ikiwa huna raha kufanya hivyo, [fungua toleo](https://github.com/cobbzilla/mobiletto/issues)
60
-
61
- Unapounda toleo jipya la GitHub kuhusu tafsiri, tafadhali fanya:
62
- * jumuisha URL ya ukurasa (nakili/bandika kutoka kwa upau wa anwani ya kivinjari)
63
- * jumuisha maandishi kamili ambayo sio sahihi (nakili/bandika kutoka kwa kivinjari)
64
- * tafadhali eleza kilicho kibaya -- je tafsiri si sahihi? umbizo limevunjika kwa namna fulani?
65
- * tafadhali toa pendekezo la tafsiri bora zaidi, au jinsi maandishi yanapaswa kupangwa vizuri
66
- * **Asante!**
67
-
68
- ## Kwa nini Mobiletto?
69
-
70
- ### Kwaheri kufuli kwa muuzaji!
71
- Watoa huduma mbalimbali wa hifadhi ya wingu wana API zisizooana. Hata wale wanaojitahidi "utangamano wa S3"
72
- kuwa na tabia za kijinga.
73
-
74
- Unapochagua mchuuzi mahususi wa hifadhi ya programu yako, ukiweka nambari moja kwa moja kwenye API yake, programu yako
75
- sasa inategemea huduma hiyo. Kadiri muda unavyosonga na msimbo hujilimbikiza, kubadilisha wachuuzi huwa
76
- inazidi kutokubalika. Karibu katika ulimwengu wa kufurahisha wa kufuli kwa muuzaji!
77
-
78
- Mobiletto iliundwa kutatua tatizo hili. Kwa kusimba programu yako kwa API ya mobiletto, unaweza kwa urahisi
79
- badilisha watoa huduma za hifadhi na ujue kuwa safu ya hifadhi ya programu yako itafanya kazi sawa.
80
-
81
- ### Jaribio la kina
82
- Viendeshaji vyote hujaribiwa kwa tabia inayofanana na vipimo 60+ kwa kila dereva.
83
- Tunajaribu madereva wote na kila mchanganyiko wa:
84
- * Usimbaji fiche: umewezeshwa na umezimwa
85
- * Redis cache: zote mbili zimewashwa na zimezimwa
86
-
87
- Mbinu hii inatupa amani ya akili kwamba mobiletto itafanya vivyo hivyo bila kujali unatumia dereva gani,
88
- na bila kujali kama unawezesha uakibishaji na/au usimbaji fiche.
89
-
90
- ### Usaidizi wa madereva
91
- Viendeshi vya sasa vya uhifadhi wa Mobiletto:
92
- * `s3` : Amazon S3
93
- * `b2` : Backblaze B2
94
- * `local` : mfumo wa faili wa ndani
95
-
96
- *Michango ya kusaidia watoa huduma zaidi wa hifadhi ya wingu inakaribishwa sana!*
97
-
98
- ## mobiletto-cli
99
- Mobiletto imekusudiwa kutumiwa kama maktaba na msimbo mwingine wa JavaScript.
100
-
101
- Ili kufanya kazi na mobiletto kwenye safu ya amri, tumia [mobiletto-cli](https://www.npmjs.com/package/mobiletto-cli)
102
-
103
- ## Chanzo
104
- * [mobiletto kwenye GitHub](https://github.com/cobbzilla/mobiletto)
105
- * [mobiletto kwenye npm](https://www.npmjs.com/package/mobiletto)
106
-
107
- ## Msaada na Ufadhili
108
- Ninajaribu kuwa mtaalamu wa kuunda programu huria. Nimekuwa nikifanya kazi ndani
109
- tasnia ya programu kwa miaka mingi, nimeanzisha kampuni zilizofanikiwa na kuziuza kwa kampuni za umma.
110
- Hivi majuzi nilipoteza kazi yangu, na kwa kweli sina kazi nyingine yoyote iliyopangwa
111
-
112
- Kwa hivyo nitajaribu kuandika programu muhimu na kuona ikiwa hiyo inafanya kazi
113
-
114
- Ikiwa unafurahiya kutumia programu hii, ningeshukuru sana hata kwa
115
- ndogo zaidi [mchango wa kila mwezi kupitia Patreon](https://www.patreon.com/cobbzilla)
116
-
117
- *Asante!*
118
-
119
- ## Ufungaji
120
- Sakinisha kwa kutumia `npm` au `yarn` . Labda unataka toleo la `lite` ambalo halijumuishi faili zote
121
- faili za README zilizotafsiriwa:
122
-
123
- npm install mobiletto-lite
124
- yarn add mobiletto-lite
125
-
126
- Ikiwa unataka faili za README katika kila lugha, sakinisha toleo kamili:
127
-
128
- npm install mobiletto
129
- yarn add mobiletto
130
-
131
- ## Anza Haraka
132
- Mfano mfupi unaotumia kiendeshi cha mobiletto `s3` .
133
-
134
- Msimbo huu ungefanya kazi sawa ikiwa dereva angekuwa `b2` au `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
- ## Matumizi ya kimsingi
165
- Mfano mpana zaidi, unaoonyesha vipengele vingi vinavyotolewa:
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
- Amri ya `metadata` hurejesha metadata kuhusu ingizo moja la mfumo wa faili.
268
- Vile vile, thamani ya kurudi kutoka kwa amri `list` ni safu ya vipengee vya metadata.
269
-
270
- Kitu cha metadata kinaonekana kama hii:
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
- Sifa ya `type` inaweza kuwa `file` , `dir` , `link` , au `special` .
281
-
282
- Kulingana na aina ya kiendeshi, amri `list` inaweza isirejeshe sehemu zote. Sifa `name` na `type` aina`
283
- inapaswa kuwapo kila wakati. Amri ya `metadata` ifuatayo itarudisha sifa zote zinazopatikana.
284
-
285
- ## Mtindo mbadala wa kuingiza
286
- Ingiza moduli iliyo na upeo kamili na utumie kitendakazi cha `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
- ##Kuhifadhi
294
- Mobiletto hufanya kazi vyema ikiwa na akiba ya <a href="https://redis.io">redis</a> .
295
-
296
- Mobiletto itajaribu kuunganisha kwa mfano wa redis mnamo 127.0.0.1:6379
297
-
298
- Unaweza kubatilisha mojawapo ya haya:
299
- * Weka `MOBILETTO_REDIS_HOST` env var, mobiletto unganisha hapa badala ya localhost
300
- * Weka `MOBILETTO_REDIS_PORT` env var, mlango huu utatumika
301
-
302
- Mobiletto itahifadhi funguo zake zote za redis kwa kiambishi awali `_mobiletto__` . Unaweza kubadilisha hii
303
- kwa kuweka `MOBILETTO_REDIS_PREFIX` env var.
304
-
305
- Unaweza pia kuweka akiba kwa kila muunganisho kwa kitu `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
- ### Je, hutaki kuweka akiba upya?
317
- Ili kuzima: kupitisha `enabled: false` katika kitu chako cha `opts.redisConfig` muunganisho wako.
318
-
319
- Kama ilivyojadiliwa hapa chini, kuzima akiba kutakuwa na athari mbaya kwa utendakazi na kuleta maombi zaidi
320
- kwa uhifadhi ambao unahitaji kweli.
321
-
322
- ### Mwongozo wa kuweka akiba
323
- **Hifadhi iliyosimbwa kwa njia fiche**: kusoma/kuandika hifadhi iliyosimbwa ni polepole kidogo kuliko kawaida,
324
- lakini kuzunguka saraka (ambazo vitu vingine hufanya) ni ghali sana. Kutumia akiba ya redis
325
- itakupa uboreshaji mkubwa wa utendaji.
326
-
327
- Akiba chaguo-msingi ni salama, lakini haifanyi kazi vizuri ikiwa una shughuli nyingi za kuandika/kuondoa.
328
- Uendeshaji wowote wa kuandika au kuondoa hubatilisha akiba nzima, kuhakikisha usomaji unaofuata utaona
329
- mabadiliko ya hivi karibuni.
330
-
331
- ### Zana za CLI
332
- Ikiwa unatumia zana ya CLI kama [mobiletto-cli](https://www.npmjs.com/package/mobiletto-cli),
333
- hakika utataka akiba ya redis iwezeshwe, kwani inadumu katika maombi ya amri ya `mo` .
334
-
335
- ##Kuakisi
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
- Amri ya `mirror` hufanya nakala ya mara moja ya faili zote kutoka simu moja hadi nyingine.
344
- Haiendeshi mchakato wowote wa kudumisha kioo kwa wakati. Endesha amri ya `mirror` tena
345
- kusawazisha faili zozote zinazokosekana.
346
-
347
- Thamani ya kurejesha kutoka `mirror` ni kitu rahisi chenye vihesabio vya ni faili ngapi zilifanikiwa
348
- iliyoangaziwa na ni faili ngapi zilikuwa na makosa:
349
-
350
- {
351
- success: count-of-files-mirrored,
352
- errors: count-of-files-with-errors
353
- }
354
-
355
- ONYO: Kuakisi seti kubwa za data kunaweza kuchukua muda mwingi na kutumia kipimo data
356
-
357
- Kwa semantiki ya simu ya `mirror` inaweza wakati mwingine kuwa na utata kuelewa ni nani
358
- msomaji na mwandishi ni nani. Hebu fikiria kama taarifa ya mgawo: "mobiletto ya mkono wa kushoto"
359
- ni kitu kinachopewa (data iliyoakisiwa iliyoandikwa), na "mobiletto ya mkono wa kulia" (the
360
- hoja ya mbinu ya `mirror` ) ni thamani inayotolewa (data iliyoakisiwa inasomwa).
361
-
362
- ## Usimbaji fiche kwa uwazi
363
- Washa usimbaji fiche wa upande wa mteja wenye uwazi:
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
- Nini kinaendelea? Saraka tofauti ya "saraka" (dirent) (iliyosimbwa) hufuatilia ni faili gani zilizomo
383
- saraka (aka saraka ya mwelekeo).
384
- * Amri ya `list` inasoma faili za ingizo la saraka, inaondoa kila njia iliyoorodheshwa; kisha inarudisha metadata kwa kila faili
385
- * `list` zaidi, haswa kwa saraka zilizo na idadi kubwa ya faili
386
- * Amri ya `write` huandika faili dirent katika saraka ya kila mzazi, kwa kujirudia; kisha anaandika faili
387
- * amri za `write` ya O(N), na N = kina katika safu ya saraka.
388
- * Amri ya `remove` huondoa faili inayolingana ya dirent, na mzazi wake ikiwa tupu, kwa kujirudia; kisha huondoa faili
389
- * Amri zisizorudiwa za `remove` wa O(N) na uwezekano wa kufuta nyingi, na N = kina katika safu ya saraka.
390
- * Amri za `remove` kwenye mifumo mikubwa na ya kina ya faili zinaweza kuwa ghali
391
-
392
- Kumbuka kuwa hata usimbaji fiche wa upande wa mteja umewezeshwa, adui anayeonekana kikamilifu kwenye upande wako wa seva uliosimbwa.
393
- hifadhi, hata bila ufunguo, bado inaweza kuona jumla ya idadi ya saraka na faili ngapi ziko katika kila moja, na pamoja
394
- juhudi fulani, gundua baadhi au muundo wote wa jumla wa safu ya saraka.
395
- *Kumbuka: Tumia muundo tambarare kwa usalama bora.*
396
- Adui hangejua majina ya saraka/faili isipokuwa pia angejua usimbaji fiche wako
397
- ufunguo au amefaulu kuvunja usimbaji fiche. Dau zote zimezimwa basi!
398
-
399
- ### Utendaji na uakibishaji
400
- Uendeshaji kwenye hifadhi iliyosimbwa unaweza kuwa polepole. Uorodheshaji unaojirudia na uondoaji unaweza kuwa wa polepole sana.
401
- Uakibishaji kupitia redis husaidia sana, lakini kumbuka kuwa akiba huwekwa kwenye maandishi yoyote au kuondolewa.
402
-
403
- ## Mzunguko muhimu
404
- Unda mobiletto na ufunguo wako mpya, kisha uakisi data ya zamani ndani yake:
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
- ## Kiolesura cha dereva
417
- Dereva ni faili yoyote ya JS inayosafirisha kazi ya 'storageClient' na saini hii:
418
-
419
- function storageClient (key, secret, opts)
420
-
421
- * `key` : kamba, ufunguo wako wa API (kwa kiendeshi cha `local` hii ndio saraka ya msingi)
422
- * `secret` : kamba, siri yako ya API (inaweza kuachwa kwa kiendeshi cha `local` )
423
- * `opts` : kitu, mali ni kwa kila dereva:
424
- * Kwa `local` , sifa za `fileMode` na `dirMode` huamua jinsi faili na saraka mpya zinavyoundwa.
425
- * Kwa `s3` , mali ya `bucket` inahitajika. Sifa za hiari ni:
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
- Kitu ambacho kitendakazi cha kuhifadhiMteja kinarejesha lazima kifafanue vitendaji hivi:
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
- ## Uwekaji miti
457
- Mobiletto hutumia maktaba ya ukataji miti ya [winston](https://www.npmjs.com/package/winston).
458
-
459
- Kumbukumbu **itakuwa** na njia za faili na ujumbe wa makosa, lakini **haitawahi** kuwa na funguo, siri,
460
- au habari nyingine yoyote ya usanidi wa muunganisho.
461
-
462
- ### Kiwango cha kumbukumbu
463
- Tumia mabadiliko ya mazingira ya `MOBILETTO_LOG_LEVEL` ili kuweka kiwango cha kumbukumbu, ukitumia moja
464
- ya viwango vya `npm` vilivyofafanuliwa katika [https://www.npmjs.com/package/winston#logging-levels](https://www.npmjs.com/package/winston#logging-levels)
465
-
466
- Kiwango chaguo-msingi ni `error` . Kiwango cha kitenzi zaidi ni `silly` , ingawa kwa sasa mobiletto
467
- haiingii katika viwango chini `debug`
468
-
469
- MOBILETTO_LOG_LEVEL=silly # maximum logs!
470
-
471
- ### Faili ya kumbukumbu
472
- Kwa chaguo-msingi, logger anaandika kwa console. Ili kutuma kumbukumbu kwa faili, weka `MOBILETTO_LOG_FILE`
473
- kutofautiana kwa mazingira. Wakati wa kuingia kwenye faili, kumbukumbu hazitaandikwa tena kwa koni.
474
-
475
- MOBILETTO_LOG_FILE=/var/my_mobiletto_log
476
-
477
- Ili kuzima ukataji miti:
478
-
479
- MOBILETTO_LOG_FILE=/dev/null
480
-
481
- </pre>