mobiletto 1.1.10 → 1.1.11

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 (116) hide show
  1. package/README.md +48 -0
  2. package/docs/README.md +113 -0
  3. package/docs/af/README.md +455 -0
  4. package/docs/am/README.md +455 -0
  5. package/docs/ar/README.md +455 -0
  6. package/docs/az/README.md +455 -0
  7. package/docs/be/README.md +455 -0
  8. package/docs/bg/README.md +455 -0
  9. package/docs/bn/README.md +455 -0
  10. package/docs/bs/README.md +455 -0
  11. package/docs/ca/README.md +455 -0
  12. package/docs/ceb/README.md +455 -0
  13. package/docs/co/README.md +455 -0
  14. package/docs/cs/README.md +455 -0
  15. package/docs/cy/README.md +455 -0
  16. package/docs/da/README.md +455 -0
  17. package/docs/de/README.md +455 -0
  18. package/docs/el/README.md +455 -0
  19. package/docs/eo/README.md +455 -0
  20. package/docs/es/README.md +455 -0
  21. package/docs/et/README.md +455 -0
  22. package/docs/eu/README.md +455 -0
  23. package/docs/fa/README.md +455 -0
  24. package/docs/fi/README.md +455 -0
  25. package/docs/fr/README.md +455 -0
  26. package/docs/fy/README.md +455 -0
  27. package/docs/ga/README.md +455 -0
  28. package/docs/gd/README.md +455 -0
  29. package/docs/gl/README.md +455 -0
  30. package/docs/gu/README.md +455 -0
  31. package/docs/ha/README.md +455 -0
  32. package/docs/haw/README.md +455 -0
  33. package/docs/he/README.md +455 -0
  34. package/docs/hi/README.md +455 -0
  35. package/docs/hmn/README.md +455 -0
  36. package/docs/hr/README.md +455 -0
  37. package/docs/ht/README.md +455 -0
  38. package/docs/hu/README.md +455 -0
  39. package/docs/hy/README.md +455 -0
  40. package/docs/id/README.md +455 -0
  41. package/docs/ig/README.md +455 -0
  42. package/docs/is/README.md +455 -0
  43. package/docs/it/README.md +455 -0
  44. package/docs/iw/README.md +455 -0
  45. package/docs/ja/README.md +455 -0
  46. package/docs/jv/README.md +455 -0
  47. package/docs/ka/README.md +455 -0
  48. package/docs/kk/README.md +455 -0
  49. package/docs/km/README.md +455 -0
  50. package/docs/kn/README.md +455 -0
  51. package/docs/ko/README.md +455 -0
  52. package/docs/ku/README.md +455 -0
  53. package/docs/ky/README.md +455 -0
  54. package/docs/la/README.md +455 -0
  55. package/docs/lb/README.md +455 -0
  56. package/docs/lo/README.md +455 -0
  57. package/docs/lt/README.md +455 -0
  58. package/docs/lv/README.md +455 -0
  59. package/docs/mg/README.md +455 -0
  60. package/docs/mi/README.md +455 -0
  61. package/docs/mk/README.md +455 -0
  62. package/docs/ml/README.md +455 -0
  63. package/docs/mn/README.md +455 -0
  64. package/docs/mr/README.md +455 -0
  65. package/docs/ms/README.md +455 -0
  66. package/docs/mt/README.md +455 -0
  67. package/docs/my/README.md +455 -0
  68. package/docs/ne/README.md +455 -0
  69. package/docs/nl/README.md +455 -0
  70. package/docs/no/README.md +455 -0
  71. package/docs/ny/README.md +455 -0
  72. package/docs/or/README.md +455 -0
  73. package/docs/pa/README.md +455 -0
  74. package/docs/pl/README.md +455 -0
  75. package/docs/ps/README.md +455 -0
  76. package/docs/pt/README.md +455 -0
  77. package/docs/ro/README.md +455 -0
  78. package/docs/ru/README.md +455 -0
  79. package/docs/rw/README.md +455 -0
  80. package/docs/sd/README.md +455 -0
  81. package/docs/si/README.md +455 -0
  82. package/docs/sk/README.md +455 -0
  83. package/docs/sl/README.md +455 -0
  84. package/docs/sm/README.md +455 -0
  85. package/docs/sn/README.md +455 -0
  86. package/docs/so/README.md +455 -0
  87. package/docs/sq/README.md +455 -0
  88. package/docs/sr/README.md +455 -0
  89. package/docs/st/README.md +455 -0
  90. package/docs/su/README.md +455 -0
  91. package/docs/sv/README.md +455 -0
  92. package/docs/sw/README.md +455 -0
  93. package/docs/ta/README.md +455 -0
  94. package/docs/te/README.md +455 -0
  95. package/docs/tg/README.md +455 -0
  96. package/docs/th/README.md +455 -0
  97. package/docs/tk/README.md +455 -0
  98. package/docs/tl/README.md +455 -0
  99. package/docs/tr/README.md +455 -0
  100. package/docs/tt/README.md +455 -0
  101. package/docs/ug/README.md +455 -0
  102. package/docs/uk/README.md +455 -0
  103. package/docs/ur/README.md +455 -0
  104. package/docs/uz/README.md +455 -0
  105. package/docs/vi/README.md +455 -0
  106. package/docs/xh/README.md +455 -0
  107. package/docs/yi/README.md +455 -0
  108. package/docs/yo/README.md +455 -0
  109. package/docs/zh/README.md +455 -0
  110. package/docs/zu/README.md +455 -0
  111. package/drivers/b2/index.js +24 -6
  112. package/hokey.json +16 -0
  113. package/index.js +7 -2
  114. package/package.json +1 -1
  115. package/test/api.spec.js +12 -9
  116. package/util/redis.js +1 -1
@@ -0,0 +1,455 @@
1
+ Soghluaiste
2
+ ========
3
+
4
+ Is ciseal astarraingthe stórála JavaScript é Mobiletto, le criptiúchán trédhearcach roghnach ar thaobh an chliaint.
5
+
6
+ # Ábhar
7
+ * [Cén fáth Mobiletto?](#Why-Mobiletto?)
8
+ * [Tús tapa](#Quick-tús)
9
+ * [Mobiletto CLI](#mobiletto-cli)
10
+ * [Foinse](#Foinse)
11
+ * [Úsáid bhunúsach](#Basic-use)
12
+ * [Meiteashonraí](# Meiteashonraí)
13
+ * [Stíl mhalartach iompórtála](# Malartach-stíl iompórtála)
14
+ * [Taisce](#Taisce)
15
+ * [Scáthán](#Scáthán)
16
+ * [Criptiúchán trédhearcach](#Trédhearcach-criptiú)
17
+ * [Eochair-uainíocht](#Eochair-uainíocht)
18
+ * [Comhéadan tiománaí](# comhéadan tiománaí)
19
+ * [Logáil](#Logáil)
20
+
21
+ # Léigh é seo i dteanga eile
22
+ Aistríodh an doiciméad README.md seo, trí [hokeylization](https://github.com/cobbzilla/hokeylization), go
23
+ **[gach teanga a dtacaíonn Google Translate léi]( https://cloud.google.com/translate/docs/languages)!**
24
+
25
+ Tá mé cinnte nach bhfuil sé foirfe, ach tá súil agam go bhfuil sé níos fearr ná rud ar bith!
26
+
27
+ [🇸🇦 Araibis](../ar/README.md)
28
+ [🇧🇩 Beangáilis](../bn/README.md)
29
+ [🇩🇪 Gearmáinis](../de/README.md)
30
+ [🇺🇸 Béarla](../ga/README.md)
31
+ [🇪🇸 Spáinnis](../es/README.md)
32
+ [🇫🇷 Fraincis](../fr/README.md)
33
+ [🇹🇩 Hausa](../ha/README.md)
34
+ [🇮🇳 Hiondúis](../hi/README.md)
35
+ [🇮🇩 Indinéisis](../id/README.md)
36
+ [🇮🇹 Iodáilis](../it/README.md)
37
+ [🇯🇵 Seapáinis](../ja/README.md)
38
+ [🇰🇷 Cóiréis](../ko/README.md)
39
+ [🇮🇳 Maranthi](../mr/README.md)
40
+ [🇵🇱 Polainnis](../pl/README.md)
41
+ [🇧🇷 Portaingéilis](../pt/README.md)
42
+ [🇷🇺 Rúisis](../ru/README.md)
43
+ [🇰🇪 Svahaílis](../sw/README.md)
44
+ [🇵🇭 Tagálaigis](../tl/README.md)
45
+ [🇹🇷 Tuircis](../tr/README.md)
46
+ [🇵🇰 Urdais](../ur/README.md)
47
+ [🇻🇳 Vítneamais](../vi/README.md)
48
+ [🇨🇳 Sínis](../zh/README.md)
49
+
50
+
51
+ **[📚 ... Gach Teanga ...](../README.md)**
52
+ ----
53
+
54
+ ### An bhfuil fadhb leis an aistriúchán seo ar an README?
55
+ An t-aistriúchán áirithe seo ar an mbunleagan [README]( https://github.com/cobbzilla/mobiletto/blob/master/README.md)
56
+ seans go bhfuil sé lochtach -- *tá fáilte mhór roimh cheartúcháin!* Seol [iarratas tarraingthe ar GitHub](https://github.com/cobbzilla/mobiletto/pulls), le do thoil.
57
+ nó mura bhfuil tú compordach é sin a dhéanamh, [oscail ceist]( https://github.com/cobbzilla/mobiletto/issues)
58
+
59
+ Nuair a chruthaíonn tú saincheist nua GitHub faoi aistriúchán, déan:
60
+ * cuir isteach URL an leathanaigh (cóipeáil/greamaigh ó bharra seoltaí an bhrabhsálaí)
61
+ * cuir isteach an téacs cruinn atá mícheart (cóipeáil/greamaigh ón mbrabhsálaí)
62
+ * Déan cur síos le do thoil ar a bhfuil mícheart -- an bhfuil an t-aistriúchán mícheart? an bhfuil an fhormáidiú briste ar bhealach éigin?
63
+ * go cineálta moladh a thabhairt faoi aistriúchán níos fearr, nó conas is ceart an téacs a fhormáidiú i gceart
64
+ * **Go raibh maith agat!**
65
+
66
+ ## Cén fáth Mobiletto?
67
+
68
+ ### Slán glasáil isteach an díoltóra!
69
+ Tá APIanna neamh-chomhoiriúnacha ag na soláthraithe stórála scamall éagsúla. Fiú amháin iad siúd atá ag iarraidh "comhoiriúnacht S3"
70
+ iompraíochtaí uathúla a bheith agat.
71
+
72
+ Nuair a roghnaíonn tú díoltóir stórála ar leith do d’aip, má chódaíonn tú go díreach chuig a n-API, d’aip
73
+ ag brath ar an tseirbhís sin anois. De réir mar a théann an t-am thart agus an cód ag carnadh, éiríonn díoltóirí ag athrú
74
+ ag éirí dochosanta. Fáilte go dtí saol spraoi glasáil díoltóirí!
75
+
76
+ Dearadh Mobiletto chun an fhadhb seo a réiteach. Trí d'aip a chódú chuig API mobiletto, is féidir leat go héasca
77
+ athraigh soláthraithe stórála agus bíodh a fhios agat go n-iompróidh ciseal stórála d'aip mar an gcéanna.
78
+
79
+ ### Tástáil fhairsing
80
+ Déantar tástáil ar gach tiománaí le haghaidh iompraíochta comhionann le 60+ tástáil do gach tiománaí.
81
+ Déanaimid tástáil ar gach tiománaí le gach meascán de:
82
+ * Criptiú: cumasaithe agus díchumasaithe araon
83
+ * Taisce Redis: cumasaithe agus díchumasaithe araon
84
+
85
+ Tugann an cur chuige seo suaimhneas intinne dúinn go n-iompróidh mobiletto mar an gcéanna is cuma cén tiománaí a úsáideann tú,
86
+ agus is cuma má chumasaíonn tú taisceadh agus/nó criptiú.
87
+
88
+ ### Tacaíocht tiománaí
89
+ Tiománaithe stórála Mobiletto reatha:
90
+ * `s3` : Amazon S3
91
+ * `b2` : Cúlbhrat B2
92
+ * `local` : córas comhaid áitiúil
93
+
94
+ *Tá fáilte mhór roimh ranníocaíochtaí chun tacú le níos mó soláthraithe stórála scamall!*
95
+
96
+ ## mobiletto-cli
97
+ Tá sé beartaithe Mobiletto a úsáid mar leabharlann le cód JavaScript eile.
98
+
99
+ Chun oibriú le mobiletto ag an líne ordaithe, úsáid [mobiletto-cli]( https://www.npmjs.com/package/mobiletto-cli)
100
+
101
+ ## Foinse
102
+ * [mobiletto ar GitHub]( https://github.com/cobbzilla/mobiletto)
103
+ * [mobiletto ar npm]( https://www.npmjs.com/package/mobiletto)
104
+
105
+ ## Tús Tapa
106
+ Sampla gairid ag baint úsáide as an tiománaí `s3` .
107
+
108
+ Rithfeadh an cód seo mar an gcéanna dá mba `b2` nó `local` an tiománaí.
109
+
110
+ const storage = require('mobiletto')
111
+ const bucket = await storage.connect('s3', aws_key, aws_secret, {bucket: 'bk'})
112
+
113
+ // list objects: returns array of metadata objects
114
+ const listing = await bucket.list()
115
+ const dirList = await bucket.list('some/dir/')
116
+ const everything = await bucket.list('', {recursive: true})
117
+
118
+ // write an entire file
119
+ let bytesWritten = await bucket.writeFile('some/path', someBufferOfData)
120
+
121
+ // write a file from a stream/generator
122
+ bytesWritten = await bucket.write('some/path', streamOrGenerator)
123
+
124
+ // read an entire file
125
+ // returns null if an exception would otherwise be thrown
126
+ const bufferOrNull = await bucket.safeReadFile('some/path')
127
+
128
+ // stream-read a file, passing data to callback
129
+ const bytesRead = await bucket.read('some/path', (chunk) => { ...do something with chunk... } )
130
+
131
+ // remove a file, returns the path removed
132
+ let removed = await bucket.remove('some/path') // removed is a string
133
+
134
+ // remove a directory, returns array of paths removed
135
+ removed = await bucket.remove('some/directory', {recursive: true}) // removed is now an array!
136
+
137
+ ----
138
+ ## Bunúsáid
139
+ Sampla i bhfad níos fairsinge, ag taispeáint an chuid is mó de na gnéithe a thairgtear:
140
+
141
+ const { mobiletto } = require('mobiletto')
142
+
143
+ // General usage
144
+ const api = await mobiletto(driverName, key, secret, opts)
145
+
146
+ // To use 'local' driver:
147
+ // * key: base directory
148
+ // * secret: ignored, can be null
149
+ // * opts object:
150
+ // * readOnly: optional, never change anything on the filesystem; default is false
151
+ // * fileMode: optional, permissions used when creating new files, default is 0600. can be string or integer
152
+ // * dirMode: optional, permissions used when creating new directories, default is 0700. can be string or integer
153
+ const local = await mobiletto('local', '/home/ubuntu/tmp', null, {fileMode: 0o0600, dirMode: '0700'})
154
+
155
+ // To use 's3' driver:
156
+ // * key: AWS Access Key ID
157
+ // * secret: AWS Secret Key
158
+ // * opts object:
159
+ // * readOnly: optional, never change anything on the bucket; default is false
160
+ // * bucket: required, name of the S3 bucket
161
+ // * region: optional, the AWS region to communicate with, default is us-east-1
162
+ // * prefix: optional, all read/writes within the S3 bucket will be under this prefix
163
+ // * delimiter: optional, directory delimiter, default is '/' (note: always '/' when encryption is enabled)
164
+ const s3 = await mobiletto('s3', aws_key, aws_secret, {bucket: 'bk', region: 'us-east-1'})
165
+
166
+ // To use 'b2' driver:
167
+ // * key: Backblaze Key ID
168
+ // * secret: Backblaze Application Key
169
+ // * opts object:
170
+ // * readOnly: optional, never change anything on the bucket; default is false
171
+ // * bucket: required, the ID (**not the name**) of the B2 bucket
172
+ // * prefix: optional, all read/writes within the B2 bucket will be under this prefix
173
+ // * delimiter: optional, directory delimiter, default is '/' (note: always '/' when encryption is enabled)
174
+ // * partSize: optional, large files will be split into chunks of this size when uploading
175
+ const b3 = await mobiletto('b2', b2_key_id, b2_app_key, {bucket: 'bk', partSize: 10000000})
176
+
177
+ // List files
178
+ api.list() // --> returns an array of metadata objects
179
+
180
+ // List files recursively
181
+ api.list({ recursive: true })
182
+
183
+ // List files in a directory
184
+ const path = 'some/path'
185
+ api.list(path)
186
+ api.list(path, { recursive: true }) // also supports recursive flag
187
+
188
+ // Visit files in a directory -- visitor function must be async
189
+ api.list(path, { visitor: myAsyncFunc })
190
+ api.list(path, { visitor: myAsyncFunc, recursive: true })
191
+
192
+ // The `list` method throws MobilettoNotFoundError if the path does not exist
193
+ // When you call `safeList` on a non-existent path, it returns an empty array
194
+ api.safeList('/path/that/does/not/exist') // returns []
195
+
196
+ // Read metadata for a file
197
+ api.metadata(path) // returns metadata object
198
+
199
+ // The `metadata` method throws MobilettoNotFoundError if the path does not exist
200
+ // When you call `safeMetadata` on a non-existent path, it returns null
201
+ api.safeMetadata('/tmp/does_not_exist') // returns null
202
+
203
+ // Read a file
204
+ // Provide a callback that writes the data someplace
205
+ const callback = (chunk) => { ... write chunk somewhere ... }
206
+ api.read(path, callback) // returns count of bytes read
207
+
208
+ // Read an entire file at once
209
+ const data = await api.readFile(path) // returns a byte Buffer of the file contents
210
+
211
+ // Read an entire file at once
212
+ // returns null if an exception would otherwise be thrown
213
+ const bufferOrNull = await bucket.safeReadFile('some/path')
214
+
215
+ // Write a file
216
+ // Provide a generator function that yields chunks of data
217
+ const generator = function* () {
218
+ while ( ... more-data-to-return ... ) {
219
+ data = ... load-data ...
220
+ yield data
221
+ }
222
+ }
223
+ local.api(path, generator) // returns count of bytes written
224
+
225
+ // Write an entire file at once (convenience method)
226
+ await api.writeFile(path, bufferOrString) // returns count of bytes written
227
+
228
+ // Delete a file
229
+ // Quiet param is optional (default false), when set errors will not be thrown if the path does not exist
230
+ // Always returns a value or throws an error.
231
+ // Return value may be a single string of the file removed, or an array of all files removed (driver-dependent)
232
+ const quiet = true
233
+ api.remove(path, {quiet}) // returns single path removed
234
+
235
+ // Recursively delete a directory and do it quietly (do not report errors)
236
+ const recursive = true
237
+ const quiet = true
238
+ api.remove(path, {recursive, quiet}) // returns array of paths removed
239
+
240
+ ## Meiteashonraí
241
+ Tugann an t-ordú `metadata` ar ais maidir le hiontráil chóras comhad amháin.
242
+ Ar an gcaoi chéanna, is raon de réada meiteashonraí an luach tuairisceáin ón ordú `list` .
243
+
244
+ Breathnaíonn réad meiteashonraí mar seo:
245
+
246
+ {
247
+ "name": "fully/qualified/path/to/file",
248
+ "type": "entry-type",
249
+ "size": size-in-bytes,
250
+ "ctime": creation-time-epoch-millis,
251
+ "mtime": modification-time-epoch-millis
252
+ }
253
+
254
+ Is féidir an t-airí `type` a bheith mar `file` , `dir` , `link` , nó `special` .
255
+
256
+ Ag brath ar an gcineál tiománaí, ní fhéadfaidh ordú `list` gach réimse a thabhairt ar ais. Na hairíonna `name` agus `type`
257
+ chóir a bheith i láthair i gcónaí. Tabharfaidh ordú `metadata` ina dhiaidh sin na hairíonna go léir atá ar fáil ar ais.
258
+
259
+ ## Stíl iompórtála mhalartach
260
+ Iompórtáil an modúl lánscóip agus úsáid an fheidhm `connect` :
261
+
262
+ const storage = require('mobiletto')
263
+ const opts = {bucket: 'bk', region: 'us-east-1'}
264
+ const s3 = await storage.connect('s3', aws_key, aws_secret, opts)
265
+ const objectData = await s3.readFile('some/path')
266
+
267
+ ## Taisce
268
+ Is fearr a oibríonn Mobiletto le taisce <a href="https://redis.io">redis</a> .
269
+
270
+ Déanfaidh Mobiletto iarracht ceangal a dhéanamh le heisiamh redis ar 127.0.0.1:6379
271
+
272
+ Is féidir leat ceachtar díobh seo a shárú:
273
+ * Socraigh an `MOBILETTO_REDIS_HOST` var, mobiletto connect anseo in ionad localhost
274
+ * Socraigh an `MOBILETTO_REDIS_PORT` var, úsáidfear an port seo
275
+
276
+ Stórálfaidh Mobiletto a chuid eochracha redis go léir leis an réimír `_mobiletto__` . Is féidir leat é seo a athrú
277
+ tríd an `MOBILETTO_REDIS_PREFIX` var.
278
+
279
+ Is féidir leat taisce in aghaidh an naisc a shocrú freisin leis an réad `opts.redisConfig` :
280
+
281
+ const redisConfig = {
282
+ enabled: true, // optional, default is true. if false other props are ignored
283
+ host: '127.0.0.1',
284
+ port: 6379,
285
+ prefix: '_mobiletto__'
286
+ }
287
+ const opts = { redisConfig, bucket: 'bk', region: 'us-east-1' }
288
+ const s3 = await storage.connect('s3', aws_key, aws_secret, opts)
289
+
290
+ ### Níl tú ag iarraidh taisceadh redis?
291
+ Chun é a dhíchumasú: pas `enabled: false` i do réad `opts.redisConfig` nuair a bhunaíonn tú do nasc.
292
+
293
+ Mar a phléitear thíos, beidh drochthionchar ag baint le taisceadh a dhíchumasú ar fheidhmíocht agus tabhófar tuilleadh iarratas
294
+ a stóráil gur gá duit i ndáiríre.
295
+
296
+ ### Treoir caching
297
+ **Stóráil criptithe**: níl an stóráil chriptithe léitheoireachta/scríofa ach beagán níos moille ná mar is gnách,
298
+ ach tá sé costasach go leor dul timpeall ar eolairí (a dhéanann roinnt rudaí). Ag baint úsáide as redis cache
299
+ tabharfaidh sé borradh feidhmíochta suntasach duit.
300
+
301
+ Tá an taisce réamhshocraithe sábháilte, ach ní fheidhmíonn sé go maith má tá go leor oibríochtaí scríofa/bainte agat.
302
+ Déanann aon oibríocht scríofa nó bain an taisce iomlán neamhbhailí, ag cinntiú go bhfeicfidh léamha ina dhiaidh sin an taisce
303
+ athruithe is déanaí.
304
+
305
+ ### uirlisí CLI
306
+ Má tá uirlis CLI in úsáid agat mar [mobiletto-cli](https://www.npmjs.com/package/mobiletto-cli),
307
+ Is cinnte go mbeidh tú ag iarraidh go mbeidh an taisce redis cumasaithe, mar go maireann sé trasna agairt an ordú `mo` .
308
+
309
+ ##Scáthánú
310
+
311
+ // Copy a local filesystem mobiletto to S3
312
+ s3.mirror(local)
313
+
314
+ // Mirror a local subdirectory from one mobiletto to an S3 mobiletto, with it's own subdirectory
315
+ local.mirror(s3, 'some/local-folder', 'some/s3-folder')
316
+
317
+ Feidhmíonn an t-ordú `mirror` cóip aonuaire de na comhaid go léir ó mobileto amháin go ceann eile.
318
+ Ní reáchtálann sé aon phróiseas chun an scáthán a chothabháil le himeacht ama. Rith an t-ordú `mirror` arís
319
+ chun aon chomhaid atá in easnamh a shioncronú.
320
+
321
+ Is réad simplí é an luach aischuir ó `mirror` le cuntair le haghaidh cé mhéad comhad a d'éirigh leo
322
+ léirithe agus cé mhéad comhad a raibh earráidí ann:
323
+
324
+ {
325
+ success: count-of-files-mirrored,
326
+ errors: count-of-files-with-errors
327
+ }
328
+
329
+ RABHADH: Féadann sé go leor ama agus bandaleithead a bheith ag baint le scáthánú tacair shonraí mhóra
330
+
331
+ Leis an nglao shéimeantach `mirror` sé mearbhall a chur uaireanta a thuiscint cé hé an
332
+ léitheoir agus cé hé an scríbhneoir. Samhlaigh go bhfuil sé cosúil le ráiteas sannacháin: an "soghluaistetto láimhe clé"
333
+ an rud atá á shannadh do (sonraí scáthaithe scríofa), agus an “soghluaistetto láimhe deise” (an
334
+ argóint leis an modh `mirror` ) an luach atá á sannadh (léamh sonraí scáthánaithe).
335
+
336
+ ## Criptiú trédhearcach
337
+ Cumasaigh criptiúchán trédhearcach ar thaobh an chliaint:
338
+
339
+ // Pass encryption parameters
340
+ const encryption = {
341
+ // key is required, must be >= 16 chars
342
+ key: randomstring.generate(128),
343
+
344
+ // optional, the default is to derive IV from key
345
+ // when set, IV must be >= 16 chars
346
+ iv: randomstring.generate(128),
347
+
348
+ // optional, the default is aes-256-cbc
349
+ algo: 'aes-256-cbc'
350
+ }
351
+ const api = await mobiletto(driverName, key, secret, opts, encryption)
352
+
353
+ // Subsequent write operations will encrypt data (client side) when writing
354
+ // Subsequent read operations will decrypt data (client side) when reading
355
+
356
+ Cad atá ag tarlú? Rianaíonn eolaire ar leith “iontráil eolaire” (díreach) (criptithe) cad iad na comhaid atá ann
357
+ eolaire (aka an eolaire díreach).
358
+ * Léann an t-ordú `list` na comhaid iontrála eolaire, díchriptigh gach cosán atá liostaithe; ansin cuireann sé meiteashonraí ar ais do gach comhad
359
+ * Tá orduithe `list` níos mí-éifeachtach, go háirithe i gcás eolairí a bhfuil líon mór comhad acu
360
+ * Scríobhann an t-ordú `write` scríobh` comhaid dhíreacha i gcomhadlann dhírigh gach tuismitheora, go hathchúrsach; ansin scríobhann an comhad
361
+ *Tabhóidh O(N) orduithe `write` , le N = doimhneacht san ordlathas eolaire
362
+ * Baineann an t-ordú `remove` an comhad díreach comhfhreagrach, agus má tá a thuismitheoir folamh, go hathchúrsach; ansin bain an comhad
363
+ * `remove` neamh-athfhillteacha léite O(N) agus b'fhéidir an oiread scriosadh, le N = doimhneacht san ordlathas eolaire
364
+ * D’fhéadfadh orduithe `remove` athchúrsacha ar chórais comhaid mhóra agus dhomhain a bheith costasach
365
+
366
+ Tabhair faoi deara, fiú agus criptiúchán ar thaobh an chliaint cumasaithe, go bhfuil ionsaitheoir lán-infheictheachta ar thaobh do fhreastalaí criptithe
367
+ stórála, fiú gan an eochair, is féidir a fheiceáil fós ar an líon iomlán na n-eolairí agus cé mhéad comhad atá i ngach, agus le
368
+ iarracht éigin, faigh amach ar struchtúr iomlán an ordlathais eolaire, nó cuid de.
369
+ *Tabhair faoi deara: Bain úsáid as struchtúr measartha réidh le haghaidh slándála níos fearr.*
370
+ Ní bheadh ainmneacha na n-eolaire/comhad ar eolas ag an sáraí mura raibh do chriptiú ar eolas acu freisin
371
+ eochair nó gur éirigh leis an criptiúchán a scoilteadh. Tá gach geallta as sin!
372
+
373
+ ### Feidhmíocht agus taisceadh
374
+ Is féidir le hoibríochtaí ar stóráil criptithe a bheith mall. Is féidir le liostaí athfhillteacha agus aistrithe a bheith an-mhall.
375
+ Cabhraíonn taisceadh trí redis go mór, ach tabhair faoi deara go ndéantar an taisce a shruthlú ar aon scríobh nó a bhaintear.
376
+
377
+ ## Rothlú eochair
378
+ Cruthaigh mobiletto le d'eochair nua, ansin déan na seansonraí a scáthánú isteach ann:
379
+
380
+ const storage = require('mobiletto')
381
+
382
+ const oldEncryption = { key: .... }
383
+ const oldStorage = await storage.connect('s3', aws_key, aws_secret, {bucket: 'bk', region: 'us-east-1'}, oldEncryption)
384
+
385
+ const newEncryption = { key: .... }
386
+ const newStorage = await storage.connect('s3', aws_key, aws_secret, {bucket: 'zz', region: 'us-east-1'}, newEncryption)
387
+
388
+ newStorage.mirror(oldStorage) // if oldStorage is very large, this may take a looooooong time...
389
+
390
+ ## comhéadan tiománaí
391
+ Is ionann tiománaí agus aon chomhad JS a easpórtálann feidhm ‘storageClient’ leis an síniú seo:
392
+
393
+ function storageClient (key, secret, opts)
394
+
395
+ * `key` : teaghrán, d'eochair API (don tiománaí `local` is é seo an bunchomhadlann)
396
+ * `secret` : teaghrán, do rún API (is féidir é a fhágáil ar lár don tiománaí `local` )
397
+ * `opts` : réad, is iad na hairíonna in aghaidh an tiománaí:
398
+ * I gcás `local` , cinneann na `fileMode` agus `dirMode` conas a chruthaítear comhaid agus eolairí nuachruthaithe
399
+ * Le haghaidh `s3` , tá an mhaoin `bucket` ag teastáil. Is iad na hairíonna roghnacha:
400
+ * `region`: the S3 region, default is us-east-1
401
+ * `prefix`: a prefix to prepend to all S3 paths, default is the empty string
402
+ * `delimiter`: the directory delimiter, default is '/'
403
+
404
+ Caithfidh an réad a thugann an fheidhm storageClient ar ais na feidhmeanna seo a shainiú:
405
+
406
+ // Test the driver before using, ensure proper configuration
407
+ async testConfig ()
408
+
409
+ // List files in path (or from base-directory)
410
+ // If recursive is true, list recursively
411
+ // If visitor is defined, it will be an async function. await the visitor function on each file found
412
+ // Otherwise, perform the listing and return an array of objects
413
+ async list (path, recursive = false, visitor = null) // path may be omitted
414
+
415
+ // Read metadata for a path
416
+ async metadata (path)
417
+
418
+ // Read a file
419
+ // callback receives a chunk of data. endCallback is called at end-of-stream
420
+ async read (path, callback, endCallback = null)
421
+
422
+ // Write a file
423
+ // driver must be able to handle a generator or a stream
424
+ async write (path, generatorOrReadableStream)
425
+
426
+ // Remove a file, or recursively delete a directory
427
+ // returns a string of a single path removed, or an array of multiple paths removed
428
+ async remove (path, recursive = false, quiet = false)
429
+
430
+ ## Logáil
431
+ Úsáideann Mobiletto leabharlann logála [winston](https://www.npmjs.com/package/winston).
432
+
433
+ Beidh conairí comhaid agus teachtaireachtaí earráide i logaí**, ach **ní bheidh eochracha, rúin,
434
+ nó aon fhaisnéis chumraíochta ceangail eile.
435
+
436
+ ### Leibhéal logála
437
+ Úsáid an athróg timpeallachta `MOBILETTO_LOG_LEVEL` chun an leibhéal loga a shocrú, ag baint úsáide as ceann amháin
438
+ de na leibhéil `npm` atá sainmhínithe i [https://www.npmjs.com/package/winston#logging-levels](https://www.npmjs.com/package/winston#logging-levels)
439
+
440
+ Is é an leibhéal réamhshocraithe ná `error` . Is é an leibhéal is briathartha ná `silly` , cé go mobiletto faoi láthair
441
+ ní logálann sé ag leibhéil faoi bhun `debug`
442
+
443
+ MOBILETTO_LOG_LEVEL=silly # maximum logs!
444
+
445
+ ### Logchomhad
446
+ De réir réamhshocraithe, scríobhann an logálaí chuig an consól. Chun logaí a sheoladh chuig comhad, socraigh an `MOBILETTO_LOG_FILE`
447
+ athróg timpeallachta. Nuair a bheidh tú ag logáil isteach i gcomhad, ní scríobhfar logaí chuig an consól a thuilleadh.
448
+
449
+ MOBILETTO_LOG_FILE=/var/my_mobiletto_log
450
+
451
+ Chun logáil a mhúchadh:
452
+
453
+ MOBILETTO_LOG_FILE=/dev/null
454
+
455
+ </pre>