mobiletto 1.1.9 → 1.1.12

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 +82 -4
  2. package/docs/README.md +113 -0
  3. package/docs/af/README.md +481 -0
  4. package/docs/am/README.md +481 -0
  5. package/docs/ar/README.md +481 -0
  6. package/docs/az/README.md +481 -0
  7. package/docs/be/README.md +481 -0
  8. package/docs/bg/README.md +481 -0
  9. package/docs/bn/README.md +481 -0
  10. package/docs/bs/README.md +481 -0
  11. package/docs/ca/README.md +481 -0
  12. package/docs/ceb/README.md +481 -0
  13. package/docs/co/README.md +481 -0
  14. package/docs/cs/README.md +481 -0
  15. package/docs/cy/README.md +481 -0
  16. package/docs/da/README.md +481 -0
  17. package/docs/de/README.md +481 -0
  18. package/docs/el/README.md +481 -0
  19. package/docs/eo/README.md +481 -0
  20. package/docs/es/README.md +481 -0
  21. package/docs/et/README.md +481 -0
  22. package/docs/eu/README.md +481 -0
  23. package/docs/fa/README.md +481 -0
  24. package/docs/fi/README.md +481 -0
  25. package/docs/fr/README.md +481 -0
  26. package/docs/fy/README.md +481 -0
  27. package/docs/ga/README.md +481 -0
  28. package/docs/gd/README.md +481 -0
  29. package/docs/gl/README.md +481 -0
  30. package/docs/gu/README.md +481 -0
  31. package/docs/ha/README.md +481 -0
  32. package/docs/haw/README.md +481 -0
  33. package/docs/he/README.md +481 -0
  34. package/docs/hi/README.md +481 -0
  35. package/docs/hmn/README.md +481 -0
  36. package/docs/hr/README.md +481 -0
  37. package/docs/ht/README.md +481 -0
  38. package/docs/hu/README.md +481 -0
  39. package/docs/hy/README.md +481 -0
  40. package/docs/id/README.md +481 -0
  41. package/docs/ig/README.md +481 -0
  42. package/docs/is/README.md +481 -0
  43. package/docs/it/README.md +481 -0
  44. package/docs/iw/README.md +481 -0
  45. package/docs/ja/README.md +481 -0
  46. package/docs/jv/README.md +481 -0
  47. package/docs/ka/README.md +481 -0
  48. package/docs/kk/README.md +481 -0
  49. package/docs/km/README.md +481 -0
  50. package/docs/kn/README.md +481 -0
  51. package/docs/ko/README.md +481 -0
  52. package/docs/ku/README.md +481 -0
  53. package/docs/ky/README.md +481 -0
  54. package/docs/la/README.md +481 -0
  55. package/docs/lb/README.md +481 -0
  56. package/docs/lo/README.md +481 -0
  57. package/docs/lt/README.md +481 -0
  58. package/docs/lv/README.md +481 -0
  59. package/docs/mg/README.md +481 -0
  60. package/docs/mi/README.md +481 -0
  61. package/docs/mk/README.md +481 -0
  62. package/docs/ml/README.md +481 -0
  63. package/docs/mn/README.md +481 -0
  64. package/docs/mr/README.md +481 -0
  65. package/docs/ms/README.md +481 -0
  66. package/docs/mt/README.md +481 -0
  67. package/docs/my/README.md +481 -0
  68. package/docs/ne/README.md +481 -0
  69. package/docs/nl/README.md +481 -0
  70. package/docs/no/README.md +481 -0
  71. package/docs/ny/README.md +481 -0
  72. package/docs/or/README.md +481 -0
  73. package/docs/pa/README.md +481 -0
  74. package/docs/pl/README.md +481 -0
  75. package/docs/ps/README.md +481 -0
  76. package/docs/pt/README.md +481 -0
  77. package/docs/ro/README.md +481 -0
  78. package/docs/ru/README.md +481 -0
  79. package/docs/rw/README.md +481 -0
  80. package/docs/sd/README.md +481 -0
  81. package/docs/si/README.md +481 -0
  82. package/docs/sk/README.md +481 -0
  83. package/docs/sl/README.md +481 -0
  84. package/docs/sm/README.md +481 -0
  85. package/docs/sn/README.md +481 -0
  86. package/docs/so/README.md +481 -0
  87. package/docs/sq/README.md +481 -0
  88. package/docs/sr/README.md +481 -0
  89. package/docs/st/README.md +481 -0
  90. package/docs/su/README.md +481 -0
  91. package/docs/sv/README.md +481 -0
  92. package/docs/sw/README.md +481 -0
  93. package/docs/ta/README.md +481 -0
  94. package/docs/te/README.md +481 -0
  95. package/docs/tg/README.md +481 -0
  96. package/docs/th/README.md +481 -0
  97. package/docs/tk/README.md +481 -0
  98. package/docs/tl/README.md +481 -0
  99. package/docs/tr/README.md +481 -0
  100. package/docs/tt/README.md +481 -0
  101. package/docs/ug/README.md +481 -0
  102. package/docs/uk/README.md +481 -0
  103. package/docs/ur/README.md +481 -0
  104. package/docs/uz/README.md +481 -0
  105. package/docs/vi/README.md +481 -0
  106. package/docs/xh/README.md +481 -0
  107. package/docs/yi/README.md +481 -0
  108. package/docs/yo/README.md +481 -0
  109. package/docs/zh/README.md +481 -0
  110. package/docs/zu/README.md +481 -0
  111. package/drivers/b2/index.js +24 -6
  112. package/hokey.json +16 -0
  113. package/index.js +32 -16
  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,481 @@
1
+ Mobiletto
2
+ =========
3
+
4
+ Mobiletto dia sosona abstraction fitahirizana JavaScript, miaraka amin'ny encryption amin'ny lafiny mpanjifa mangarahara.
5
+
6
+ # Votoaty
7
+ * [Nahoana Mobiletto?](#Nahoana-Mobiletto?)
8
+ * [Fanombohana haingana](#Atomboka haingana)
9
+ * [Mobiletto CLI](#mobiletto-cli)
10
+ * [Loharano](#Source)
11
+ * [Fametrahana](#Fametrahana)
12
+ * [Fanohanana sy Famatsiam-bola](#Fanohanana-sy-Famatsiam-bola)
13
+ * [Fampiasana fototra](#Fampiasana fototra)
14
+ * [Metadata](#Metadata)
15
+ * [fomba fanafarana hafa](fomba #fanafarana hafa)
16
+ * [Caching](#Caching)
17
+ * [Mirroring](#Mirroring)
18
+ * [Fanafenoana mangarahara](#Fanafenana mangarahara)
19
+ * [Fihodinana lakile](#Fihodinana lakile)
20
+ * [Interface amin'ny mpamily](#interface amin'ny mpamily)
21
+ * [Logging](#Logging)
22
+
23
+ # Vakio amin'ny fiteny hafa ity
24
+ Ity antontan-taratasy README.md ity dia nadika, tamin'ny alàlan'ny [hokeylization](https://github.com/cobbzilla/hokeylization), ho amin'ny
25
+ **[ny fiteny rehetra tohanan'ny Google Translate](https://cloud.google.com/translate/docs/languages)!**
26
+
27
+ azoko antoka fa tsy tonga lafatra izany fa manantena aho fa tsara noho ny tsy misy!
28
+
29
+ [🇸🇦 Arabo](../ar/README.md)
30
+ [🇧🇩 Bengali](../bn/README.md)
31
+ [🇩🇪 Alemana](../de/README.md)
32
+ [🇺🇸 anglisy](../en/README.md)
33
+ [🇪🇸 Espaniola](../es/README.md)
34
+ [🇫🇷 frantsay](../fr/README.md)
35
+ [🇹🇩 Hausa](../ha/README.md)
36
+ [🇮🇳 Hindi](../hi/README.md)
37
+ [🇮🇩 Indoneziana](../id/README.md)
38
+ [🇮🇹 Italiana](../it/README.md)
39
+ [🇯🇵 Japoney](../ja/README.md)
40
+ [🇰🇷 Koreana](../ko/README.md)
41
+ [🇮🇳 Maranthi](../mr/README.md)
42
+ [🇵🇱 poloney](../pl/README.md)
43
+ [🇧🇷 Portiogey](../pt/README.md)
44
+ [🇷🇺 Rosiana](../ru/README.md)
45
+ [🇰🇪 Swahili](../sw/README.md)
46
+ [🇵🇭 Tagalog](../tl/README.md)
47
+ [🇹🇷 Tiorka](../tr/README.md)
48
+ [🇵🇰 Urdu](../ur/README.md)
49
+ [🇻🇳 vietnamiana](../vi/README.md)
50
+ [🇨🇳 Sinoa](../zh/README.md)
51
+
52
+
53
+ **[📚 ... Teny Rehetra ...](../README.md)**
54
+ ----
55
+
56
+ ### Misy olana ve amin'ity fandikana ny README ity?
57
+ Ity dikanteny manokana amin'ny [README] tany am-boalohany (https://github.com/cobbzilla/mobiletto/blob/master/README.md)
58
+ mety misy lesoka -- *tena raisina an-tanana ny fanitsiana!* Alefaso azafady [fangatahana fisarihana ao amin'ny GitHub](https://github.com/cobbzilla/mobiletto/pulls),
59
+ na raha tsy mahazo aina amin'izany ianao dia [manokatra olana](https://github.com/cobbzilla/mobiletto/issues)
60
+
61
+ Rehefa mamorona olana GitHub vaovao momba ny fandikan-teny ianao, azafady:
62
+ * Ampidiro ny URL pejy (adikao / apetaho amin'ny bara adiresy navigateur)
63
+ * Ampidiro ny lahatsoratra marina izay diso (kodikao / apetaho amin'ny navigateur)
64
+ * farito azafady izay tsy mety - diso ve ny dikanteny? simba ve ny format?
65
+ * Manomeza soso-kevitra amin-katsaram-panahy momba ny fandikan-teny tsara kokoa, na ny fomba tokony handrafetana ny lahatsoratra
66
+ * **Misaotra anao!**
67
+
68
+ ## Nahoana no Mobiletto?
69
+
70
+ ### Veloma mpivarotra mihidy!
71
+ Ireo mpamatsy fitahirizana rahona isan-karazany dia manana API tsy mifanaraka. Na dia ireo izay miezaka ny "S3 compatibility"
72
+ manana fitondrantena idiosyncratic.
73
+
74
+ Rehefa misafidy mpivarotra fitahirizana manokana ho an'ny app-nao ianao, raha kaody mivantana amin'ny API-ny ianao, dia ny app-nao
75
+ dia miankina amin'io serivisy io izao. Rehefa mandeha ny fotoana ary mihabetsaka ny kaody, dia lasa ny fiovan'ny mpivarotra
76
+ mihamitombo hatrany. Tongasoa eto amin'ny tontolon'ny mpivarotra hidy!
77
+
78
+ Mobiletto dia natao hamahana ity olana ity. Amin'ny alàlan'ny fametahana ny fampiharana anao amin'ny API mobiletto dia afaka mora foana ianao
79
+ ovay ny mpanome fitahirizana ary fantaro fa ny sosona fitahirizana ny fampiharanao dia hitovy fihetsika.
80
+
81
+ ### Fitsapana mivelatra
82
+ Ny mpamily rehetra dia voasedra amin'ny fihetsika mitovy amin'ny fitsapana 60+ ho an'ny mpamily tsirairay.
83
+ Mitsapa ny mpamily rehetra izahay miaraka amin'ny fitambaran'ny:
84
+ * Encryption: samy afaka na kilemaina
85
+ * Redis cache: samy afaka na kilemaina
86
+
87
+ Ity fomba fiasa ity dia manome antsika fiadanan-tsaina fa ny mobiletto dia hitondra tena mitovy na inona na inona mpamily ampiasainao,
88
+ ary na manao ahoana na manao caching sy/na encryption.
89
+
90
+ ### Fanohanana ny mpamily
91
+ Mpamily fitahirizana Mobiletto amin'izao fotoana izao:
92
+ * `s3` : Amazon S3
93
+ * `b2` : Backblaze B2
94
+ * `local` : rafi-drakitra eo an-toerana
95
+
96
+ * Tena raisina an-tanan-droa ny fandraisana anjara hanohanana ireo mpamatsy fitahirizana rahona!*
97
+
98
+ ## mobiletto-cli
99
+ Mobiletto dia natao hampiasaina ho tranomboky amin'ny code JavaScript hafa.
100
+
101
+ Raha hiasa amin'ny mobiletto amin'ny baikon'ny baiko, ampiasao [mobiletto-cli](https://www.npmjs.com/package/mobiletto-cli)
102
+
103
+ ## Loharano
104
+ * [mobiletto amin'ny GitHub](https://github.com/cobbzilla/mobiletto)
105
+ * [mobiletto amin'ny npm](https://www.npmjs.com/package/mobiletto)
106
+
107
+ ## Fanohanana sy famatsiam-bola
108
+ Miezaka ny ho matihanina mpamorona rindrambaiko open source aho. Niasa tao aho
109
+ ny indostrian'ny rindrambaiko nandritra ny taona maro, nanomboka orinasa nahomby aho ary nivarotra azy ireo tamin'ny orinasam-panjakana.
110
+ Vao haingana aho no very asa, ary tsy manana asa hafa milahatra
111
+
112
+ Noho izany dia hanandrana manoratra rindrambaiko mahasoa aho ary hijery raha mety izany
113
+
114
+ Raha mahafinaritra anao ny mampiasa an'ity logiciel ity dia ho feno fankasitrahana aho na dia ny
115
+ kely indrindra [fanomezana isam-bolana amin'ny alàlan'ny Patreon](https://www.patreon.com/cobbzilla)
116
+
117
+ *Misaotra anao!*
118
+
119
+ ## Fametrahana
120
+ Apetaho amin'ny fampiasana `npm` na `yarn` . Angamba tianao ny dikan-teny `lite` izay tsy ahitana ny rehetra
121
+ nadika ny rakitra README:
122
+
123
+ npm install mobiletto-lite
124
+ yarn add mobiletto-lite
125
+
126
+ Raha tena tianao ny rakitra README amin'ny fiteny rehetra, apetraho ny dikan-teny feno:
127
+
128
+ npm install mobiletto
129
+ yarn add mobiletto
130
+
131
+ ## Manomboka haingana
132
+ Ohatra fohy mampiasa ny mobiletto `s3` mpamily.
133
+
134
+ Ity kaody ity dia mandeha mitovy raha toa ka `b2` na `local` ny mpamily.
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
+ ## Fampiasana fototra
165
+ Ohatra mivelatra kokoa, mampiseho ny ankamaroan'ny endri-javatra atolotra:
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
+ Ny baiko `metadata` dia mamerina metadata momba ny fidirana amin'ny rafi-drakitra tokana.
268
+ Toy izany koa, ny sanda miverina avy amin'ny baiko `list` dia fitambarana zavatra metadata.
269
+
270
+ Ny zavatra metadata dia toa izao:
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
+ Ny fananana `type` dia mety ho `file` , `dir` , `link` , na `special` .
281
+
282
+ Miankina amin'ny karazana mpamily, ny baiko `list` dia mety tsy hamerina ny saha rehetra. Ny `name` sy `type` karazana`
283
+ tokony ho eo foana. Ny baiko `metadata` manaraka dia hamerina ny fananana rehetra misy.
284
+
285
+ ## Fomba fanafarana hafa
286
+ Ampidiro ny maodely feno velarana ary ampiasao ny fiasa `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 dia miasa tsara indrindra amin'ny cache <a href="https://redis.io">redis</a> .
295
+
296
+ Mobiletto dia hanandrana hifandray amin'ny ohatra redis amin'ny 127.0.0.1:6379
297
+
298
+ Azonao atao ny manafoana ny iray amin'ireto:
299
+ * Apetraho ny `MOBILETTO_REDIS_HOST` env var, mobiletto mifandray eto fa tsy localhost
300
+ * Apetraho ny `MOBILETTO_REDIS_PORT` env var, ity seranana ity no hampiasaina
301
+
302
+ Mobiletto dia hitahiry ny lakilen'ny redis rehetra miaraka amin'ny prefix `_mobiletto__` . Azonao ovaina izany
303
+ amin'ny fametrahana ny `MOBILETTO_REDIS_PREFIX` env var.
304
+
305
+ Azonao atao ihany koa ny mametraka caching isaky ny fifandraisana amin'ny zavatra `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
+ ### Tsy te redis caching?
317
+ Mba hanesorana: ampidiro ny `enabled: false` ao amin'ny zavatra `opts.redisConfig` rehefa mametraka ny fifandraisanao ianao.
318
+
319
+ Araka ny voalaza etsy ambany, ny fanalana ny caching dia hisy fiantraikany ratsy eo amin'ny fampandehanana ary hiteraka fangatahana bebe kokoa
320
+ amin'ny fitahirizana izay tena ilainao.
321
+
322
+ ### Torolàlana cache
323
+ **Fitehirizana miafina**: miadana kely noho ny mahazatra ny famakiana/manoratra ny fitehirizana miafina,
324
+ fa ny fandehanana manodidina ny lahatahiry (izay ataon'ny sasany) dia lafo be. Mampiasa cache redis
325
+ hanome anao fisondrotan-javatra lehibe.
326
+
327
+ Ny cache default dia azo antoka, saingy tsy mandeha tsara raha manana asa fanoratana / fanesorana betsaka ianao.
328
+ Ny asa fanoratana na fanesorana rehetra dia manafoana ny cache manontolo, ka miantoka fa ny famakiana manaraka dia hahita ny
329
+ fanovana farany.
330
+
331
+ ### CLI fitaovana
332
+ Raha mampiasa fitaovana CLI ianao toa ny [mobiletto-cli](https://www.npmjs.com/package/mobiletto-cli),
333
+ tena tianao ho alefa ny cache redis, satria maharitra amin'ny fiantsoana ny baiko `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
+ Ny baiko `mirror` dia manao kopia indray mandeha ny rakitra rehetra avy amin'ny mobiletto iray mankany amin'ny iray hafa.
344
+ Tsy mandeha na inona na inona ny fitazonana ny fitaratra rehefa mandeha ny fotoana. Alefaso indray ny baiko `mirror`
345
+ mba hampifanaraka izay rakitra tsy hita.
346
+
347
+ Ny sandan'ny fiverenana avy amin'ny `mirror` dia zavatra tsotra misy kajy ny isan'ny rakitra nahomby
348
+ nitaratra ary firy ny rakitra nanana lesoka:
349
+
350
+ {
351
+ success: count-of-files-mirrored,
352
+ errors: count-of-files-with-errors
353
+ }
354
+
355
+ FAMPITANDREMANA: Mety handany fotoana be ny fanaovana fitaratra amin'ny angon-drakitra lehibe
356
+
357
+ Miaraka amin'ny semantika fiantsoana `mirror` dia mety ho sahiran-tsaina indraindray ny mahatakatra hoe iza ilay
358
+ mpamaky ary iza no mpanoratra. Alaivo sary an-tsaina izany ho toy ny fanambarana fanendrena: ny "mobiletto ankavia"
359
+ dia ny zavatra atolotra (angona mirakitra voasoratra), ary ny "mobiletto havanana" (ny
360
+ Ny tohan-kevitra amin'ny fomba `mirror` ) dia ny sanda omena (vakiana ny angon-drakitra fitaratra).
361
+
362
+ ## Fanafenana mangarahara
363
+ Alefaso ny encryption amin'ny lafiny mpanjifa mangarahara:
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
+ Fa misy inona? Ny lahatahiry "fidirana amin'ny lahatahiry" (dirent) misaraka (voatahiry) dia manara-maso izay rakitra ao anatin'izany
383
+ directory (aka ny dirent directory).
384
+ * Ny baiko `list` dia mamaky ny rakitra fidirana amin'ny lahatahiry, mamadika ny lalana tsirairay voatanisa; dia mamerina ny metadata ho an'ny rakitra tsirairay
385
+ * Ny baiko `list` dia tsy mahomby kokoa, indrindra ho an'ny lahatahiry misy rakitra marobe
386
+ * Ny baiko `write` dia manoratra rakitra dirent ao amin'ny lahatahiry dirent an'ny ray aman-dreny tsirairay, miverimberina; dia manoratra ny rakitra
387
+ * Ny baiko `write` dia hahazo O(N) manoratra, miaraka amin'ny N = halaliny ao amin'ny ambaratongan'ny lahatahiry
388
+ * Ny baiko `remove` dia manala ny rakitra dirent mifanaraka amin'izany, ary ny ray aman-dreniny raha banga dia miverimberina; dia manala ny rakitra
389
+ * Ny baiko `remove` tsy miverimberina dia hiteraka O(N) mamaky ary mety ho voafafa betsaka, miaraka amin'ny N = halaliny ao amin'ny ambaratongan'ny lahatahiry
390
+ * Mety ho lafo ny baiko `remove` amin'ny rafi-drakitra lehibe sy lalina
391
+
392
+ Mariho fa na dia alefa ny fanafenana amin'ny lafiny mpanjifa aza, dia misy fahavalo manana fahitana feno amin'ny lafiny mpizara misy anao.
393
+ fitehirizana, na dia tsy misy ny fanalahidy, dia mbola afaka mahita ny fitambaran'ny lahatahiry sy ny isan'ny rakitra ao amin'ny tsirairay, ary miaraka
394
+ ezaka kely, tadiavo ny sasany na ny firafitry ny lahatahiry ankapoben'ny lahatahiry.
395
+ *Fanamarihana: Mampiasà rafitra somary fisaka ho fiarovana tsara kokoa.*
396
+ Tsy ho fantatry ny fahavalo ny anaran'ny lahatahiry/rakitra raha tsy fantany koa ny fanafenanao
397
+ key na raha tsy izany dia nahomby ny fanafenana. Miala daholo ny filokana!
398
+
399
+ ### Fampisehoana sy cache
400
+ Mety ho miadana ny fiasana amin'ny fitahirizana miafina. Ny lisitra miverimberina sy ny fanesorana dia mety ho miadana be.
401
+ Ny cache amin'ny redis dia manampy be dia be, fa mariho fa ny cache dia mipoitra amin'ny fanoratana na fanesorana.
402
+
403
+ ## Fihodinana fanalahidy
404
+ Mamoròna mobiletto miaraka amin'ny fanalahidinao vaovao, ary ampifanaraho ao aminy ny angona taloha:
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
+ ## Interface amin'ny mpamily
417
+ Ny mpamily dia rakitra JS rehetra manondrana fiasa 'storageClient' miaraka amin'ity sonia ity:
418
+
419
+ function storageClient (key, secret, opts)
420
+
421
+ * `key` : tady, ny lakilen'ny API-nao (ho an'ny mpamily `local` ity no lahatahiry fototra)
422
+ * `secret` : tady, ny API secret-nao (azo avela ho an'ny mpamily `local` )
423
+ * `opts` : zavatra iray, ny fananana dia isaky ny mpamily:
424
+ * Ho an'ny `local` , ny `fileMode` sy `dirMode` no mamaritra ny fomba famoronana rakitra sy lahatahiry vaovao.
425
+ * Ho an'ny `s3` , ilaina ny fananana `bucket` . Ny fananana azo atao dia:
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
+ Ny zavatra averin'ny storageClient dia tsy maintsy mamaritra ireto asa ireto:
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
+ ## Loka
457
+ Mobiletto dia mampiasa ny [winston](https://www.npmjs.com/package/winston).
458
+
459
+ Ny logs **dia** misy làlam-drakitra sy hafatra diso, fa tsy ** misy fanalahidy, tsiambaratelo,
460
+ na fampahalalana hafa momba ny fanefena fifandraisana.
461
+
462
+ ### Ambaratonga log
463
+ Ampiasao ny fari-piainan'ny tontolo `MOBILETTO_LOG_LEVEL` ' hametrahana ny haavon'ny diary, mampiasa iray
464
+ amin'ireo ambaratonga `npm` voafaritra ao amin'ny [https://www.npmjs.com/package/winston#logging-levels](https://www.npmjs.com/package/winston#logging-levels)
465
+
466
+ Ny haavon'ny default dia `error` . Ny ambaratonga be verbose dia `silly` , na dia mobiletto amin'izao fotoana izao aza
467
+ tsy miditra amin'ny ambaratonga ambany `debug`
468
+
469
+ MOBILETTO_LOG_LEVEL=silly # maximum logs!
470
+
471
+ ### rakitra log
472
+ Amin'ny alàlan'ny default, manoratra amin'ny console ny mpitatitra. Raha handefa logs amina rakitra iray dia apetraho ny `MOBILETTO_LOG_FILE`
473
+ fari-piainan'ny tontolo iainana. Rehefa miditra amin'ny rakitra iray dia tsy hosoratana amin'ny console intsony ny logs.
474
+
475
+ MOBILETTO_LOG_FILE=/var/my_mobiletto_log
476
+
477
+ Mba hamonoana ny logging:
478
+
479
+ MOBILETTO_LOG_FILE=/dev/null
480
+
481
+ </pre>