mobiletto 1.1.8 → 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 (117) hide show
  1. package/README.md +56 -4
  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 +33 -17
  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,455 @@
1
+ Mobiletto
2
+ =========
3
+
4
+ Mobiletto qatek abstrakasyona hilanînê ya JavaScript-ê ye, bi şîfrekirina bijarte ya ji alîyê xerîdar ve.
5
+
6
+ # Naverok
7
+ * [Çima Mobiletto?](#Çima-Mobiletto?)
8
+ * [Destpêka Bilez](#Destpêka Zû)
9
+ * [Mobiletto CLI](#mobiletto-cli)
10
+ * [Çavkanî](#Çavkanî)
11
+ * [Bikaranîna bingehîn](#Bikaranîna bingehîn)
12
+ * [Metadata](#Metadata)
13
+ * [Şêweya importa alternatîf](#Alternate-import-style)
14
+ * [Caching](#Caching)
15
+ * [Mirroring](#Mirroring)
16
+ * [Şîfrekirina Transparent](#Transparent-şîfrekirin)
17
+ * [Zivirandina Bişkojê](#zivirandina Bişkojê)
18
+ * [Navbera ajokerê](#Navenda ajokar)
19
+ * [Têketin](# Têketin)
20
+
21
+ # Vê bi zimanekî din bixwînin
22
+ Ev belgeya README.md, bi rêya [hokeylization](https://github.com/cobbzilla/hokeylization) hatiye wergerandin.
23
+ **[her ziman ji hêla Google Wergerê ve tê piştgirî kirin](https://cloud.google.com/translate/docs/languages)!**
24
+
25
+ Ez bawer im ku ew ne bêkêmasî ye, lê ez hêvî dikim ku ew ji tunebûnê çêtir e!
26
+
27
+ [🇸🇦 Erebî](belge/ar/README.md)
28
+ [🇧🇩 Bengali](belge/bn/README.md)
29
+ [🇩🇪 Almanî](belge/de/README.md)
30
+ [🇺🇸 Îngilîzî](belge/ku/README.md)
31
+ [🇪🇸 Spanî](belge/es/README.md)
32
+ [🇫🇷 Fransî](belge/fr/README.md)
33
+ [🇹🇩 Hausa](belge/ha/README.md)
34
+ [🇮🇳 Hindi](belge/hi/README.md)
35
+ [🇮🇩 Endonezyayî](belge/id/README.md)
36
+ [🇮🇹 Îtalî](belge/it/README.md)
37
+ [🇯🇵 Japonî](belge/ja/README.md)
38
+ [🇰🇷 Koreyî](../ko/README.md)
39
+ [🇮🇳 Maranthi](belge/mr/README.md)
40
+ [🇵🇱 Polonî](belge/pl/README.md)
41
+ [🇧🇷 Portekîzî](belge/pt/README.md)
42
+ [🇷🇺 Rûsî](belge/ru/README.md)
43
+ [🇰🇪 Swahili](belge/sw/README.md)
44
+ [🇵🇭 Tagalog](belge/tl/README.md)
45
+ [🇹🇷 Tirkî](../tr/README.md)
46
+ [🇵🇰 Urdu](belge/ur/README.md)
47
+ [🇻🇳 Viyetnamî](belge/vi/README.md)
48
+ [🇨🇳 Çînî](belge/zh/README.md)
49
+
50
+
51
+ **[📚 ... Hemû Ziman ...](belge/README.md)**
52
+ ----
53
+
54
+ ### Di vê wergera README de pirsgirêkek heye?
55
+ Ev wergera taybetî ya orîjînal [README](https://github.com/cobbzilla/mobiletto/blob/master/README.md)
56
+ dibe ku xelet be -- *serrastkirin pir bi xêr hatin!* Ji kerema xwe [daxwaza vekişînê li ser GitHub] bişînin (https://github.com/cobbzilla/mobiletto/pulls),
57
+ an heke hûn ne rehet in ku wiya bikin, [pirsek veke](https://github.com/cobbzilla/mobiletto/issues)
58
+
59
+ Dema ku hûn der barê wergerekê de pirsgirêkek nû ya GitHub çêkin, ji kerema xwe bikin:
60
+ * URL-ya rûpelê têxe (ji barika navnîşana gerokê kopî/pêç bike)
61
+ * nivîsa tam a ku xelet e tê de (ji gerokê kopî/paste)
62
+ * ji kerema xwe re şirove bike ka çi xelet e -- werger xelet e? formatkirin bi rengekî şikestî ye?
63
+ * Ji kerema xwe pêşniyarek wergerek çêtir pêşkêşî bikin, an jî nivîs çawa bi rêkûpêk were şekil kirin
64
+ * **Spas dikim!**
65
+
66
+ ## Çima Mobiletto?
67
+
68
+ ### Bi xatirê te lock-in firoşkar!
69
+ Pêşkêşvanên cihêreng hilanîna ewr xwedan API-yên hevgirtî ne. Tewra yên ku ji bo "lihevhatina S3" hewl didin
70
+ xwedî tevgerên xwerû.
71
+
72
+ Gava ku hûn ji bo sepana xwe firoşkarek hilanînê ya taybetî hilbijêrin, heke hûn rasterast li API-ya wan, sepana xwe kod bikin
73
+ niha girêdayî wê xizmetê ye. Her ku dem derbas dibe û kod kom dibe, guhertina firoşkaran dibe
74
+ her ku diçe bêhêz dibe. Hûn bi xêr hatin cîhana kêfê ya firoşkarê kilîtkirî!
75
+
76
+ Mobiletto ji bo çareserkirina vê pirsgirêkê hate çêkirin. Bi kodkirina sepana xwe li API-ya mobiletto, hûn dikarin bi hêsanî
77
+ pêşkêşkerên hilanînê biguhezînin û zanibin ku qata hilanîna serîlêdana we dê bi heman rengî tevbigere.
78
+
79
+ ### Testkirina berfireh
80
+ Hemî ajokar ji bo her ajokerek 60+ ceribandinan ji bo behreyên yeksan têne ceribandin.
81
+ Em hemî ajokaran bi her kombînasyona:
82
+ * Şîfrekirin: hem çalak û hem jî neçalak
83
+ * Redis cache: hem çalak û hem jî neçalak
84
+
85
+ Ev nêzîkatî ji me re aramiyê dide ku mobiletto dê bi heman rengî tevbigere bêyî ku hûn kîjan ajokerê bikar bînin,
86
+ û bêyî ku hûn cachkirin û/an şîfrekirinê çalak bikin.
87
+
88
+ ### Piştgiriya ajokar
89
+ Ajokarên hilanînê yên Mobiletto yên heyî:
90
+ * `s3` : Amazon S3
91
+ * `b2` : Backblaze B2
92
+ * `local` : pergala pelan a herêmî
93
+
94
+ *Beşdariyên ji bo piştgirîkirina bêtir pêşkêşkerên hilanîna ewr pir bi xêr hatin!*
95
+
96
+ ## mobiletto-cli
97
+ Mobiletto armanc e ku wekî pirtûkxane ji hêla kodên din ên JavaScript-ê ve were bikar anîn.
98
+
99
+ Ji bo ku di xeta fermanê de bi mobiletto re bixebitin, [mobiletto-cli] bikar bînin (https://www.npmjs.com/package/mobiletto-cli)
100
+
101
+ ## Çavkanî
102
+ * [mobiletto li ser GitHub](https://github.com/cobbzilla/mobiletto)
103
+ * [mobiletto li ser npm](https://www.npmjs.com/package/mobiletto)
104
+
105
+ ## Destpêka Zû
106
+ Mînakek kurt a ajokera `s3` ya mobiletto bikar tîne.
107
+
108
+ Heke ajoker `b2` an jî "herêmî" be ev kod dê bi heman rengî `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
+ ## Bikaranîna bingehîn
139
+ Mînakek pir berfirehtir, ku piraniya taybetmendiyên pêşkêşkirî destnîşan dike:
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
+ Fermana `metadata` metadata li ser yek têketina pergala pelan vedigerîne.
242
+ Bi heman awayî, nirxa vegerê ya ji fermana `list` komek ji tiştên metadata ye.
243
+
244
+ Tiştek metadata wiha xuya dike:
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
+ Taybetmendiya `type` dikare bibe `file` , `dir` , `link` an jî `special` .
255
+
256
+ Li gorî celebê ajokerê, dibe ku `list` hemî qadan venegerîne. Taybetmendiyên `name` û `type`
257
+ divê her tim hebe. Fermana `metadata` ya paşîn dê hemî taybetmendiyên berdest vegerîne.
258
+
259
+ ## Şêweya importa alternatîf
260
+ Modula bi tevahî-scope derxînin û fonksiyona `connect` bikar bînin:
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 bi cache <a href="https://redis.io">redis</a> çêtirîn dixebite.
269
+
270
+ Mobiletto dê hewl bide ku li ser 127.0.0.1:6379 bi mînakek redis ve girêbide
271
+
272
+ Hûn dikarin van yek ji wan bişopînin:
273
+ * `MOBILETTO_REDIS_HOST` env var saz bike, ji bo ku li şûna hosteya herêmî li vir were girêdan
274
+ * `MOBILETTO_REDIS_PORT` env var saz bike, ev port dê were bikar anîn
275
+
276
+ Mobiletto dê hemî bişkojkên xwe yên redis bi pêşgira `_mobiletto__` . Hûn dikarin vê biguherînin
277
+ bi `MOBILETTO_REDIS_PREFIX` env var.
278
+
279
+ Her weha hûn dikarin cachkirina per-girêdanê bi `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
+ ### Redis caching naxwazin?
291
+ Ji bo neçalakkirinê: gava ku hûn pêwendiya xwe saz dikin, di `opts.redisConfig` de `enabled: false` " derbas bikin.
292
+
293
+ Wekî ku li jêr hate nîqaş kirin, neçalakkirina caching dê bandorek neyînî li ser performansê bike û bêtir daxwaziyan bike
294
+ hilanîna ku hûn bi rastî hewce ne.
295
+
296
+ ### Rêbernameya caching
297
+ **Depokirina şîfrekirî **: xwendin/nivîsandina hilanîna şîfrekirî tenê ji ya normal hinekî hêdîtir e,
298
+ lê gera li dora pelrêçan (yên ku hin tişt dikin) pir biha ye. Bikaranîna cache redis
299
+ dê performansek girîng bide we.
300
+
301
+ Cache-ya xwerû ewle ye, lê heke gelek operasyonên nivîsandinê/rakirina we hebin baş naxebite.
302
+ Her operasyonek nivîsandinê an jêbirinê tevahiya cache betal dike, û piştrast dike ku xwendina paşîn dê wê bibîne
303
+ guhertinên dawî.
304
+
305
+ ### Amûrên CLI
306
+ Ger hûn amûrek CLI wekî [mobiletto-cli] bikar tînin (https://www.npmjs.com/package/mobiletto-cli),
307
+ hûn ê bê guman bixwazin ku cacheya redisê were çalak kirin, ji ber ku ew di nav bangên fermana `mo` de dimîne.
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
+ Fermana `mirror` kopiyek yek-carî ya hemî pelan ji yek mobilettoyek din pêk tîne.
318
+ Ji bo domandina neynikê bi demê re pêvajoyek nameşîne. Fermana `mirror` dîsa bixebite
319
+ ji bo senkronîzekirina pelên wenda.
320
+
321
+ Nirxa vegerê ya ji `mirror` tiştek sade ye bi hejmarkerên ku ji bo çend pelan bi serketî bûne
322
+ mirrored û çend pelan xelet bûn:
323
+
324
+ {
325
+ success: count-of-files-mirrored,
326
+ errors: count-of-files-with-errors
327
+ }
328
+
329
+ HIŞYARÎ: Neynkirina berhevokên daneya mezin dikare pir dem dixwe û firehiya bandê giran be
330
+
331
+ Bi semantîka navê `mirror` re carinan dibe ku meriv têbigihêje ka kî ye
332
+ xwendevan û nivîskar kî ye. Wê wekî daxuyaniyek peywirê bihesibînin: "mobîla destê çepê"
333
+ tişta ku jê re tê veqetandin (daneyên neynûkî hatine nivîsandin), û "mobîla destê rastê" (ya
334
+ argumana rêbaza `mirror` ) nirxa ku tê veqetandin e (daneyên neynikê têne xwendin).
335
+
336
+ ## Şîfrekirina zelal
337
+ Şîfrekirina şefaf ji aliyê xerîdar ve çalak bike:
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
+ Çi diqewime? Pelrêkek "têketina pelrêçê" (dirent) (şîfrekirî) ya cihê ku pelên di wê de hene dişopîne
357
+ pelrêça (navê pelrêça dirent).
358
+ * Fermana `list` pelên têketina pelrêçayê dixwîne, her rêyên ku hatine navnîş kirin deşîfre dike; paşê ji bo her pelê metadata vedigerîne
359
+ * `list` in, nemaze ji bo pelrêçên ku hejmareke mezin a pelan hene
360
+ * Fermana `write` nivîsandinê` pelên dirent di pelrêça dirent a her dêûbavan de, bi paşverû dinivîse; paşê pelê dinivîse
361
+ * `write` dê O(N) binivîse, bi N = kûrahî di hiyerarşiya pelrêçê de
362
+ * Fermana `remove` a têkildar, û dêûbavê wê heke vala be, bi dûbare jê dike; paşê pelê jê dike
363
+ * Fermanên `remove` yên ne-veger dê O(N) bixwîne û bi potansiyel bi qasî jêbirin, bi N = kûrahiya di hiyerarşiya pelrêçê de.
364
+ * `remove` yên vegerî yên li ser pergalên pelan ên mezin û kûr dikarin biha bin
365
+
366
+ Bala xwe bidinê ku tevî şîfrekirina ji aliyê xerîdar ve çalak be jî, dijminek bi xuyangiya tam li ser server-aliyê weya şîfrekirî
367
+ hilanînê, bêyî mifteyê jî, dîsa jî dikare jimara giştî ya pelrêçan û çend pelan di her yekê de û bi wan re bibîne
368
+ hin hewildan, hin an hemî avahiya giştî ya hiyerarşiya pelrêça kifş bikin.
369
+ * Nîşe: Ji bo ewlekariya çêtir avahiyek berbiçav bikar bînin.*
370
+ Dijmin dê navên pelrêçan/pelan nizanibe heya ku ew şîfrekirina we jî nezane
371
+ kilît an jî bi awayekî serketî şîfre şikandibû. Wê demê hemû behîs bi dawî ne!
372
+
373
+ ### Performansa û caching
374
+ Operasyonên li ser hilanîna şîfrekirî dikarin hêdî bibin. Lîsteyên veger û jêbirin dikarin pir hêdî bibin.
375
+ Caching bi rêya redis pir alîkariyek mezin dike, lê bala xwe bidin ku cache li ser her nivîsandinê an jêbirinê tê rijandin.
376
+
377
+ ## Zivirîna key
378
+ Bi mifteya xweya nû re mobiletto biafirînin, dûv re daneyên kevn di nav wê de neynikê bikin:
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
+ ## Navbera ajokar
391
+ Ajokar her pelek JS ye ku fonksiyonek 'storageClient' bi vê îmzeyê derdixe:
392
+
393
+ function storageClient (key, secret, opts)
394
+
395
+ * `key` : rêzek, mifteya API-ya we (ji bo ajokera `local` ev pelrêça bingehîn e)
396
+ * `secret` : xêzek, sira API-ya we (dibe ku ji bo ajokera `local` were derxistin)
397
+ * `opts` : tiştek, taybetmendî li ser ajokerê ne:
398
+ * Ji bo `local` , taybetmendiyên `fileMode` û `dirMode` diyar dikin ka pel û peldankên nû çawa têne afirandin.
399
+ * Ji bo `s3` , taybetmendiya `bucket` hewce ye. Taybetmendiyên bijartî ev in:
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
+ Tişta ku fonksiyona storageClient vedigerîne divê van fonksiyonan diyar bike:
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
+ ## Têketin
431
+ Mobiletto pirtûkxaneya têketinê [winston](https://www.npmjs.com/package/winston) bikar tîne.
432
+
433
+ Têketin ** dê ** rêyên pelan û peyamên xeletiyê hebin, lê dê ** çu carî ** mifteyên, razan nehewîne,
434
+ an agahdariya veavakirina girêdanê ya din.
435
+
436
+ ### Asta têketinê
437
+ Guherbara jîngehê ya `MOBILETTO_LOG_LEVEL` bikar bînin da ku asta têketinê saz bikin, yek bikar bînin
438
+ ji astên `npm` yên ku di [https://www.npmjs.com/package/winston#logging-levels] de hatine diyarkirin (https://www.npmjs.com/package/winston#logging-levels)
439
+
440
+ Asta `error` . Asta herî devkî `silly` e, her çend niha mobîl e
441
+ di astên li jêr `debug` de têkevê nake
442
+
443
+ MOBILETTO_LOG_LEVEL=silly # maximum logs!
444
+
445
+ ### Pelê têketinê
446
+ Bi xwerû, logger li konsolê dinivîse. Ji bo şandina têketinên pelê, `MOBILETTO_LOG_FILE` bike
447
+ guhêrbar jîngehê. Dema ku têketin pelê, têketin dê êdî li konsolê neyên nivîsandin.
448
+
449
+ MOBILETTO_LOG_FILE=/var/my_mobiletto_log
450
+
451
+ Ji bo qefilandina têketinê:
452
+
453
+ MOBILETTO_LOG_FILE=/dev/null
454
+
455
+ </pre>