mobiletto 1.2.0 → 2.0.0

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 (127) hide show
  1. package/lib/cjs/index.d.ts +2 -0
  2. package/lib/cjs/index.js +30 -0
  3. package/lib/cjs/package.json +16 -0
  4. package/lib/esm/index.d.ts +2 -0
  5. package/lib/esm/index.js +12 -0
  6. package/package.json +27 -13
  7. package/.babelrc +0 -5
  8. package/.eslintrc.js +0 -14
  9. package/docs/README.md +0 -113
  10. package/docs/af/README.md +0 -481
  11. package/docs/am/README.md +0 -481
  12. package/docs/ar/README.md +0 -481
  13. package/docs/az/README.md +0 -481
  14. package/docs/be/README.md +0 -481
  15. package/docs/bg/README.md +0 -481
  16. package/docs/bn/README.md +0 -481
  17. package/docs/bs/README.md +0 -481
  18. package/docs/ca/README.md +0 -481
  19. package/docs/ceb/README.md +0 -481
  20. package/docs/co/README.md +0 -481
  21. package/docs/cs/README.md +0 -481
  22. package/docs/cy/README.md +0 -481
  23. package/docs/da/README.md +0 -481
  24. package/docs/de/README.md +0 -481
  25. package/docs/el/README.md +0 -481
  26. package/docs/eo/README.md +0 -481
  27. package/docs/es/README.md +0 -481
  28. package/docs/et/README.md +0 -481
  29. package/docs/eu/README.md +0 -481
  30. package/docs/fa/README.md +0 -481
  31. package/docs/fi/README.md +0 -481
  32. package/docs/fr/README.md +0 -481
  33. package/docs/fy/README.md +0 -481
  34. package/docs/ga/README.md +0 -481
  35. package/docs/gd/README.md +0 -481
  36. package/docs/gl/README.md +0 -481
  37. package/docs/gu/README.md +0 -481
  38. package/docs/ha/README.md +0 -481
  39. package/docs/haw/README.md +0 -481
  40. package/docs/he/README.md +0 -481
  41. package/docs/hi/README.md +0 -481
  42. package/docs/hmn/README.md +0 -481
  43. package/docs/hr/README.md +0 -481
  44. package/docs/ht/README.md +0 -481
  45. package/docs/hu/README.md +0 -481
  46. package/docs/hy/README.md +0 -481
  47. package/docs/id/README.md +0 -481
  48. package/docs/ig/README.md +0 -481
  49. package/docs/is/README.md +0 -481
  50. package/docs/it/README.md +0 -481
  51. package/docs/iw/README.md +0 -481
  52. package/docs/ja/README.md +0 -481
  53. package/docs/jv/README.md +0 -481
  54. package/docs/ka/README.md +0 -481
  55. package/docs/kk/README.md +0 -481
  56. package/docs/km/README.md +0 -481
  57. package/docs/kn/README.md +0 -481
  58. package/docs/ko/README.md +0 -481
  59. package/docs/ku/README.md +0 -481
  60. package/docs/ky/README.md +0 -481
  61. package/docs/la/README.md +0 -481
  62. package/docs/lb/README.md +0 -481
  63. package/docs/lo/README.md +0 -481
  64. package/docs/lt/README.md +0 -481
  65. package/docs/lv/README.md +0 -481
  66. package/docs/mg/README.md +0 -481
  67. package/docs/mi/README.md +0 -481
  68. package/docs/mk/README.md +0 -481
  69. package/docs/ml/README.md +0 -481
  70. package/docs/mn/README.md +0 -481
  71. package/docs/mr/README.md +0 -481
  72. package/docs/ms/README.md +0 -481
  73. package/docs/mt/README.md +0 -481
  74. package/docs/my/README.md +0 -481
  75. package/docs/ne/README.md +0 -481
  76. package/docs/nl/README.md +0 -481
  77. package/docs/no/README.md +0 -481
  78. package/docs/ny/README.md +0 -481
  79. package/docs/or/README.md +0 -481
  80. package/docs/pa/README.md +0 -481
  81. package/docs/pl/README.md +0 -481
  82. package/docs/ps/README.md +0 -481
  83. package/docs/pt/README.md +0 -481
  84. package/docs/ro/README.md +0 -481
  85. package/docs/ru/README.md +0 -481
  86. package/docs/rw/README.md +0 -481
  87. package/docs/sd/README.md +0 -481
  88. package/docs/si/README.md +0 -481
  89. package/docs/sk/README.md +0 -481
  90. package/docs/sl/README.md +0 -481
  91. package/docs/sm/README.md +0 -481
  92. package/docs/sn/README.md +0 -481
  93. package/docs/so/README.md +0 -481
  94. package/docs/sq/README.md +0 -481
  95. package/docs/sr/README.md +0 -481
  96. package/docs/st/README.md +0 -481
  97. package/docs/su/README.md +0 -481
  98. package/docs/sv/README.md +0 -481
  99. package/docs/sw/README.md +0 -481
  100. package/docs/ta/README.md +0 -481
  101. package/docs/te/README.md +0 -481
  102. package/docs/tg/README.md +0 -481
  103. package/docs/th/README.md +0 -481
  104. package/docs/tk/README.md +0 -481
  105. package/docs/tl/README.md +0 -481
  106. package/docs/tr/README.md +0 -481
  107. package/docs/tt/README.md +0 -481
  108. package/docs/ug/README.md +0 -481
  109. package/docs/uk/README.md +0 -481
  110. package/docs/ur/README.md +0 -481
  111. package/docs/uz/README.md +0 -481
  112. package/docs/vi/README.md +0 -481
  113. package/docs/xh/README.md +0 -481
  114. package/docs/yi/README.md +0 -481
  115. package/docs/yo/README.md +0 -481
  116. package/docs/zh/README.md +0 -481
  117. package/docs/zu/README.md +0 -481
  118. package/drivers/b2/index.js +0 -451
  119. package/drivers/local/index.js +0 -315
  120. package/drivers/s3/index.js +0 -316
  121. package/hokey.json +0 -16
  122. package/index.js +0 -10
  123. package/test/api.spec.js +0 -512
  124. package/test/crypt.spec.js +0 -67
  125. package/util/crypt.js +0 -80
  126. package/util/logger.js +0 -27
  127. package/util/redis.js +0 -233
package/docs/su/README.md DELETED
@@ -1,481 +0,0 @@
1
- Mobiletto
2
- =========
3
-
4
- Mobiletto mangrupikeun lapisan abstraksi neundeun JavaScript, kalayan énkripsi sisi klien transparan pilihan.
5
-
6
- # Eusi
7
- * [Naha Mobiletto?](#Naha-Mobiletto?)
8
- * [Mimitian Gancang](#Mimitian Gancang)
9
- * [Mobiletto CLI](#mobiletto-cli)
10
- * [Sumber](#Sumber)
11
- * [Pamasangan](#Pasang)
12
- * [Rojongan sareng Pembiayaan](#Rojongan-sareng-Dana)
13
- * [Pamakéan Dasar](#Pamakéan Dasar)
14
- * [Metadata](#Metadata)
15
- * [Gaya impor alternatip](#gaya-impor alternatif)
16
- * [Caching](#Caching)
17
- * [Mirroring](#Mirroring)
18
- * [Enkripsi Transparan](#Enkripsi Transparan)
19
- * [Rotasi konci](#Rotasi konci)
20
- * [Antarmuka Supir](#Supir-antarmuka)
21
- * [Logging](#Logging)
22
-
23
- # Baca ieu dina basa sanés
24
- Dokumén README.md ieu parantos ditarjamahkeun, ngalangkungan [hokeylization](https://github.com/cobbzilla/hokeylization), kana
25
- **[sagala basa dirojong ku Google Tarjamah](https://cloud.google.com/translate/docs/languages)!**
26
-
27
- Kuring yakin éta teu sampurna, tapi kuring miharep éta leuwih hade tinimbang nanaon!
28
-
29
- [🇸🇦 Arab](../ar/README.md)
30
- [🇧🇩 Bengali](../bn/README.md)
31
- [🇩🇪 Jerman](../de/README.md)
32
- [🇺🇸 Basa Sunda](../en/README.md)
33
- [🇪🇸 Spanyol](../es/README.md)
34
- [🇫🇷 Perancis](../fr/README.md)
35
- [🇹🇩 Hausa](../ha/README.md)
36
- [🇮🇳 Hindi](../hi/README.md)
37
- [🇮🇩 Indonésia](../id/README.md)
38
- [🇮🇹 Italia](../it/README.md)
39
- [🇯🇵 Basa Jepang](../ja/README.md)
40
- [🇰🇷 Koréa](../ko/README.md)
41
- [🇮🇳 Marathi](../mr/README.md)
42
- [🇵🇱 Polandia](../pl/README.md)
43
- [🇧🇷 Portugis](../pt/README.md)
44
- [🇷🇺 Rusia](../ru/README.md)
45
- [🇰🇪 Swahili](../sw/README.md)
46
- [🇵🇭 Tagalog](../tl/README.md)
47
- [🇹🇷 Turki](../tr/README.md)
48
- [🇵🇰 Urdu](../ur/README.md)
49
- [🇻🇳 Vietnam](../vi/README.md)
50
- [🇨🇳 Cina](../zh/README.md)
51
-
52
-
53
- **[📚 ... Sadaya Basa ...](../README.md)**
54
- ----
55
-
56
- ### Naha aya masalah sareng tarjamahan README ieu?
57
- Tarjamahan khusus ieu tina [README] asli (https://github.com/cobbzilla/mobiletto/blob/master/README.md)
58
- meureun cacad -- *koreksi pisan wilujeng sumping!* Punten kirimkeun [permintaan tarik dina GitHub](https://github.com/cobbzilla/mobiletto/pulls),
59
- atanapi upami anjeun teu nyaman ngalakukeun éta, [buka masalah](https://github.com/cobbzilla/mobiletto/issues)
60
-
61
- Lamun anjeun nyieun masalah GitHub anyar ngeunaan tarjamahan, mangga ngalakukeun:
62
- * kalebet URL halaman (salinan/témpél tina bar alamat browser)
63
- * kalebet téks anu leres anu salah (salin/témpél tina browser)
64
- * Punten terangkeun naon anu lepat -- naha tarjamahanna lepat? formatna rusak kumaha bae?
65
- * punten nawiskeun usulan tarjamahan anu langkung saé, atanapi kumaha téks kedah diformat leres
66
- * **Hatur nuhun!**
67
-
68
- ## Naha Mobiletto?
69
-
70
- ### Wilujeung seller lock-in!
71
- Rupa-rupa panyadia panyimpen awan gaduh API anu teu cocog. Malah anu narékahan pikeun "kasaluyuan S3"
72
- boga paripolah idiosinkratis.
73
-
74
- Lamun anjeun milih ngajual gudang husus pikeun aplikasi Anjeun, lamun kode langsung ka API maranéhna, aplikasi Anjeun
75
- ayeuna gumantung kana jasa éta. Salaku waktu ngalir jeung kode accumulates, ngarobah ngical paralatan janten
76
- beuki teu bisa dipertahankeun. Wilujeng sumping di dunya anu pikaresepeun tina vendor lock-in!
77
-
78
- Mobiletto dirancang pikeun ngajawab masalah ieu. Ku coding aplikasi anjeun ka mobiletto urang API, anjeun bisa kalayan gampang
79
- robih panyadia panyimpen sareng terang yén lapisan panyimpen aplikasi anjeun bakal kalakuanana idéntik.
80
-
81
- ### Tés éksténsif
82
- Sadaya supir diuji pikeun paripolah anu sami sareng 60+ tés pikeun tiap supir.
83
- Kami nguji sadaya supir kalayan unggal kombinasi:
84
- * Énkripsi: duanana diaktipkeun sareng ditumpurkeun
85
- * Redis cache: duanana diaktipkeun jeung ditumpurkeun
86
-
87
- Pendekatan ieu masihan urang katenangan yén mobiletto bakal kalakuanana sami henteu paduli supir anu anjeun anggo,
88
- sareng henteu paduli naha anjeun ngaktipkeun cache sareng / atanapi énkripsi.
89
-
90
- ### Pangrojong supir
91
- Panggerak panyimpen Mobiletto ayeuna:
92
- * `s3` : Amazon S3
93
- * `b2` : Backblaze B2
94
- * `local` : sistem file lokal
95
-
96
- *Kontribusi pikeun ngadukung langkung seueur panyadia panyimpen awan ditampi pisan!*
97
-
98
- ## mobiletto-cli
99
- Mobiletto dimaksudkeun pikeun dipaké salaku perpustakaan ku kode JavaScript séjén.
100
-
101
- Pikeun damel sareng mobiletto dina garis paréntah, paké [mobiletto-cli](https://www.npmjs.com/package/mobiletto-cli)
102
-
103
- ## Sumber
104
- * [mobiletto on GitHub](https://github.com/cobbzilla/mobiletto)
105
- * [mobiletto on npm](https://www.npmjs.com/package/mobiletto)
106
-
107
- ## Rojongan sareng Pembiayaan
108
- Kuring nyobian janten pamekar software open source profésional. Kuring geus digawé di
109
- industri software salila sababaraha taun, Kuring geus dimimitian pausahaan suksés jeung dijual ka pausahaan umum.
110
- Anyar-anyar ieu kuring kaleungitan padamelan, sareng kuring henteu ngagaduhan padamelan anu sanés
111
-
112
- Janten kuring badé nyobian nyerat parangkat lunak anu mangpaat sareng ningali upami éta jalanna
113
-
114
- Upami anjeun resep nganggo parangkat lunak ieu, kuring bakal nganuhunkeun pisan pikeun malah
115
- pangleutikna [kontribusi bulanan via Patreon](https://www.patreon.com/cobbzilla)
116
-
117
- *Hatur nuhun!*
118
-
119
- ## Pamasangan
120
- Pasang nganggo `npm` atawa `yarn` . Anjeun panginten hoyong versi `lite` anu henteu kalebet sadayana
121
- file README ditarjamahkeun:
122
-
123
- npm install mobiletto-lite
124
- yarn add mobiletto-lite
125
-
126
- Upami anjeun hoyong file README dina unggal basa, pasang versi lengkepna:
127
-
128
- npm install mobiletto
129
- yarn add mobiletto
130
-
131
- ## Mimitian Gancang
132
- Conto pondok nganggo supir `s3` .
133
-
134
- Kode ieu bakal dijalankeun sami upami supirna `b2` atanapi `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
- ## Pamakéan dasar
165
- Conto anu langkung ageung, nunjukkeun seueur fitur anu ditawarkeun:
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
- ## Métadata
267
- Paréntah `metadata` mulangkeun metadata ngeunaan éntri sistem file tunggal.
268
- Kitu ogé, nilai mulang tina paréntah `list` mangrupa susunan objék metadata.
269
-
270
- Obyék metadata sapertos kieu:
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
- `type` bisa jadi `file` , `dir` , `link` , atawa `special` .
281
-
282
- Gumantung kana jinis supir, paréntah `list` moal tiasa mulangkeun sadaya widang. The `name` jeung `type` sipat
283
- kudu salawasna hadir. Paréntah `metadata` salajengna bakal mulangkeun sadaya sipat anu sayogi.
284
-
285
- ## Gaya impor alternatip
286
- Impor modul pinuh-scoped tur nganggo fungsi `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
- ## Cache
294
- Mobiletto jalan pangalusna kalawan cache <a href="https://redis.io">redis</a> .
295
-
296
- Mobiletto bakal nyobian nyambung ka instansi redis on 127.0.0.1:6379
297
-
298
- Anjeun tiasa nimpa salah sahiji ieu:
299
- * Setel `MOBILETTO_REDIS_HOST` env var, mobiletto nyambung ka dieu tinimbang localhost
300
- * Setel env var `MOBILETTO_REDIS_PORT` , port ieu bakal dianggo
301
-
302
- Mobiletto bakal nyimpen sadaya konci redis na nganggo awalan `_mobiletto__` . Anjeun tiasa ngarobah ieu
303
- ku nyetel `MOBILETTO_REDIS_PREFIX` env var.
304
-
305
- Anjeun ogé tiasa nyetél cache per-konéksi sareng obyék `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
- ### Henteu hoyong redis cache?
317
- Pikeun nganonaktipkeun: `enabled: false` dina obyék `opts.redisConfig` anjeun nalika anjeun netepkeun sambungan anjeun.
318
-
319
- Sapertos anu dibahas di handap, nganonaktipkeun cache bakal gaduh pangaruh anu ngabahayakeun kana kinerja sareng nyababkeun langkung seueur pamundut
320
- ka gudang nu bener kudu.
321
-
322
- ### Pitunjuk cache
323
- **Panyimpenan énkripsi**: Panyimpenan énkripsi maca/nulis ngan ukur langkung laun tibatan biasana,
324
- tapi nganapigasi sabudeureun directories (anu sababaraha hal ngalakukeun) cukup mahal. Ngagunakeun cache redis
325
- bakal masihan anjeun dorongan kinerja anu signifikan.
326
-
327
- The cache standar geus aman, tapi teu nedunan ogé lamun geus loba nulis / miceun operasi.
328
- Sagala operasi nulis atawa cabut invalidates sakabéh cache, mastikeun maca saterusna bakal ningali
329
- parobahan panganyarna.
330
-
331
- ### parabot CLI
332
- Upami anjeun nganggo alat CLI sapertos [mobiletto-cli](https://www.npmjs.com/package/mobiletto-cli),
333
- Anjeun pasti bakal hoyong cache redis diaktipkeun, sabab lumangsung dina invocations tina paréntah `mo` .
334
-
335
- ## Ngeunteung
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
- Paréntah `mirror` ngalakukeun salinan hiji-waktos sadaya file tina hiji mobiletto ka anu sanés.
344
- Éta henteu ngajalankeun prosés naon waé pikeun ngajaga eunteung kana waktosna. Jalankeun paréntah `mirror` deui
345
- pikeun nyingkronkeun file anu leungit.
346
-
347
- Nilai balik ti `mirror` mangrupakeun obyék basajan kalawan counters pikeun sabaraha file anu hasil
348
- mirrored sareng sabaraha file anu ngagaduhan kasalahan:
349
-
350
- {
351
- success: count-of-files-mirrored,
352
- errors: count-of-files-with-errors
353
- }
354
-
355
- PERHATOSAN: Mirroring set data badag bisa jadi pisan consuming waktu jeung rubakpita-intensif
356
-
357
- Ku `mirror` semantik panggero kadang bisa jadi bingung ngartos saha teh
358
- pamaca jeung saha nu nulisna. Bayangkeun éta sapertos pernyataan tugas: "mobiletto kénca"
359
- nyaeta hal anu ditugaskeun ka (data mirrored ditulis), sarta "mobiletto-leungeun katuhu" (the
360
- argumen kana métode `mirror` ) nyaéta nilai anu ditugaskeun (data mirrored dibaca).
361
-
362
- ## Énkripsi transparan
363
- Aktipkeun énkripsi sisi klien transparan:
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
- Aya naon? Diréktori "Éntri diréktori" (dirent) anu misah (énkripsi) ngalacak file naon anu aya dina éta
383
- diréktori (alias diréktori langsung).
384
- * Paréntah `list` maca file éntri diréktori, ngadekrip unggal jalur anu didaptarkeun; lajeng mulih metadata pikeun tiap file
385
- * Paréntah `list` langkung teu éfisién, khususna pikeun diréktori anu seueur file
386
- * Paréntah `write` nyerat file dirent dina diréktori dirent unggal indungna, sacara rekursif; teras nyerat file
387
- * Paréntah `write` bakal ditanggung O(N) nyerat, kalayan N = jerona dina hirarki diréktori
388
- * Paréntah `remove` ngahapus file dirent anu saluyu, sareng indungna upami kosong, sacara rekursif; lajeng miceun file
389
- * Paréntah `remove` non-rekursif bakal ngahasilkeun O(N) maca sareng berpotensi ngahapus, kalayan N = jerona dina hirarki diréktori
390
- * Paréntah `remove` dina sistem file anu ageung sareng jero tiasa mahal
391
-
392
- Catet yén sanajan énkripsi sisi klien diaktipkeun, musuh anu gaduh visibilitas pinuh kana sisi server énkripsi anjeun.
393
- gudang, sanajan tanpa konci, masih bisa ningali jumlah total directories na sabaraha file dina unggal, tur kalawan
394
- sababaraha usaha , manggihan sababaraha atawa sakabéh struktur sakabéh hirarki diréktori.
395
- *Catetan: Anggo struktur anu kawilang datar pikeun kaamanan anu langkung saé.*
396
- Musuh moal terang nami diréktori / file kecuali aranjeunna ogé terang énkripsi anjeun
397
- konci atawa geus disebutkeun hasil retakan enkripsi. Kabéh bets pareum lajeng!
398
-
399
- ### Kinerja sareng cache
400
- Operasi dina panyimpenan énkripsi tiasa laun. Listing rekursif sareng panyabutan tiasa lambat pisan.
401
- Caching via redis mantuan tremendously, tapi perhatikeun yén cache ieu flushed kana sagala nyerat atanapi ngahapus.
402
-
403
- ## Rotasi konci
404
- Jieun mobiletto kalawan konci anyar anjeun, lajeng eunteung data heubeul kana eta:
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
- ## Antarmuka supir
417
- Supir mangrupikeun file JS anu ngékspor fungsi 'storageClient' kalayan tanda tangan ieu:
418
-
419
- function storageClient (key, secret, opts)
420
-
421
- * `key` : string, konci API anjeun (pikeun supir `local` ieu diréktori dasar)
422
- * `secret` : string, rusiah API anjeun (tiasa dileungitkeun pikeun supir `local` )
423
- * `opts` : hiji obyék, sipatna per-driver:
424
- * Pikeun `local` , `fileMode` jeung `dirMode` nangtukeun kumaha nyieun file jeung diréktori anyar dijieun.
425
- * Pikeun `s3` , sipat `bucket` diperlukeun. Sipat opsional nyaéta:
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
- Obyék anu dipulangkeun ku fungsi storageClient kedah nangtukeun fungsi ieu:
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
- ## logging
457
- Mobiletto ngagunakeun perpustakaan logging [winston](https://www.npmjs.com/package/winston).
458
-
459
- Log ** bakal ** ngandung jalur file sareng pesen kasalahan, tapi bakal ** moal pernah ** ngandung konci, rahasia,
460
- atanapi inpormasi konfigurasi sambungan anu sanés.
461
-
462
- ### Tingkat log
463
- Anggo variabel lingkungan `MOBILETTO_LOG_LEVEL` pikeun nyetél tingkat log, nganggo hiji
464
- tina tingkat `npm` didefinisikeun dina [https://www.npmjs.com/package/winston#logging-levels](https://www.npmjs.com/package/winston#logging-levels)
465
-
466
- Tingkat standar nyaéta `error` . Tingkat paling verbose nyaéta `silly` , sanajan ayeuna mobiletto
467
- teu asup dina tingkat handap `debug`
468
-
469
- MOBILETTO_LOG_LEVEL=silly # maximum logs!
470
-
471
- ### Berkas log
472
- Sacara standar, logger nyerat kana konsol. Pikeun ngirim log ka file, setel `MOBILETTO_LOG_FILE`
473
- variabel lingkungan. Nalika asup kana file, log moal ditulis deui kana konsol.
474
-
475
- MOBILETTO_LOG_FILE=/var/my_mobiletto_log
476
-
477
- Pikeun mareuman logging:
478
-
479
- MOBILETTO_LOG_FILE=/dev/null
480
-
481
- </pre>