mobiletto 1.1.8 → 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 (117) hide show
  1. package/README.md +56 -4
  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 +33 -17
  114. package/package.json +3 -2
  115. package/test/api.spec.js +319 -306
  116. package/util/logger.js +1 -1
  117. package/util/redis.js +1 -1
@@ -0,0 +1,455 @@
1
+ Mobiletto
2
+ ========
3
+
4
+ Mobiletto jẹ Layer abstraction ibi ipamọ JavaScript, pẹlu iyan fifi ẹnọ kọ nkan-ẹgbẹ alabara.
5
+
6
+ # Awọn akoonu
7
+ * [Kí nìdí Mobiletto?](#Kí nìdí-Mobiletto?)
8
+ * [Ibẹrẹ kiakia](#Ibẹrẹ-kia)
9
+ * [Mobiletto CLI](#mobiletto-cli)
10
+ * [Orisun](#Orisun)
11
+ * [Lilo ipilẹ](#Ipilẹ-lilo)
12
+ * [Metadata](#Metadata)
13
+ * [Ara agbewọle agbewọle miiran](#Aṣa miiran-import-ara)
14
+ * [Caching](#Caching)
15
+ * [Mirror](#Mirror)
16
+ * [Ìsekóòdù ti o han gbangba](#Transparent-ìsekóòdù)
17
+ * [Kọtini yiyi](#Kọtini-yiyi)
18
+ * [Oluwakọ ni wiwo](#Oluwakọ-ni wiwo)
19
+ * [Wọle](#Igi wọle)
20
+
21
+ # Ka eyi ni ede miiran
22
+ Iwe README.md yii ti ni itumọ, nipasẹ [hokeylization](https://github.com/cobbzilla/hokeylization), sinu
23
+ **[gbogbo ede ni atilẹyin nipasẹ Google Tumọ](https://cloud.google.com/translate/docs/languages)!**
24
+
25
+ Mo ni idaniloju pe ko pe, ṣugbọn Mo nireti pe o dara ju ohunkohun lọ!
26
+
27
+ [🇸🇦 Larubawa](../ar/README.md)
28
+ [🇧🇩 Ede Bengali](../bn/README.md)
29
+ [🇩🇪 Jẹmánì](../de/README.md)
30
+ [🇺🇸 English](../en/README.md)
31
+ [🇪🇸 Spani](../es/README.md)
32
+ [🇫🇷 Faranse](../fr/README.md)
33
+ [🇹🇩 Hausa](../ha/README.md)
34
+ [🇮🇳 Hindi](../hi/README.md)
35
+ [🇮🇩 Indonesian](../id/README.md)
36
+ [🇮🇹 Itali](../it/README.md)
37
+ [🇯🇵 Japanese](../ja/README.md)
38
+ [🇰🇷 Korean](../ko/README.md)
39
+ [🇮🇳 Maranthi](../mr/README.md)
40
+ [🇵🇱 Polish](../pl/README.md)
41
+ [🇧🇷 Portuguese](../pt/README.md)
42
+ [🇷🇺 Russian](../ru/README.md)
43
+ [🇰🇪 Swahili](../sw/README.md)
44
+ [🇵🇭 Tagalog](../tl/README.md)
45
+ [🇹🇷 Tọki](../tr/README.md)
46
+ [🇵🇰 Urdu](../ur/README.md)
47
+ [🇻🇳 Vietnamese](../vi/README.md)
48
+ [🇨🇳 Kannada](../zh/README.md)
49
+
50
+
51
+ **[📚 ... Gbogbo Ede ...](../README.md)**
52
+ ----
53
+
54
+ ### Njẹ iṣoro kan wa pẹlu itumọ README yii?
55
+ Itumọ ni pato ti atilẹba [README](https://github.com/cobbzilla/mobiletto/blob/master/README.md)
56
+ le jẹ abawọn - * awọn atunṣe ṣe itẹwọgba pupọ!* Jọwọ fi ibeere kan ranṣẹ si GitHub (https://github.com/cobbzilla/mobiletto/pulls),
57
+ tabi ti o ko ba ni itunu lati ṣe iyẹn, [ṣii ọrọ kan](https://github.com/cobbzilla/mobiletto/issues)
58
+
59
+ Nigbati o ba ṣẹda ọrọ GitHub tuntun nipa itumọ kan, jọwọ ṣe:
60
+ * pẹlu URL oju-iwe naa (daakọ/lẹẹmọ lati ọpa adirẹsi aṣawakiri)
61
+ * pẹlu ọrọ gangan ti o jẹ aṣiṣe (daakọ/lẹẹmọ lati ẹrọ aṣawakiri)
62
+ * Jọwọ ṣapejuwe ohun ti ko tọ -- ṣe itumọ naa ko tọ? ti wa ni awọn kika baje bakan?
63
+ * Fi inurere funni ni imọran itumọ ti o dara julọ, tabi bi o ṣe yẹ ki ọrọ naa ṣe tito daradara
64
+ * **E dupe!**
65
+
66
+ ## Kí nìdí Mobiletto?
67
+
68
+ ### Titiipa olutaja o dabọ!
69
+ Awọn oriṣiriṣi awọn olupese ibi ipamọ awọsanma ni awọn API ti ko ni ibamu. Paapaa awọn ti o tiraka fun “ibamu S3”
70
+ ni awọn iwa idiosyncratic.
71
+
72
+ Nigbati o ba yan olutaja ibi ipamọ kan pato fun app rẹ, ti o ba koodu taara si API wọn, app rẹ
73
+ ni bayi ti o gbẹkẹle iṣẹ yẹn. Bi akoko ti n lọ ati pe koodu kojọpọ, awọn olutaja iyipada di
74
+ increasingly untenable. Kaabọ si agbaye igbadun ti titiipa ataja!
75
+
76
+ Mobiletto jẹ apẹrẹ lati yanju iṣoro yii. Nipa ifaminsi app rẹ si API mobiletto, o le ni irọrun
77
+ yi awọn olupese ibi ipamọ pada ki o mọ pe Layer ibi ipamọ ohun elo rẹ yoo huwa bakanna.
78
+
79
+ ### Ayẹwo nla
80
+ Gbogbo awọn awakọ ni idanwo fun ihuwasi kanna pẹlu awọn idanwo 60+ fun awakọ kọọkan.
81
+ A ṣe idanwo gbogbo awakọ pẹlu gbogbo akojọpọ:
82
+ * Ìsekóòdù: mejeeji ṣiṣẹ ati alaabo
83
+ * Kaṣe Redis: mejeeji ṣiṣẹ ati alaabo
84
+
85
+ Ọna yii fun wa ni alaafia-ọkan pe mobiletto yoo huwa kanna laibikita iru awakọ ti o lo,
86
+ ati laibikita boya o jeki caching ati/tabi ìsekóòdù.
87
+
88
+ ### Awakọ support
89
+ Awọn awakọ ibi ipamọ Mobiletto lọwọlọwọ:
90
+ * `s3` : Amazon S3
91
+ * `b2` : Backblaze B2
92
+ * `local` : eto faili agbegbe
93
+
94
+ * Awọn ifunni lati ṣe atilẹyin awọn olupese ibi ipamọ awọsanma diẹ sii jẹ itẹwọgba!
95
+
96
+ ## mobiletto-cli
97
+ Mobiletto ti pinnu lati ṣee lo bi ile-ikawe nipasẹ koodu JavaScript miiran.
98
+
99
+ Lati ṣiṣẹ pẹlu mobiletto ni laini aṣẹ, lo [mobiletto-cli](https://www.npmjs.com/package/mobiletto-cli)
100
+
101
+ ## Orisun
102
+ * [mobiletto lori GitHub](https://github.com/cobbzilla/mobiletto)
103
+ * [mobiletto lori npm](https://www.npmjs.com/package/mobiletto)
104
+
105
+ ## Ibẹrẹ kiakia
106
+ Apeere kukuru nipa lilo awakọ mobiletto `s3` .
107
+
108
+ Koodu yii yoo ṣiṣẹ kanna ti awakọ ba jẹ `b2` tabi `local` .
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
+ ## Ipilẹ lilo
139
+ Apeere lọpọlọpọ diẹ sii, ti n ṣafihan pupọ julọ awọn ẹya ti a funni:
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
+ ## Metadata
241
+ Aṣẹ `metadata` da metadata pada nipa titẹ sii eto faili kan ṣoṣo.
242
+ Bakanna, iye ipadabọ lati pipaṣẹ `list` jẹ akojọpọ awọn nkan metadata.
243
+
244
+ Nkan metadata dabi eleyi:
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
+ Ohun-ini `type` le jẹ `file` , `dir` , `link` , tabi `special` .
255
+
256
+ Da lori iru awakọ, pipaṣẹ `list` le ma da gbogbo awọn aaye pada. Awọn ohun-ini `name` orukọ' ati `type`
257
+ yẹ ki o wa nigbagbogbo. Aṣẹ `metadata` ti o tẹle yoo da gbogbo awọn ohun-ini to wa pada.
258
+
259
+ ## Aṣa agbewọle miiran
260
+ Ṣe agbewọle module ti o ni iwọn ni kikun ki o lo iṣẹ `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
+ ## Caching
268
+ Mobiletto ṣiṣẹ dara julọ pẹlu kaṣe <a href="https://redis.io">redis</a> .
269
+
270
+ Mobiletto yoo gbiyanju lati sopọ si a redis apeere on 127.0.0.1:6379
271
+
272
+ O le fagilee ọkan ninu awọn wọnyi:
273
+ * Ṣeto `MOBILETTO_REDIS_HOST` env var, mobiletto so nibi dipo localhost
274
+ * Ṣeto `MOBILETTO_REDIS_PORT` env var, ibudo yii yoo ṣee lo
275
+
276
+ Mobiletto yoo fi gbogbo awọn bọtini redis pamọ pẹlu ìpele `_mobiletto__` . O le yi eyi pada
277
+ nipa `MOBILETTO_REDIS_PREFIX` env var.
278
+
279
+ O tun le ṣeto caching fun-asopọ pẹlu ohun `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
+ ### Ṣe o ko fẹ caching redis?
291
+ Lati mu: kọja `enabled: false` ninu ohun `opts.redisConfig` rẹ nigbati o ba fi idi asopọ rẹ mulẹ.
292
+
293
+ Gẹgẹbi a ti jiroro ni isalẹ, piparẹ caching yoo ni ipa ti ko dara lori iṣẹ ṣiṣe ati fa awọn ibeere diẹ sii
294
+ si ibi ipamọ ti o nilo gaan.
295
+
296
+ ### Caching itoni
297
+ ** Ibi ipamọ ti paroko ***: kika / kikọ ibi ipamọ fifi ẹnọ kọ nkan jẹ o lọra diẹ ju deede,
298
+ ṣugbọn lilọ kiri ni ayika awọn ilana (eyiti diẹ ninu awọn nkan ṣe) jẹ gbowolori gaan. Lilo kaṣe redis
299
+ yoo fun ọ ni ilọsiwaju iṣẹ ṣiṣe pataki.
300
+
301
+ Kaṣe aiyipada jẹ ailewu, ṣugbọn ko ṣiṣẹ daradara ti o ba ni ọpọlọpọ kikọ / yọ awọn iṣẹ kuro.
302
+ Eyikeyi iṣẹ kikọ tabi yọkuro sọ gbogbo kaṣe di asan, ni idaniloju awọn kika ti o tẹle yoo rii
303
+ titun ayipada.
304
+
305
+ ### CLI irinṣẹ
306
+ Ti o ba n lo ohun elo CLI bii [mobiletto-cli](https://www.npmjs.com/package/mobiletto-cli),
307
+ dajudaju iwọ yoo fẹ ki kaṣe redis ṣiṣẹ, bi o ti wa kọja awọn ẹbẹ ti pipaṣẹ `mo` .
308
+
309
+ ## Mirroring
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
+ Aṣẹ `mirror` n ṣe ẹda ẹyọkan ti gbogbo awọn faili lati alagbeka si miiran.
318
+ Ko ṣe ilana eyikeyi lati ṣetọju digi ni akoko pupọ. Ṣiṣe aṣẹ `mirror` lẹẹkansi
319
+ lati muuṣiṣẹpọ eyikeyi awọn faili ti o padanu.
320
+
321
+ Iye ipadabọ lati `mirror` jẹ ohun ti o rọrun pẹlu awọn iṣiro fun iye awọn faili ti o ṣaṣeyọri
322
+ digi ati melo ni awọn faili ti ni awọn aṣiṣe:
323
+
324
+ {
325
+ success: count-of-files-mirrored,
326
+ errors: count-of-files-with-errors
327
+ }
328
+
329
+ IKILO: Digiri awọn eto data nla le jẹ akoko-n gba ati bandiwidi-lekoko
330
+
331
+ Pẹlu awọn `mirror` o le jẹ airoju nigbakan lati ni oye tani
332
+ oluka ati tani onkqwe. Fojuinu rẹ bi alaye iyansilẹ: “mobiletto ọwọ osi”
333
+ jẹ ohun ti a yàn si (awọn data digi ti a kọ), ati "mobiletto ọwọ ọtun" (awọn
334
+ ariyanjiyan si ọna `mirror` ) ni iye ti a yàn (awọn data digi ti wa ni kika).
335
+
336
+ ## Sihin ìsekóòdù
337
+ Mu fifi ẹnọ kọ nkan si ẹgbẹ onibara ṣiṣẹ:
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
+ Kilo n ṣẹlẹ? Itọkasi "titẹsi iwe-ilana" (itọkasi) itọsọna (ti paroko) tọpinpin kini awọn faili wa ninu iyẹn
357
+ liana (aka awọn dirent liana).
358
+ * Aṣẹ `list` ka awọn faili titẹ sii liana, decrypts kọọkan ọna ti a ṣe akojọ; lẹhinna da metadata pada fun faili kọọkan
359
+ * Awọn pipaṣẹ `list` diẹ sii, pataki fun awọn ilana pẹlu nọmba nla ti awọn faili
360
+ * Aṣẹ `write` kọ awọn faili ti o taara sinu itọsọna taara ti obi kọọkan, leralera; lẹhinna kọ faili naa
361
+ Awọn aṣẹ `write` yoo fa O(N) kọ, pẹlu N = ijinle ninu awọn ilana ilana
362
+ * Aṣẹ `remove` yọ faili dirant ti o baamu kuro, ati obi rẹ ti o ba ṣofo, leralera; lẹhinna yọ faili naa kuro
363
+ * Awọn aṣẹ `remove` ṣe loorekoore yoo fa kika O(N) ati agbara bi ọpọlọpọ paarẹ, pẹlu N = ijinle ninu awọn ilana ilana
364
+ * Awọn pipaṣẹ `remove` lori awọn ọna ṣiṣe faili nla ati jin le jẹ gbowolori
365
+
366
+ Ṣe akiyesi pe paapaa pẹlu fifi ẹnọ kọ nkan-ẹgbẹ alabara ṣiṣẹ, ọta kan pẹlu hihan ni kikun si ẹgbẹ olupin ti paroko rẹ
367
+ ibi ipamọ, paapaa laisi bọtini, tun le rii nọmba lapapọ ti awọn ilana ati iye awọn faili ti o wa ninu ọkọọkan, ati pẹlu
368
+ diẹ ninu awọn akitiyan , iwari diẹ ninu awọn tabi gbogbo awọn ti awọn ìwò be ti awọn logalomomoise liana.
369
+ * Akiyesi: Lo eto alapin kan fun aabo to dara julọ.
370
+ Ọta naa ko ni mọ awọn orukọ ti awọn ilana/faili ayafi ti wọn tun mọ fifi ẹnọ kọ nkan rẹ
371
+ bọtini tabi bibẹẹkọ ti ṣaṣeyọri sisan fifi ẹnọ kọ nkan naa. Gbogbo awọn tẹtẹ wa ni pipa lẹhinna!
372
+
373
+ ### Performance ati caching
374
+ Awọn iṣẹ lori ibi ipamọ ti paroko le lọra. Awọn atokọ atunṣe ati awọn yiyọ kuro le lọra pupọ.
375
+ Caching nipasẹ redis ṣe iranlọwọ lọpọlọpọ, ṣugbọn ṣe akiyesi pe kaṣe naa ti fọ lori eyikeyi kikọ tabi yọkuro.
376
+
377
+ ## Yiyi bọtini
378
+ Ṣẹda mobiletto pẹlu bọtini titun rẹ, lẹhinna digi data atijọ sinu rẹ:
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
+ ## Iwakọ ni wiwo
391
+ Awakọ jẹ eyikeyi faili JS ti o ṣe okeere iṣẹ 'ipamọClient' pẹlu ibuwọlu yii:
392
+
393
+ function storageClient (key, secret, opts)
394
+
395
+ * `key` : okun kan, bọtini API rẹ (fun awakọ `local` eyi ni itọsọna ipilẹ)
396
+ * `secret` : okun kan, aṣiri API rẹ (le jẹ yọkuro fun awakọ `local` )
397
+ * `opts` : ohun kan, awọn ohun-ini jẹ fun awakọ kan:
398
+ * Fun `local` , awọn `fileMode` ati `dirMode` ini pinnu bi ṣiṣẹda titun awọn faili ati awọn ilana ti wa ni da
399
+ * Fun `s3` , ohun-ini `bucket` ni a nilo. Awọn ohun-ini iyan jẹ:
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
+ Nkan ti ibi ipamọ iṣẹ Onibara pada gbọdọ ṣalaye awọn iṣẹ wọnyi:
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
+ ## Wọle
431
+ Mobiletto nlo [winston](https://www.npmjs.com/package/winston) ile-ikawe gedu.
432
+
433
+ Awọn akọọlẹ ** yoo ni awọn ọna faili ati awọn ifiranṣẹ aṣiṣe, ṣugbọn kii yoo ni awọn bọtini, awọn aṣiri,
434
+ tabi eyikeyi alaye iṣeto ni asopọ miiran.
435
+
436
+ ### Ipele Wọle
437
+ Lo iyipada ayika `MOBILETTO_LOG_LEVEL` lati ṣeto ipele akọọlẹ, ni lilo ọkan
438
+ ti awọn ipele `npm` ti ṣalaye ni [https://www.npmjs.com/package/winston#logging-levels](https://www.npmjs.com/package/winston#logging-levels)
439
+
440
+ Ipele aiyipada jẹ `error` . Awọn julọ verbose ipele ni `silly` , biotilejepe Lọwọlọwọ mobiletto
441
+ ko wọle ni awọn ipele ni isalẹ `debug`
442
+
443
+ MOBILETTO_LOG_LEVEL=silly # maximum logs!
444
+
445
+ ### Faili wọle
446
+ Nipa aiyipada, logger kọwe si console. Lati fi awọn akọọlẹ ranṣẹ si faili kan, ṣeto `MOBILETTO_LOG_FILE`
447
+ oniyipada ayika. Nigbati o ba wọle si faili kan, awọn akọọlẹ kii yoo kọ si console mọ.
448
+
449
+ MOBILETTO_LOG_FILE=/var/my_mobiletto_log
450
+
451
+ Lati pa gedu:
452
+
453
+ MOBILETTO_LOG_FILE=/dev/null
454
+
455
+ </pre>