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
+ Ko Mobiletto he paparanga tangohanga rokiroki JavaScript, me te whakamunatanga taha-kiritaki marama.
5
+
6
+ # Ihirangi
7
+ * [He aha a Mobiletto?](#He aha-Mobiletto?)
8
+ * [Tīmatatanga tere](#Tīmata-tere)
9
+ * [Mobiletto CLI](#mobiletto-cli)
10
+ * [Putake](#Source)
11
+ * [Tāuta](#Tāuta)
12
+ * [Tautoko me te Putea](#Tautoko-me-Pūtea)
13
+ * [Whakamahinga Taketake](#Whakamahinga Taketake)
14
+ * [Metadata](#Metadata)
15
+ * [Kāhua kawemai kē](#Alternate-import-style)
16
+ * [Keteroki](#Keteroki)
17
+ * [Whakaata](#Whakaata)
18
+ * [Whakamunatanga Puata](#Whakamunatanga Puata)
19
+ * [Te hurihanga matua](#Key-huringa)
20
+ * [Atanga atekōkiri](#Atanga Atekōkiri)
21
+ * [Takitaki](#Takitaki)
22
+
23
+ # Panuitia tenei ki tetahi atu reo
24
+ Kua whakamaoritia tenei tuhinga README.md, ma te [hokeylization](https://github.com/cobbzilla/hokeylization), ki roto
25
+ **[nga reo katoa e tautokohia ana e Google Translate](https://cloud.google.com/translate/docs/languages)!**
26
+
27
+ E mohio ana ahau ehara i te mea tino tika, engari ko taku tumanako he pai ake i te kore!
28
+
29
+ [🇸🇦 Arapi](../ar/README.md)
30
+ [🇧🇩 Bengali](../bn/README.md)
31
+ [🇩🇪 Tiamana](../de/README.md)
32
+ [🇺🇸 Ingarihi](../en/README.md)
33
+ [🇪🇸 Paniora](../es/README.md)
34
+ [🇫🇷 Wīwī](../fr/README.md)
35
+ [🇹🇩 Hausa](../ha/README.md)
36
+ [🇮🇳 Hindi](../hi/README.md)
37
+ [🇮🇩 Indonesian](../id/README.md)
38
+ [🇮🇹 Itari](../it/README.md)
39
+ [🇯🇵 Japanese](../ja/README.md)
40
+ [🇰🇷 Korean](../ko/README.md)
41
+ [🇮🇳 Maranthi](../mr/README.md)
42
+ [🇵🇱 Polish](../pl/README.md)
43
+ [🇧🇷 Potiti](../pt/README.md)
44
+ [🇷🇺 Ruhia](../ru/README.md)
45
+ [🇰🇪 Swahili](../sw/README.md)
46
+ [🇵🇭 Tagalog](../tl/README.md)
47
+ [🇹🇷 Turkish](../tr/README.md)
48
+ [🇵🇰 Urdu](../ur/README.md)
49
+ [🇻🇳 Vietnamese](../vi/README.md)
50
+ [🇨🇳 Hainamana](../zh/README.md)
51
+
52
+
53
+ **[📚 ... Nga Reo Katoa ...](../README.md)**
54
+ ----
55
+
56
+ ### He raru kei tenei whakamaoritanga o te README?
57
+ Ko tenei whakamaoritanga o te [README] taketake(https://github.com/cobbzilla/mobiletto/blob/master/README.md)
58
+ kei te he -- *e tino manakohia nga whakatikatika!* Tukuna mai he [tono toia ki a GitHub](https://github.com/cobbzilla/mobiletto/pulls),
59
+ ki te kore koe e pai ki te mahi i tera, [whakatuwhera i tetahi take](https://github.com/cobbzilla/mobiletto/issues)
60
+
61
+ Ina hanga e koe he take GitHub hou mo te whakamaoritanga, mahia:
62
+ * whakauruhia te URL wharangi (kape/whakapiri mai i te pae wahitau tirotiro)
63
+ * whakaurua te tuhinga tika e he ana (tārua/whakapiri mai i te kaitirotiro)
64
+ * whakaahuatia mai he aha te he -- kei te he te whakamaoritanga? kua pakaru te whakatakotoranga?
65
+ * tuku mai he whakaaro mo te whakamaoritanga pai ake, me pehea ranei te whakatakotoranga tika o te tuhinga
66
+ * **Mauruuru!**
67
+
68
+ ## He aha a Mobiletto?
69
+
70
+ ### Kia ora te kaihoko maukati!
71
+ Ko nga momo kaiwhakarato rokiroki kapua he API hotokore. Ahakoa te hunga e ngana ana ki te "hototahi S3"
72
+ he whanonga motuhake.
73
+
74
+ Ina whiriwhiria e koe tetahi kaihoko rokiroki mo to taupānga, mena ka tohu tika koe ki to API, to taupānga
75
+ kei te whakawhirinaki inaianei ki tera ratonga. Ka haere te wa, ka whakaemihia te waehere, ka huri nga kaihoko
76
+ e kore e taea. Nau mai ki te ao ngahau o te raka kaihoko!
77
+
78
+ I hangaia a Mobiletto ki te whakaoti i tenei raru. Ma te whakawaehere i to taupānga ki te API a mobiletto, ka taea e koe
79
+ Hurihia nga kaiwhakarato rokiroki me te mohio ka rite te ahua o te paparanga rokiroki o to taupānga.
80
+
81
+ ### He whakamatautau nui
82
+ Ka whakamatautauhia nga taraiwa katoa mo te whanonga rite me te 60+ whakamatautau mo ia taraiwa.
83
+ Ka whakamatauhia e matou nga taraiwa katoa me nga huinga katoa o:
84
+ * Whakamunatanga: kua whakahohea me te mono
85
+ * Redis cache: kua whakahohea me te mono
86
+
87
+ Ma tenei huarahi ka mau te rongo ki a maatau ka rite tonu te mahi a mobiletto ahakoa ko wai te taraiwa e whakamahia ana e koe,
88
+ ahakoa ka taea e koe te keteroki me te whakamunatanga/ranei.
89
+
90
+ ### Tautoko taraiwa
91
+ Nga taraiwa rokiroki Mobiletto o naianei:
92
+ * `s3` : Amazon S3
93
+ * `b2` : Backblaze B2
94
+ * `local` : pūnaha kōnae rohe
95
+
96
+ *Ko nga takoha hei tautoko i te maha atu o nga kaiwhakarato rokiroki kapua e tino manakohia ana!*
97
+
98
+ ## mobiletto-cli
99
+ Ko te Mobiletto ka whakamahia hei whare pukapuka e etahi atu waehere JavaScript.
100
+
101
+ Hei mahi me te mobiletto i te raina whakahau, whakamahia [mobiletto-cli](https://www.npmjs.com/package/mobiletto-cli)
102
+
103
+ ## Puna
104
+ * [mobiletto i runga i GitHub](https://github.com/cobbzilla/mobiletto)
105
+ * [mobiletto on npm](https://www.npmjs.com/package/mobiletto)
106
+
107
+ ## Tautoko me te Putea
108
+ Kei te ngana ahau ki te noho hei kaiwhakawhanake rorohiko puna tuwhera ngaio. I mahi ahau i roto
109
+ te ahumahi rorohiko mo nga tau maha, kua timata ahau i nga kamupene angitu me te hoko atu ki nga kamupene a te iwi.
110
+ No tata nei ka ngaro taku mahi, a karekau he mahi ke atu i te rarangi
111
+
112
+ Na ka ngana ahau ki te tuhi i nga raupaparorohiko awhina me te kite mena ka mahi tera
113
+
114
+ Mena he pai ki a koe te whakamahi i tenei rorohiko, ka tino mihi ahau mo te
115
+ iti rawa [koha-marama ma Patreon](https://www.patreon.com/cobbzilla)
116
+
117
+ *Mauruuru!*
118
+
119
+ ## Tāutanga
120
+ Tāuta mā te whakamahi i te `npm` , i te `yarn` miro` ranei. Kei te pirangi pea koe ki te putanga `lite` e uru katoa nga
121
+ i whakamaoritia nga konae README:
122
+
123
+ npm install mobiletto-lite
124
+ yarn add mobiletto-lite
125
+
126
+ Mena kei te pirangi koe ki nga konae README i roto i nga reo katoa, whakauruhia te putanga katoa:
127
+
128
+ npm install mobiletto
129
+ yarn add mobiletto
130
+
131
+ ## Tīmata Tere
132
+ He tauira poto ma te whakamahi i te taraiwa mobiletto `s3` .
133
+
134
+ He rite tonu te mahi o tenei waehere mena he `b2`, he `b2` ranei te `local` .
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
+ ## Whakamahinga taketake
165
+ He tauira tino whanui ake, e whakaatu ana i te nuinga o nga ahuatanga e tukuna ana:
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
+ ## Raraunga meta
267
+ Ko te tono `metadata` he whakahoki metadata mo te whakaurunga punaha konae kotahi.
268
+ Waihoki, ko te uara whakahoki mai i te tono `list` he huinga ahanoa metadata.
269
+
270
+ He penei te ahua o te ahanoa metadata:
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
+ Ko te āhuatanga `type` ka taea te `file` , `dir` , `link` , te `special` ranei.
281
+
282
+ I runga i te momo atekōkiri, karekau pea te tono `list` e whakahoki āpure katoa. Ko te `name` ' me `type` āhuatanga
283
+ me noho tonu. Ma te tono `metadata` ka whakahoki mai i nga taonga katoa e waatea ana.
284
+
285
+ ## Kāhua kawemai kē
286
+ Kawemai i te kōwae hōkai-katoa ka whakamahi i te mahi `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
+ ## Keteroki
294
+ He pai ake te mahi a Mobiletto me te keteroki <a href="https://redis.io">redis</a> .
295
+
296
+ Ka ngana a Mobiletto ki te hono atu ki tetahi tauira redis i te 127.0.0.1:6379
297
+
298
+ Ka taea e koe te whakakore i tetahi o enei:
299
+ * Tautuhia te `MOBILETTO_REDIS_HOST` env var, mobiletto hono ki konei hei utu mo te localhost
300
+ * Tautuhia te `MOBILETTO_REDIS_PORT` env var, ka whakamahia tenei tauranga
301
+
302
+ Ka rokirokia e Mobiletto ana taviri redis katoa me te prefix `_mobiletto__` . Ka taea e koe te huri i tenei
303
+ mā te tautuhi i te `MOBILETTO_REDIS_PREFIX` env var.
304
+
305
+ Ka taea hoki te whakarite keteroki hononga-hononga me te ahanoa `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
+ ### Kaore koe e hiahia ki te keteroki redis?
317
+ Hei mono: tukuna `enabled: false` ki to ahanoa `opts.redisConfig` ina whakau koe i to hononga.
318
+
319
+ Ka rite ki te korero i raro nei, ko te whakakore i te keteroki ka pa he kino ki te mahi me te nui ake o nga tono
320
+ ki te rokiroki e tino hiahia ana koe.
321
+
322
+ ### Arataki keteroki
323
+ **Pupuri whakamuna**: te panui/tuhi he puhoi ake te putunga whakamuna i te tikanga,
324
+ engari ko te whakatere huri noa i nga raarangi (he mahi etahi) he tino utu. Te whakamahi i te keteroki redis
325
+ ka hoatu e koe he whakanui mahi nui.
326
+
327
+ He haumaru te keteroki taunoa, engari kare e pai ana mena he maha nga mahi tuhi/tango.
328
+ Ko nga mahi tuhi, tango ranei ka whakakore i te keteroki katoa, me te whakarite ka kite nga panui ka whai ake
329
+ huringa hou.
330
+
331
+ ### taputapu CLI
332
+ Mena kei te whakamahi koe i tetahi taputapu CLI penei i a [mobiletto-cli](https://www.npmjs.com/package/mobiletto-cli),
333
+ Ka tino hiahia koe kia whakahohea te keteroki redis, na te mea ka mau tonu i nga tono o te whakahau `mo` .
334
+
335
+ ## Whakaata
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
+ Ko te whakahau `mirror` he mahi kape kotahi-wa o nga konae katoa mai i tetahi waea pūkoro ki tetahi atu.
344
+ Karekau he tukanga hei pupuri i te whakaata i roto i te waa. Whakahaerehia ano te tono `mirror`
345
+ ki te tukutahi i nga konae ngaro.
346
+
347
+ Ko te uara whakahoki mai i `mirror` ' he ahanoa ngawari me nga porotiti mo te maha o nga konae i angitu
348
+ i whakaatahia me te maha o nga konae i hapa:
349
+
350
+ {
351
+ success: count-of-files-mirrored,
352
+ errors: count-of-files-with-errors
353
+ }
354
+
355
+ WHAKATŪPATO: Ko te whakaata i nga huinga raraunga nui ka pau te waa me te whakapau kaha
356
+
357
+ Ki te `mirror` karanga semantics i etahi wa ka raruraru te mohio ko wai te
358
+ te kaipānui me wai te kaituhi. Whakaarohia he korero taumahi: te "maui-maui mobiletto"
359
+ Ko te mea e tukuna ana ki te (whakaata i nga raraunga kua tuhia), me te "matau-matau mobiletto" (te
360
+ tohenga ki te tikanga `mirror` ) ko te uara e tautapa ana (ka panuitia nga raraunga whakaata).
361
+
362
+ ## Whakamunatanga marama
363
+ Whakahohea te whakamunatanga taha-kiritaki marama:
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
+ Kei te aha? He whaiaronga "whakaurunga whaiaronga" (rere) motuhake (whakamuna) e whai ana he aha nga konae kei roto
383
+ whaiaronga (aka te whaiaronga whaiaro).
384
+ * Ko te tono `list` ka panui i nga konae whakaurunga whaiaronga, ka wetemuna ia ara kua whakarārangitia; ka whakahoki metadata mo ia kōnae
385
+ * Ko nga tono `list` he koretake ake, ina koa mo nga whaiaronga he maha nga konae
386
+ * Ko te tono `write` he tuhi i nga konae rereke ki roto i te raarangi whaiaronga o ia matua, he recursively; ka tuhia te kōnae
387
+ * Ko nga tono `write` ka puta he O(N) tuhi, me te N = te hohonu i roto i te rarangi whaiaronga.
388
+ * Ko te tono `remove` ka tango i te konae dirent e rite ana, me tona matua ki te putua, ka hoki whakamuri; ka tango i te konae
389
+ * Ko nga tono `remove` -kore ka puta te O(N) panui me te maha o nga mukunga, me te N = te hohonu i roto i te raarangi whaiaronga.
390
+ * He utu nui nga whakahau `remove` i runga i nga punaha konae nui me te hohonu
391
+
392
+ Kia mahara ahakoa kua whakahohea te whakamunatanga taha-kiritaki, he hoa riri e tino kitea ana ki to taha-tumau whakamuna.
393
+ te rokiroki, ahakoa kaore he ki, ka taea tonu te kite i te tapeke o nga raarangi whaiaronga me te maha o nga konae kei roto i ia waahanga, me era atu
394
+ kia kaha, kimihia etahi, te katoa ranei o te hanganga katoa o te rarangi whaiaronga.
395
+ *Tuhipoka: Whakamahia he hanganga ahua papatahi kia pai ake te haumarutanga.*
396
+ Kare te hoa riri e mohio ki nga ingoa o nga raarangi me nga konae mena ka mohio ano ratou ki to whakamunatanga
397
+ kī, i momoho rānei te whakamunatanga. Ka mutu nga peti katoa!
398
+
399
+ ### Mahinga me te keteroki
400
+ Ko nga mahi i runga i te rokiroki whakamunatia ka puhoi. Ko nga rarangi recursive me nga tangohanga ka tino puhoi.
401
+ He nui te awhina o te keteroki ma te redis, engari kia mohio kei te peehia te keteroki ki runga i nga tuhi ka tangohia ranei.
402
+
403
+ ## Te hurihanga matua
404
+ Waihangatia he waea pūkoro me to taviri hou, ka whakaatahia nga raraunga tawhito ki roto:
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
+ ## Atanga taraiwa
417
+ Ko te taraiwa he konae JS ka kaweake i te mahi 'storageClient' me tenei waitohu:
418
+
419
+ function storageClient (key, secret, opts)
420
+
421
+ * `key` : he aho, ko to API matua (mo te atekōkiri `local` koinei te whaiaronga turanga)
422
+ * `secret` : he aho, to API ngaro (ka taea te waiho mo te taraiwa `local` )
423
+ * `opts` : he ahanoa, ko ngā āhuatanga mō ia atekōkiri:
424
+ * Mo te `local` , ma nga `fileMode` me te `dirMode` e whakatau me pehea te hanga i nga konae hanga hou me nga whaiaronga.
425
+ * Mo `s3` , me hiahia te taonga `bucket` . Ko nga ahuatanga whiriwhiri ko:
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
+ Ko te ahanoa ka whakahokia mai e te mahi storageClient me tautuhi enei mahi:
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
+ ## Takitaki
457
+ Ka whakamahi a Mobiletto i te whare pukapuka takiuru [winston](https://www.npmjs.com/package/winston).
458
+
459
+ Kei roto i nga rangitaki ** nga ara konae me nga karere hapa, engari ka **kaore e mau nga taviri, nga mea ngaro,
460
+ etahi atu korero whirihoranga hononga ranei.
461
+
462
+ ### Taumata rangitaki
463
+ Whakamahia te taurangi taiao `MOBILETTO_LOG_LEVEL` ki te tautuhi i te taumata rangitaki, ma te whakamahi i tetahi
464
+ o nga taumata `npm` kua tautuhia ki [https://www.npmjs.com/package/winston#logging-levels](https://www.npmjs.com/package/winston#logging-levels)
465
+
466
+ Ko te taumata taunoa ko `error` . Ko te taumata tino kupu ko te `silly` , ahakoa he motini i tenei wa
467
+ karekau e takiuru ki nga taumata i raro iho i `debug`
468
+
469
+ MOBILETTO_LOG_LEVEL=silly # maximum logs!
470
+
471
+ ### Kōnae rangitaki
472
+ Ma te taunoa, ka tuhi te kairakau ki te papatohu. Hei tuku rangitaki ki tetahi konae, tautuhia te `MOBILETTO_LOG_FILE`
473
+ taurangi taiao. I te wa e takiuru ana ki tetahi konae, ka kore e tuhia nga raarangi ki te papatohu.
474
+
475
+ MOBILETTO_LOG_FILE=/var/my_mobiletto_log
476
+
477
+ Hei whakaweto i te takiuru:
478
+
479
+ MOBILETTO_LOG_FILE=/dev/null
480
+
481
+ </pre>