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 ke karolo ea polokelo ea JavaScript, e nang le mokhoa oa boikhethelo o pepeneneng oa lehlakoreng la moreki.
5
+
6
+ # Litaba
7
+ * [Hobaneng Mobiletto?](#Hobaneng-Mobiletto?)
8
+ * [Qalo e potlakileng](#Qalo e potlakileng)
9
+ * [Mobiletto CLI](#mobiletto-cli)
10
+ * [Mohloli](#Mohloli)
11
+ * [Tsebeliso ea mantlha](#Tšebeliso ea mantlha)
12
+ * [Metadata](#Metadata)
13
+ * [Mokhoa o mong oa ho reka kantle ho naha](#Mokhoa-mokhoa o mong)
14
+ * [Caching](#Caching)
15
+ * [Ho etsa seipone](#Mirroring)
16
+ * [Ponaletso e hlakileng](#Ponaletso-encryption)
17
+ * [Ho potoloha ha senotlolo](#Ho potoloha)
18
+ * [Sebopeho sa mokhanni](#Sehokelo sa mokhanni)
19
+ * [Ho rengoa](#Ho rema)
20
+
21
+ # Bala sena ka puo e 'ngoe
22
+ Tokomane ena ea README.md e fetoletsoe, ka [hokeylization](https://github.com/cobbzilla/hokeylization), ho
23
+ **[puo e nngwe le e nngwe e tshehetswa ke Google Translate](https://cloud.google.com/translate/docs/languages)!**
24
+
25
+ Ke na le bonnete ba hore ha ea phethahala, empa ke ts'epa hore e betere ho feta letho!
26
+
27
+ [🇸🇦 Searabia](../ar/README.md)
28
+ [🇧🇩 Benghali](../bn/README.md)
29
+ [🇩🇪 Sejeremane](../de/README.md)
30
+ [🇺🇸 Senyesemane](../en/README.md)
31
+ [🇪🇸 Spanish](../es/README.md)
32
+ [🇫🇷 Sefora](../fr/README.md)
33
+ [🇹🇩 Hausa](../ha/README.md)
34
+ [🇮🇳 Sehindi](../hi/README.md)
35
+ [🇮🇩 Seindonesia](../id/README.md)
36
+ [🇮🇹 Setaliana](../it/README.md)
37
+ [🇯🇵 Sejapane](../ja/README.md)
38
+ [🇰🇷 Sekorea](../ko/README.md)
39
+ [🇮🇳 Maranthi](../mr/README.md)
40
+ [🇵🇱 Sepolishe](../pl/README.md)
41
+ [🇧🇷 Sepotoketsi](../pt/README.md)
42
+ [🇷🇺 Serussia](../ru/README.md)
43
+ [🇰🇪 Seswahili](../sw/README.md)
44
+ [🇵🇭 Setagalog](../tl/README.md)
45
+ [🇹🇷 Seturkey](../tr/README.md)
46
+ [🇵🇰 Urdu](../ur/README.md)
47
+ [🇻🇳 Sevietnam](../vi/README.md)
48
+ [🇨🇳 Sechaena](../zh/README.md)
49
+
50
+
51
+ **[📚 ... Lipuo Tsohle ...](../README.md)**
52
+ ----
53
+
54
+ ### Na ho na le bothata ka phetolelo ee ea README?
55
+ Phetolelo ena ea pele ea [README](https://github.com/cobbzilla/mobiletto/blob/master/README.md)
56
+ e kanna ea ba le bofokoli -- *litokiso li amohelehile!* Ka kopo, romella [ho hula kopo ho GitHub](https://github.com/cobbzilla/mobiletto/pulls),
57
+ kapa ha o sa phutholoha ho etsa joalo, [bula bothata](https://github.com/cobbzilla/mobiletto/issues)
58
+
59
+ Ha o theha taba e ncha ea GitHub mabapi le phetolelo, ka kopo etsa:
60
+ * kenyelletsa URL ea leqephe (kopi / beha ho tsoa bareng ea aterese ea sebatli)
61
+ * kenyelletsa mongolo o nepahetseng (kopi / beha ho tsoa ho sebatli)
62
+ * Ka kopo hlalosa se fosahetseng -- na phetolelo e fosahetse? na sebopeho se robehile ka tsela e itseng?
63
+ * ka mosa fana ka tlhahiso ea phetolelo e molemonyana, kapa hore na taba e ngotsoe joang ka tsela e nepahetseng
64
+ * **Kea leboha!**
65
+
66
+ ## Hobaneng Mobiletto?
67
+
68
+ ### Sala hantle ha barekisi ba notlela!
69
+ Bafani ba mefuta e fapaneng ea polokelo ea maru ba na le li-API tse sa lumellaneng. Esita le ba loanelang "S3 compatibility"
70
+ ba le boitšoaro bo sa tloaelehang.
71
+
72
+ Ha u khetha morekisi ea itseng oa polokelo bakeng sa sesebelisoa sa hau, haeba u khouta ka kotloloho ho API ea bona, sesebelisoa sa hau
73
+ jwale e itshetlehile ka tshebeletso eo. Ha nako e ntse e tsamaea le khoutu e ntse e bokellana, ho fetoha ha barekisi ho fetoha
74
+ e ntseng e sa kgonehe ho feta. Rea u amohela lefatšeng le monate la ho notlela ha barekisi!
75
+
76
+ Mobiletto e etselitsoe ho rarolla bothata bona. Ka ho khouta sesebelisoa sa hau ho mobiletto's API, u ka khona habonolo
77
+ fetola bafani ba polokelo 'me u tsebe hore sebaka sa polokelo ea sesebelisoa sa hau se tla sebetsa ka mokhoa o ts'oanang.
78
+
79
+ ### Teko e batsi
80
+ Bakhanni bohle ba lekoa bakeng sa boitšoaro bo tšoanang ka liteko tse 60+ bakeng sa mokhanni ka mong.
81
+ Re leka bakhanni bohle ka motsoako o mong le o mong oa:
82
+ * Encryption: ka bobeli e nolofalitsoe ebile e holofalitsoe
83
+ * Redis cache: ka bobeli e nolofalitsoe ebile e holofetse
84
+
85
+ Mokhoa ona o re fa khotso ea kelello ea hore mobiletto e tla itšoara ka mokhoa o ts'oanang ho sa tsotellehe hore na u sebelisa mokhanni ofe,
86
+ le ho sa tsotelehe hore na o lumella caching le/kapa encryption.
87
+
88
+ ### Tšehetso ea mokhanni
89
+ Bakhanni ba hajoale ba Mobiletto:
90
+ * `s3` : Amazon S3
91
+ * `b2` : Backblaze B2
92
+ * `local` : tsamaiso ea faele ea lehae
93
+
94
+ *Menehelo ea ho ts'ehetsa bafani ba bangata ba polokelo ea maru e amoheloa haholo!*
95
+
96
+ ## mobiletto-cli
97
+ Mobiletto e reretsoe ho sebelisoa e le laebrari ka khoutu e 'ngoe ea JavaScript.
98
+
99
+ Ho sebetsa le mobiletto molaong oa taelo, sebelisa [mobiletto-cli](https://www.npmjs.com/package/mobiletto-cli)
100
+
101
+ ##Mohloli
102
+ * [mobiletto ho GitHub](https://github.com/cobbzilla/mobiletto)
103
+ * [mobiletto ho npm](https://www.npmjs.com/package/mobiletto)
104
+
105
+ ## Ho qala ka potlako
106
+ Mohlala o mokhuts'oane o sebelisang mokhanni oa mobiletto `s3` .
107
+
108
+ Khoutu ena e ne e tla sebetsa ka mokhoa o ts'oanang haeba mokhanni a le `b2` kapa `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
+ ## Tšebeliso ea mantlha
139
+ Mohlala o pharaletseng haholoanyane, o bonts'ang boholo ba likarolo tse fanoeng:
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
+ Taelo ea `metadata` e khutlisetsa metadata mabapi le kenyo e le 'ngoe ea tsamaiso ea faele.
242
+ Ka mokhoa o ts'oanang, chelete e khutlisang ho tsoa ho taelo ea `list` ke lintho tse ngata tsa metadata.
243
+
244
+ Ntho ea metadata e shebahala tjena:
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
+ Thepa ea `type` e ka ba `file` , `dir` , `link` , kapa `special` .
255
+
256
+ Ho latela mofuta oa mokhanni, taelo ea `list` e kanna ea se khutlise likarolo tsohle. Thepa ea `name` le `type`
257
+ e lokela ho ba teng kamehla. Taelo e latelang ea `metadata` e tla khutlisa thepa eohle e teng.
258
+
259
+ ## Mokhoa o mong oa ho kenya
260
+ Kenya mochini o hlophisitsoeng ka botlalo 'me u sebelise mosebetsi oa `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 e sebetsa hantle haholo ka cache ea <a href="https://redis.io">redis</a> .
269
+
270
+ Mobiletto e tla leka ho hokahana le mohlala oa redis ho 127.0.0.1:6379
271
+
272
+ O ka hlakola e 'ngoe ea tsena:
273
+ * Beha lebitso la `MOBILETTO_REDIS_HOST` env var, mobiletto hokela mona ho fapana le localhost
274
+ * Beha `MOBILETTO_REDIS_PORT` env var, boema-kepe bona bo tla sebelisoa
275
+
276
+ Mobiletto e tla boloka linotlolo tsohle tsa eona tsa redis ka `_mobiletto__` . O ka fetola sena
277
+ ka ho `MOBILETTO_REDIS_PREFIX` env var.
278
+
279
+ U ka boela ua seta caching ka khokahanyo ka ntho ea `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
+ ### Ha u batle redis caching?
291
+ Ho tima: fetisa `enabled: false` ea hau ea `opts.redisConfig` ha u theha khokahano ea hau.
292
+
293
+ Joalo ka ha ho boletsoe ka tlase, ho thibela caching ho tla ba le phello e mpe ts'ebetsong mme ho hlahise likopo tse ngata
294
+ ho boloka seo u hlileng u se hlokang.
295
+
296
+ ### Tataiso ea ho boloka
297
+ **polokelo e patiloeng**: polokelo e patiloeng ea ho bala/ho ngola e lieha ho feta e tloaelehileng,
298
+ empa ho pota-pota li-directory (tseo lintho tse ling li li etsang) ho bitsa chelete e ngata. Ho sebelisa cache ea redis
299
+ e tla u fa ntlafatso e kholo ea ts'ebetso.
300
+
301
+ Cache ea kamehla e bolokehile, empa ha e sebetse hantle haeba u na le mesebetsi e mengata ea ho ngola / ho tlosa.
302
+ Ts'ebetso efe kapa efe ea ho ngola kapa ea ho tlosa e etsa hore cache kaofela e se ke ea sebetsa, ho etsa bonnete ba hore lintho tse baloang tse latelang li tla bona
303
+ liphetoho tsa moraorao.
304
+
305
+ ### CLI lisebelisoa
306
+ Haeba u sebelisa sesebelisoa sa CLI joalo ka [mobiletto-cli](https://www.npmjs.com/package/mobiletto-cli),
307
+ ka 'nete u tla batla hore cache ea redis e lumelloe, kaha e tšoarella ho pholletsa le likopo tsa taelo ea `mo` .
308
+
309
+ ## Ho etsa seipone
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
+ Taelo ea `mirror` e etsa kopi ea nako e le 'ngoe ea lifaele tsohle ho tloha ho mobiletto e 'ngoe ho ea ho e' ngoe.
318
+ Ha e tsamaise mokhoa leha e le ofe oa ho boloka seipone ka nako. Etsa taelo ea `mirror` hape
319
+ ho amahanya difaele dife kapa dife tse sieo.
320
+
321
+ Theko ea ho khutlisa ho tsoa ho `mirror` ke ntho e bonolo e nang le li-counters tsa hore na ke lifaele tse kae tse atlehileng
322
+ seipone le hore na ke lifaele tse kae tse nang le liphoso:
323
+
324
+ {
325
+ success: count-of-files-mirrored,
326
+ errors: count-of-files-with-errors
327
+ }
328
+
329
+ TLHOKOMELISO: Ho bopa li-sete tse kholo tsa data ho ka nka nako haholo le ho nka sebaka sa marang-rang
330
+
331
+ Ka semantics ea `mirror` ka linako tse ling e ka ferekanya ho utloisisa hore na ke mang
332
+ mmadi le hore mongodi ke mang. Ak'u nahane joalo ka polelo ea kabelo: "mobileto ea letsoho le letšehali"
333
+ ke ntho e abetsoeng (data e entsoeng ka seipone), le "mobileto e letsohong le letona" (the
334
+ khang ea mokhoa oa `mirror` ) ke boleng bo abeloang (ho baloa data ea seipone).
335
+
336
+ ## Encryption e hlakileng
337
+ Lumella mokhoa oa ho hlakoloa ka mokhoa o hlakileng oa lehlakoreng la moreki:
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
+ Ho etsahalang? Sebaka se arohaneng sa "directory entry" (dirent) directory (encrypted) se latela hore na lifaele li hokae
357
+ directory (eo hape e leng "dirent directory).
358
+ * Taelo ea `list` e bala lifaele tsa ho kenya li-directory, e hlakola tsela e 'ngoe le e 'ngoe e thathamisitsoeng; ebe o khutlisetsa metadata bakeng sa faele ka 'ngoe
359
+ * Litaelo tsa `list` ha li sebetse hantle, haholo bakeng sa li-directory tse nang le palo e kholo ea lifaele
360
+ * Taelo ea `write` e ngola lifaele tsa dirent bukeng e 'ngoe le e 'ngoe e fapaneng ea motsoali, ka ho pheta-pheta; ebe o ngola faele
361
+ * Litaelo tsa `write` li tla kenya O(N) ho ngola, ka N = botebo ba lethathamong la lihlopha.
362
+ * Taelo ea `remove` e tlosa faele e tsamaisanang le dirent, mme motsoali oa eona haeba e se na letho, ka ho pheta-pheta; ebe o tlosa faele
363
+ * Litaelo tse sa iphetang tsa `remove` li tla etsa hore O(N) e baloe 'me mohlomong e hlakoloe hangata, ka N = botebo ba lethathamong la lihlopha.
364
+ * `remove` tsa 'ho tlosa' tse pheta-phetoang ho li-file tse kholo le tse tebileng li ka bitsa chelete e ngata
365
+
366
+ Hlokomela hore leha encryption ea lehlakore la bareki e nolofalitsoe, mohanyetsi ea nang le ponahalo e felletseng ka lehlakoreng la hau la seva e patiloeng.
367
+ polokelo, leha e se na senotlolo, e ntse e khona ho bona palo eohle ea li-directory le hore na ho na le lifaele tse kae ho e 'ngoe le e 'ngoe, le ka
368
+ ka boiteko bo itseng, fumana tse ling kapa tsohle tsa sebopeho sa kakaretso sa lenane la lenane.
369
+ *Hlokomela: Sebelisa sebopeho se batlang se bataletse bakeng sa ts'ireletso e betere.
370
+ Mohanyetsi o ne a ke ke a tseba mabitso a li-directory / lifaele ntle le haeba a ne a tseba le encryption ea hau
371
+ key kapa o atlehile ho hlakola encryption. Libeche tsohle li felile ka nako eo!
372
+
373
+ ### Tshebetso le caching
374
+ Ts'ebetso ea polokelo e patiloeng e ka tsamaea butle. Mananeo a iphetang le ho tlosa a ka lieha haholo.
375
+ Caching ka redis e thusa haholo, empa hlokomela hore cache e khannoa holim'a leha e le efe ho ngola kapa ho tlosa.
376
+
377
+ ## Phetoho ea bohlokoa
378
+ Theha mobiletto ka senotlolo sa hau se secha, ebe u sheba lintlha tsa khale ho eona:
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
+ ## Sehokelo sa mokhanni
391
+ Mokhanni ke faele efe kapa efe ea JS e romellang mosebetsi oa 'storageClient' ka signature ena:
392
+
393
+ function storageClient (key, secret, opts)
394
+
395
+ * `key` : khoele, senotlolo sa hau sa API (bakeng sa mokhanni oa `local` ena ke buka ea motheo)
396
+ * `secret` : khoele, lekunutu la API ea hau (e ka siuoa bakeng sa mokhanni oa `local` )
397
+ * `opts` : ntho, thepa ke mokhanni ka mong:
398
+ * Bakeng sa `local` , thepa ea `fileMode` le `dirMode` e bontša hore na lifaele le litsamaiso tse ncha li etsoa joang.
399
+ * Bakeng sa `s3` , thepa ea `bucket` ea hlokahala. Lintho tseo u ka li khethang ke:
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
+ Ntho eo ts'ebetso ea storageClient e khutlisang e tlameha ho hlalosa mesebetsi ena:
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
+ ## Ho rema lifate
431
+ Mobiletto e sebelisa [winston](https://www.npmjs.com/package/winston) laeborari ea ho rema lifate.
432
+
433
+ Li-log ** li tla ba le litsela tsa lifaele le melaetsa ea liphoso, empa ** ha ho mohla ** e nang le linotlolo, liphiri,
434
+ kapa tlhahisoleseding efe kapa efe e 'ngoe ea tlhophiso ea khokahano.
435
+
436
+ ### Boemo ba marang-rang
437
+ Sebelisa sebopeho sa `MOBILETTO_LOG_LEVEL` ho seta boemo ba tlaleho, u sebelisa e le 'ngoe
438
+ ya maemo a `npm` a hlalositsweng ho [https://www.npmjs.com/package/winston#logging-levels](https://www.npmjs.com/package/winston#logging-levels)
439
+
440
+ Boemo ba kamehla ke `error` . Boemo ba leetsi haholo ke `silly` , leha hajoale mobiletto
441
+ ha e kene maemong a ka tlase ho `debug`
442
+
443
+ MOBILETTO_LOG_LEVEL=silly # maximum logs!
444
+
445
+ ### Faele ea ho rekota
446
+ Ka ho sa feleng, ralithara o ngolla console. Ho romela litlaleho faeleng, beha `MOBILETTO_LOG_FILE`
447
+ ho feto-fetoha ha tikoloho. Ha u kena faeleng, li-log ha li sa tla ngolloa ho console.
448
+
449
+ MOBILETTO_LOG_FILE=/var/my_mobiletto_log
450
+
451
+ Ho tima ho rema lifate:
452
+
453
+ MOBILETTO_LOG_FILE=/dev/null
454
+
455
+ </pre>