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
+ 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
+ * [Fampiasana fototra](#Fampiasana fototra)
12
+ * [Metadata](#Metadata)
13
+ * [fomba fanafarana hafa](fomba #fanafarana hafa)
14
+ * [Caching](#Caching)
15
+ * [Mirroring](#Mirroring)
16
+ * [Fanafenoana mangarahara](#Fanafenana mangarahara)
17
+ * [Fihodinana lakile](#Fihodinana lakile)
18
+ * [Interface amin'ny mpamily](#interface amin'ny mpamily)
19
+ * [Logging](#Logging)
20
+
21
+ # Vakio amin'ny fiteny hafa ity
22
+ Ity antontan-taratasy README.md ity dia nadika, tamin'ny alàlan'ny [hokeylization](https://github.com/cobbzilla/hokeylization), ho amin'ny
23
+ **[ny fiteny rehetra tohanan'ny Google Translate](https://cloud.google.com/translate/docs/languages)!**
24
+
25
+ azoko antoka fa tsy tonga lafatra izany fa manantena aho fa tsara noho ny tsy misy!
26
+
27
+ [🇸🇦 Arabo](../ar/README.md)
28
+ [🇧🇩 Bengali](../bn/README.md)
29
+ [🇩🇪 Alemana](../de/README.md)
30
+ [🇺🇸 anglisy](../en/README.md)
31
+ [🇪🇸 Espaniola](../es/README.md)
32
+ [🇫🇷 frantsay](../fr/README.md)
33
+ [🇹🇩 Hausa](../ha/README.md)
34
+ [🇮🇳 Hindi](../hi/README.md)
35
+ [🇮🇩 Indoneziana](../id/README.md)
36
+ [🇮🇹 Italiana](../it/README.md)
37
+ [🇯🇵 Japoney](../ja/README.md)
38
+ [🇰🇷 Koreana](../ko/README.md)
39
+ [🇮🇳 Maranthi](../mr/README.md)
40
+ [🇵🇱 poloney](../pl/README.md)
41
+ [🇧🇷 Portiogey](../pt/README.md)
42
+ [🇷🇺 Rosiana](../ru/README.md)
43
+ [🇰🇪 Swahili](../sw/README.md)
44
+ [🇵🇭 Tagalog](../tl/README.md)
45
+ [🇹🇷 Tiorka](../tr/README.md)
46
+ [🇵🇰 Urdu](../ur/README.md)
47
+ [🇻🇳 vietnamiana](../vi/README.md)
48
+ [🇨🇳 Sinoa](../zh/README.md)
49
+
50
+
51
+ **[📚 ... Teny Rehetra ...](../README.md)**
52
+ ----
53
+
54
+ ### Misy olana ve amin'ity fandikana ny README ity?
55
+ Ity dikanteny manokana amin'ny [README] tany am-boalohany (https://github.com/cobbzilla/mobiletto/blob/master/README.md)
56
+ mety misy lesoka -- *tena raisina an-tanana ny fanitsiana!* Alefaso azafady [fangatahana fisarihana ao amin'ny GitHub](https://github.com/cobbzilla/mobiletto/pulls),
57
+ na raha tsy mahazo aina amin'izany ianao dia [manokatra olana](https://github.com/cobbzilla/mobiletto/issues)
58
+
59
+ Rehefa mamorona olana GitHub vaovao momba ny fandikan-teny ianao, azafady:
60
+ * Ampidiro ny URL pejy (adikao / apetaho amin'ny bara adiresy navigateur)
61
+ * Ampidiro ny lahatsoratra marina izay diso (kodikao / apetaho amin'ny navigateur)
62
+ * farito azafady izay tsy mety - diso ve ny dikanteny? simba ve ny format?
63
+ * Manomeza soso-kevitra amin-katsaram-panahy momba ny fandikan-teny tsara kokoa, na ny fomba tokony handrafetana ny lahatsoratra
64
+ * **Misaotra anao!**
65
+
66
+ ## Nahoana no Mobiletto?
67
+
68
+ ### Veloma mpivarotra mihidy!
69
+ Ireo mpamatsy fitahirizana rahona isan-karazany dia manana API tsy mifanaraka. Na dia ireo izay miezaka ny "S3 compatibility"
70
+ manana fitondrantena idiosyncratic.
71
+
72
+ Rehefa misafidy mpivarotra fitahirizana manokana ho an'ny app-nao ianao, raha kaody mivantana amin'ny API-ny ianao, dia ny app-nao
73
+ dia miankina amin'io serivisy io izao. Rehefa mandeha ny fotoana ary mihabetsaka ny kaody, dia lasa ny fiovan'ny mpivarotra
74
+ mihamitombo hatrany. Tongasoa eto amin'ny tontolon'ny mpivarotra hidy!
75
+
76
+ 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
77
+ ovay ny mpanome fitahirizana ary fantaro fa ny sosona fitahirizana ny fampiharanao dia hitovy fihetsika.
78
+
79
+ ### Fitsapana mivelatra
80
+ Ny mpamily rehetra dia voasedra amin'ny fihetsika mitovy amin'ny fitsapana 60+ ho an'ny mpamily tsirairay.
81
+ Mitsapa ny mpamily rehetra izahay miaraka amin'ny fitambaran'ny:
82
+ * Encryption: samy afaka na kilemaina
83
+ * Redis cache: samy afaka na kilemaina
84
+
85
+ Ity fomba fiasa ity dia manome antsika fiadanan-tsaina fa ny mobiletto dia hitondra tena mitovy na inona na inona mpamily ampiasainao,
86
+ ary na manao ahoana na manao caching sy/na encryption.
87
+
88
+ ### Fanohanana ny mpamily
89
+ Mpamily fitahirizana Mobiletto amin'izao fotoana izao:
90
+ * `s3` : Amazon S3
91
+ * `b2` : Backblaze B2
92
+ * `local` : rafi-drakitra eo an-toerana
93
+
94
+ * Tena raisina an-tanan-droa ny fandraisana anjara hanohanana ireo mpamatsy fitahirizana rahona!*
95
+
96
+ ## mobiletto-cli
97
+ Mobiletto dia natao hampiasaina ho tranomboky amin'ny code JavaScript hafa.
98
+
99
+ Raha hiasa amin'ny mobiletto amin'ny baikon'ny baiko, ampiasao [mobiletto-cli](https://www.npmjs.com/package/mobiletto-cli)
100
+
101
+ ## Loharano
102
+ * [mobiletto amin'ny GitHub](https://github.com/cobbzilla/mobiletto)
103
+ * [mobiletto amin'ny npm](https://www.npmjs.com/package/mobiletto)
104
+
105
+ ## Manomboka haingana
106
+ Ohatra fohy amin'ny fampiasana ny mpamily mobiletto `s3` .
107
+
108
+ Ity kaody ity dia mandeha mitovy raha toa ka `b2` na `local` ny mpamily.
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
+ ## Fampiasana fototra
139
+ Ohatra mivelatra kokoa, mampiseho ny ankamaroan'ny endri-javatra atolotra:
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
+ Ny baiko `metadata` dia mamerina metadata momba ny fidirana amin'ny rafi-drakitra tokana.
242
+ Toy izany koa, ny sanda miverina avy amin'ny baiko `list` dia fitambarana zavatra metadata.
243
+
244
+ Ny zavatra metadata dia toa izao:
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
+ Ny fananana `type` dia mety ho `file` , `dir` , `link` , na `special` .
255
+
256
+ Miankina amin'ny karazana mpamily, ny baiko `list` dia mety tsy hamerina ny saha rehetra. Ny `name` sy `type` karazana`
257
+ tokony ho eo foana. Ny baiko `metadata` manaraka dia hamerina ny fananana rehetra misy.
258
+
259
+ ## Fomba fanafarana hafa
260
+ Ampidiro ny maodely feno velarana ary ampiasao ny fiasa `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 dia miasa tsara indrindra amin'ny cache <a href="https://redis.io">redis</a> .
269
+
270
+ Mobiletto dia hanandrana hifandray amin'ny ohatra redis amin'ny 127.0.0.1:6379
271
+
272
+ Azonao atao ny manafoana ny iray amin'ireto:
273
+ * Apetraho ny `MOBILETTO_REDIS_HOST` env var, mobiletto mifandray eto fa tsy localhost
274
+ * Apetraho ny `MOBILETTO_REDIS_PORT` env var, ity seranana ity no hampiasaina
275
+
276
+ Mobiletto dia hitahiry ny lakilen'ny redis rehetra miaraka amin'ny prefix `_mobiletto__` . Azonao ovaina izany
277
+ amin'ny fametrahana ny `MOBILETTO_REDIS_PREFIX` env var.
278
+
279
+ Azonao atao ihany koa ny mametraka caching isaky ny fifandraisana amin'ny zavatra `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
+ ### Tsy te redis caching?
291
+ Mba hanesorana: ampidiro ny `enabled: false` ao amin'ny zavatra `opts.redisConfig` rehefa mametraka ny fifandraisanao ianao.
292
+
293
+ Araka ny voalaza etsy ambany, ny fanalana ny caching dia hisy fiantraikany ratsy eo amin'ny fampandehanana ary hiteraka fangatahana bebe kokoa
294
+ amin'ny fitahirizana izay tena ilainao.
295
+
296
+ ### Torolàlana cache
297
+ **Fitehirizana miafina**: miadana kely noho ny mahazatra ny famakiana/manoratra ny fitehirizana miafina,
298
+ fa ny fandehanana manodidina ny lahatahiry (izay ataon'ny sasany) dia lafo be. Mampiasa cache redis
299
+ hanome anao fisondrotan-javatra lehibe.
300
+
301
+ Ny cache default dia azo antoka, saingy tsy mandeha tsara raha manana asa fanoratana / fanesorana betsaka ianao.
302
+ Ny asa fanoratana na fanesorana rehetra dia manafoana ny cache manontolo, ka miantoka fa ny famakiana manaraka dia hahita ny
303
+ fanovana farany.
304
+
305
+ ### CLI fitaovana
306
+ Raha mampiasa fitaovana CLI ianao toa ny [mobiletto-cli](https://www.npmjs.com/package/mobiletto-cli),
307
+ tena tianao ho alefa ny cache redis, satria maharitra amin'ny fiantsoana ny baiko `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
+ Ny baiko `mirror` dia manao kopia indray mandeha ny rakitra rehetra avy amin'ny mobiletto iray mankany amin'ny iray hafa.
318
+ Tsy mandeha na inona na inona ny fitazonana ny fitaratra rehefa mandeha ny fotoana. Alefaso indray ny baiko `mirror`
319
+ mba hampifanaraka izay rakitra tsy hita.
320
+
321
+ Ny sandan'ny fiverenana avy amin'ny `mirror` dia zavatra tsotra misy kajy ny isan'ny rakitra nahomby
322
+ nitaratra ary firy ny rakitra nanana lesoka:
323
+
324
+ {
325
+ success: count-of-files-mirrored,
326
+ errors: count-of-files-with-errors
327
+ }
328
+
329
+ FAMPITANDREMANA: Mety handany fotoana be ny fanaovana fitaratra amin'ny angon-drakitra lehibe
330
+
331
+ Miaraka amin'ny semantika fiantsoana `mirror` dia mety ho sahiran-tsaina indraindray ny mahatakatra hoe iza ilay
332
+ mpamaky ary iza no mpanoratra. Alaivo sary an-tsaina izany ho toy ny fanambarana fanendrena: ny "mobiletto ankavia"
333
+ dia ny zavatra atolotra (angona mirakitra voasoratra), ary ny "mobiletto havanana" (ny
334
+ Ny tohan-kevitra amin'ny fomba `mirror` ) dia ny sanda omena (vakiana ny angon-drakitra fitaratra).
335
+
336
+ ## Fanafenana mangarahara
337
+ Alefaso ny encryption amin'ny lafiny mpanjifa mangarahara:
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
+ Fa misy inona? Ny lahatahiry "fidirana amin'ny lahatahiry" (dirent) misaraka (voatahiry) dia manara-maso izay rakitra ao anatin'izany
357
+ directory (aka ny dirent directory).
358
+ * 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
359
+ * Ny baiko `list` dia tsy mahomby kokoa, indrindra ho an'ny lahatahiry misy rakitra marobe
360
+ * Ny baiko `write` dia manoratra rakitra dirent ao amin'ny lahatahiry dirent an'ny ray aman-dreny tsirairay, miverimberina; dia manoratra ny rakitra
361
+ * Ny baiko `write` dia hahazo O(N) manoratra, miaraka amin'ny N = halaliny ao amin'ny ambaratongan'ny lahatahiry
362
+ * Ny baiko `remove` dia manala ny rakitra dirent mifanaraka amin'izany, ary ny ray aman-dreniny raha banga dia miverimberina; dia manala ny rakitra
363
+ * 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
364
+ * Mety ho lafo ny baiko `remove` amin'ny rafi-drakitra lehibe sy lalina
365
+
366
+ Mariho fa na dia alefa ny fanafenana amin'ny lafiny mpanjifa aza, dia misy fahavalo manana fahitana feno amin'ny lafiny mpizara misy anao.
367
+ 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
368
+ ezaka kely, tadiavo ny sasany na ny firafitry ny lahatahiry ankapoben'ny lahatahiry.
369
+ *Fanamarihana: Mampiasà rafitra somary fisaka ho fiarovana tsara kokoa.*
370
+ Tsy ho fantatry ny fahavalo ny anaran'ny lahatahiry/rakitra raha tsy fantany koa ny fanafenanao
371
+ key na raha tsy izany dia nahomby ny fanafenana. Miala daholo ny filokana!
372
+
373
+ ### Fampisehoana sy cache
374
+ Mety ho miadana ny fiasana amin'ny fitahirizana miafina. Ny lisitra miverimberina sy ny fanesorana dia mety ho miadana be.
375
+ Ny cache amin'ny redis dia manampy be dia be, fa mariho fa ny cache dia mipoitra amin'ny fanoratana na fanesorana.
376
+
377
+ ## Fihodinana fanalahidy
378
+ Mamoròna mobiletto miaraka amin'ny fanalahidinao vaovao, ary ampifanaraho ao aminy ny angona taloha:
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
+ ## Interface amin'ny mpamily
391
+ Ny mpamily dia rakitra JS rehetra manondrana fiasa 'storageClient' miaraka amin'ity sonia ity:
392
+
393
+ function storageClient (key, secret, opts)
394
+
395
+ * `key` : tady, ny lakilen'ny API-nao (ho an'ny mpamily `local` ity no lahatahiry fototra)
396
+ * `secret` : tady, ny API secret-nao (azo avela ho an'ny mpamily `local` )
397
+ * `opts` : zavatra iray, ny fananana dia isaky ny mpamily:
398
+ * Ho an'ny `local` , ny `fileMode` sy `dirMode` no mamaritra ny fomba famoronana rakitra sy lahatahiry vaovao.
399
+ * Ho an'ny `s3` , ilaina ny fananana `bucket` . Ny fananana azo atao dia:
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
+ Ny zavatra averin'ny storageClient dia tsy maintsy mamaritra ireto asa ireto:
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
+ ## Loka
431
+ Mobiletto dia mampiasa ny [winston](https://www.npmjs.com/package/winston).
432
+
433
+ Ny logs **dia** misy ny làlan'ny rakitra sy ny hafatra diso, fa tsy ** misy fanalahidy, tsiambaratelo,
434
+ na fampahalalana hafa momba ny fanefena fifandraisana.
435
+
436
+ ### Ambaratonga log
437
+ Ampiasao ny fari-piainan'ny tontolo `MOBILETTO_LOG_LEVEL` ' hametrahana ny haavon'ny diary, mampiasa iray
438
+ amin'ireo ambaratonga `npm` voafaritra ao amin'ny [https://www.npmjs.com/package/winston#logging-levels](https://www.npmjs.com/package/winston#logging-levels)
439
+
440
+ Ny haavon'ny default dia `error` . Ny ambaratonga be verbose dia `silly` , na dia mobiletto amin'izao fotoana izao aza
441
+ tsy miditra amin'ny ambaratonga ambany `debug`
442
+
443
+ MOBILETTO_LOG_LEVEL=silly # maximum logs!
444
+
445
+ ### rakitra log
446
+ Amin'ny alàlan'ny default, manoratra amin'ny console ny mpitatitra. Raha handefa logs amina rakitra iray dia apetraho ny `MOBILETTO_LOG_FILE`
447
+ fari-piainan'ny tontolo iainana. Rehefa miditra amin'ny rakitra iray dia tsy hosoratana amin'ny console intsony ny logs.
448
+
449
+ MOBILETTO_LOG_FILE=/var/my_mobiletto_log
450
+
451
+ Mba hamonoana ny logging:
452
+
453
+ MOBILETTO_LOG_FILE=/dev/null
454
+
455
+ </pre>