mobiletto 1.2.1 → 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 (124) 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 -29
  123. package/test/api.spec.js +0 -512
  124. package/test/crypt.spec.js +0 -67
package/docs/ku/README.md DELETED
@@ -1,481 +0,0 @@
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
- * [Sazkirin](# Sazkirin)
12
- * [Piştgirî û Fînanse](#Piştgirî-û-Fona)
13
- * [Bikaranîna bingehîn](#Bikaranîna bingehîn)
14
- * [Metadata](#Metadata)
15
- * [Şêweya importa alternatîf](#Alternate-import-style)
16
- * [Caching](#Caching)
17
- * [Mirroring](#Mirroring)
18
- * [Şîfrekirina Transparent](#Transparent-şîfrekirin)
19
- * [Zivirandina Bişkojê](#zivirandina Bişkojê)
20
- * [Navbera ajokerê](#Navenda ajokar)
21
- * [Têketin](# Têketin)
22
-
23
- # Vê bi zimanekî din bixwînin
24
- Ev belgeya README.md, bi rêya [hokeylization](https://github.com/cobbzilla/hokeylization) hatiye wergerandin.
25
- **[her ziman ji hêla Google Wergerê ve tê piştgirî kirin](https://cloud.google.com/translate/docs/languages)!**
26
-
27
- Ez bawer im ku ew ne bêkêmasî ye, lê ez hêvî dikim ku ew ji tunebûnê çêtir e!
28
-
29
- [🇸🇦 Erebî](belge/ar/README.md)
30
- [🇧🇩 Bengali](belge/bn/README.md)
31
- [🇩🇪 Almanî](belge/de/README.md)
32
- [🇺🇸 Îngilîzî](belge/ku/README.md)
33
- [🇪🇸 Spanî](belge/es/README.md)
34
- [🇫🇷 Fransî](belge/fr/README.md)
35
- [🇹🇩 Hausa](belge/ha/README.md)
36
- [🇮🇳 Hindi](belge/hi/README.md)
37
- [🇮🇩 Endonezyayî](belge/id/README.md)
38
- [🇮🇹 Îtalî](belge/it/README.md)
39
- [🇯🇵 Japonî](belge/ja/README.md)
40
- [🇰🇷 Koreyî](../ko/README.md)
41
- [🇮🇳 Marathi](belge/mr/README.md)
42
- [🇵🇱 Polonî](belge/pl/README.md)
43
- [🇧🇷 Portekîzî](belge/pt/README.md)
44
- [🇷🇺 Rûsî](belge/ru/README.md)
45
- [🇰🇪 Swahili](belge/sw/README.md)
46
- [🇵🇭 Tagalog](belge/tl/README.md)
47
- [🇹🇷 Tirkî](../tr/README.md)
48
- [🇵🇰 Urdu](belge/ur/README.md)
49
- [🇻🇳 Viyetnamî](belge/vi/README.md)
50
- [🇨🇳 Çînî](belge/zh/README.md)
51
-
52
-
53
- **[📚 ... Hemû Ziman ...](belge/README.md)**
54
- ----
55
-
56
- ### Di vê wergera README de pirsgirêkek heye?
57
- Ev wergera taybetî ya orîjînal [README](https://github.com/cobbzilla/mobiletto/blob/master/README.md)
58
- 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),
59
- an heke hûn ne rehet in ku wiya bikin, [pirsek veke](https://github.com/cobbzilla/mobiletto/issues)
60
-
61
- Dema ku hûn der barê wergerekê de pirsgirêkek nû ya GitHub çêkin, ji kerema xwe bikin:
62
- * URL-ya rûpelê têxe (ji barika navnîşana gerokê kopî/pêç bike)
63
- * nivîsa tam a ku xelet e tê de (ji gerokê kopî/paste)
64
- * ji kerema xwe re şirove bike ka çi xelet e -- werger xelet e? formatkirin bi rengekî şikestî ye?
65
- * Ji kerema xwe pêşniyarek wergerek çêtir pêşkêşî bikin, an jî nivîs çawa bi rêkûpêk were şekil kirin
66
- * **Spas dikim!**
67
-
68
- ## Çima Mobiletto?
69
-
70
- ### Bi xatirê te lock-in firoşkar!
71
- 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
72
- xwedî tevgerên xwerû.
73
-
74
- 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
75
- niha girêdayî wê xizmetê ye. Her ku dem derbas dibe û kod kom dibe, guhertina firoşkaran dibe
76
- her ku diçe bêhêz dibe. Hûn bi xêr hatin cîhana kêfê ya firoşkarê kilîtkirî!
77
-
78
- Mobiletto ji bo çareserkirina vê pirsgirêkê hate çêkirin. Bi kodkirina sepana xwe li API-ya mobiletto, hûn dikarin bi hêsanî
79
- pêşkêşkerên hilanînê biguhezînin û zanibin ku qata hilanîna serîlêdana we dê bi heman rengî tevbigere.
80
-
81
- ### Testkirina berfireh
82
- Hemî ajokar ji bo her ajokerek 60+ ceribandinan ji bo behreyên yeksan têne ceribandin.
83
- Em hemî ajokaran bi her kombînasyona:
84
- * Şîfrekirin: hem çalak û hem jî neçalak
85
- * Redis cache: hem çalak û hem jî neçalak
86
-
87
- 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,
88
- û bêyî ku hûn cachkirin û/an şîfrekirinê çalak bikin.
89
-
90
- ### Piştgiriya ajokar
91
- Ajokarên hilanînê yên Mobiletto yên heyî:
92
- * `s3` : Amazon S3
93
- * `b2` : Backblaze B2
94
- * `local` : pergala pelan a herêmî
95
-
96
- *Beşdariyên ji bo piştgirîkirina bêtir pêşkêşkerên hilanîna ewr pir bi xêr hatin!*
97
-
98
- ## mobiletto-cli
99
- Mobiletto armanc e ku wekî pirtûkxane ji hêla kodên din ên JavaScript-ê ve were bikar anîn.
100
-
101
- Ji bo ku di xeta fermanê de bi mobiletto re bixebitin, [mobiletto-cli] bikar bînin (https://www.npmjs.com/package/mobiletto-cli)
102
-
103
- ## Çavkanî
104
- * [mobiletto li ser GitHub](https://github.com/cobbzilla/mobiletto)
105
- * [mobiletto li ser npm](https://www.npmjs.com/package/mobiletto)
106
-
107
- ## Piştgirî û Fînanse
108
- Ez hewl didim ku bibim pêşdebirek nermalava çavkaniya vekirî ya profesyonel. Ez tê de dixebitim
109
- pîşesaziya nermalava gelek salan, min dest bi pargîdaniyên serfiraz kir û wan firot pargîdaniyên gelemperî.
110
- Di van demên dawî de min karê xwe winda kir, û bi rastî jî tu karekî din li ber destê min nîn e
111
-
112
- Ji ber vê yekê ez ê hewl bidim ku nermalava alîkar binivîsim û bibînim ka ew kar dike
113
-
114
- Heke hûn ji karanîna vê nermalavê kêfxweş dibin, ez ê ji bo wê jî pir spasdar bim
115
- herî piçûk [beşdariya mehane bi rêya Patreon](https://www.patreon.com/cobbzilla)
116
-
117
- *Spas dikim!*
118
-
119
- ## Sazkirin
120
- Bi karanîna `npm` an jî `yarn` . Dibe ku hûn guhertoya `lite` ya ku hemîyan tê de nake dixwazin
121
- pelên README wergerandin:
122
-
123
- npm install mobiletto-lite
124
- yarn add mobiletto-lite
125
-
126
- Heke hûn bi rastî pelên README bi her zimanî dixwazin, guhertoya tevahî saz bikin:
127
-
128
- npm install mobiletto
129
- yarn add mobiletto
130
-
131
- ## Destpêka Zû
132
- Mînakek kurt a ajokera `s3` ya mobiletto bikar tîne.
133
-
134
- Heke ajoker `b2` an jî "herêmî" be ev kod dê bi heman rengî `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
- ## Bikaranîna bingehîn
165
- Mînakek pir berfirehtir, ku piraniya taybetmendiyên pêşkêşkirî destnîşan dike:
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
- ## Metadata
267
- Fermana `metadata` metadata li ser yek têketina pergala pelan vedigerîne.
268
- Bi heman awayî, nirxa vegerê ya ji fermana `list` komek ji tiştên metadata ye.
269
-
270
- Tiştek metadata wiha xuya dike:
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
- Taybetmendiya `type` dikare bibe `file` , `dir` , `link` an jî `special` .
281
-
282
- Li gorî celebê ajokerê, dibe ku `list` hemî qadan venegerîne. Taybetmendiyên `name` û `type`
283
- divê her tim hebe. Fermana `metadata` ya paşîn dê hemî taybetmendiyên berdest vegerîne.
284
-
285
- ## Şêweya importa alternatîf
286
- Modula bi tevahî-scope derxînin û fonksiyona `connect` bikar bînin:
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
- ## Caching
294
- Mobiletto bi cache <a href="https://redis.io">redis</a> çêtirîn dixebite.
295
-
296
- Mobiletto dê hewl bide ku li ser 127.0.0.1:6379 bi mînakek redis ve girêbide
297
-
298
- Hûn dikarin van yek ji wan bişopînin:
299
- * `MOBILETTO_REDIS_HOST` env var saz bike, ji bo ku li şûna hosteya herêmî li vir were girêdan
300
- * `MOBILETTO_REDIS_PORT` env var saz bike, ev port dê were bikar anîn
301
-
302
- Mobiletto dê hemî bişkojkên xwe yên redis bi pêşgira `_mobiletto__` . Hûn dikarin vê biguherînin
303
- bi `MOBILETTO_REDIS_PREFIX` env var.
304
-
305
- Her weha hûn dikarin cachkirina per-girêdanê bi `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
- ### Redis caching naxwazin?
317
- Ji bo neçalakkirinê: gava ku hûn pêwendiya xwe saz dikin, di `opts.redisConfig` de `enabled: false` " derbas bikin.
318
-
319
- Wekî ku li jêr hate nîqaş kirin, neçalakkirina caching dê bandorek neyînî li ser performansê bike û bêtir daxwaziyan bike
320
- hilanîna ku hûn bi rastî hewce ne.
321
-
322
- ### Rêbernameya caching
323
- **Depokirina şîfrekirî **: xwendin/nivîsandina hilanîna şîfrekirî tenê ji ya normal hinekî hêdîtir e,
324
- lê gera li dora pelrêçan (yên ku hin tişt dikin) pir biha ye. Bikaranîna cache redis
325
- dê performansek girîng bide we.
326
-
327
- Cache-ya xwerû ewle ye, lê heke gelek operasyonên nivîsandinê/rakirina we hebin baş naxebite.
328
- Her operasyonek nivîsandinê an jêbirinê tevahiya cache betal dike, û piştrast dike ku xwendina paşîn dê wê bibîne
329
- guhertinên dawî.
330
-
331
- ### Amûrên CLI
332
- Ger hûn amûrek CLI wekî [mobiletto-cli] bikar tînin (https://www.npmjs.com/package/mobiletto-cli),
333
- hûn ê bê guman bixwazin ku cacheya redisê were çalak kirin, ji ber ku ew di nav bangên fermana `mo` de dimîne.
334
-
335
- ## Mirroring
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
- Fermana `mirror` kopiyek yek-carî ya hemî pelan ji yek mobilettoyek din pêk tîne.
344
- Ji bo domandina neynikê bi demê re pêvajoyek nameşîne. Fermana `mirror` dîsa bixebite
345
- ji bo senkronîzekirina pelên wenda.
346
-
347
- Nirxa vegerê ya ji `mirror` tiştek sade ye bi hejmarkerên ku ji bo çend pelan bi serketî bûne
348
- mirrored û çend pelan xelet bûn:
349
-
350
- {
351
- success: count-of-files-mirrored,
352
- errors: count-of-files-with-errors
353
- }
354
-
355
- HIŞYARÎ: Neynkirina berhevokên daneya mezin dikare pir dem dixwe û firehiya bandê giran be
356
-
357
- Bi semantîka navê `mirror` re carinan dibe ku meriv têbigihêje ka kî ye
358
- xwendevan û nivîskar kî ye. Wê wekî daxuyaniyek peywirê bihesibînin: "mobîla destê çepê"
359
- tişta ku jê re tê veqetandin (daneyên neynûkî hatine nivîsandin), û "mobîla destê rastê" (ya
360
- argumana rêbaza `mirror` ) nirxa ku tê veqetandin e (daneyên neynikê têne xwendin).
361
-
362
- ## Şîfrekirina zelal
363
- Şîfrekirina şefaf ji aliyê xerîdar ve çalak bike:
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
- Çi diqewime? Pelrêkek "têketina pelrêçê" (dirent) (şîfrekirî) ya cihê ku pelên di wê de hene dişopîne
383
- pelrêça (navê pelrêça dirent).
384
- * 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
385
- * `list` in, nemaze ji bo pelrêçên ku hejmareke mezin a pelan hene
386
- * 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
387
- * `write` dê O(N) binivîse, bi N = kûrahî di hiyerarşiya pelrêçê de
388
- * Fermana `remove` a têkildar, û dêûbavê wê heke vala be, bi dûbare jê dike; paşê pelê jê dike
389
- * 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.
390
- * `remove` yên vegerî yên li ser pergalên pelan ên mezin û kûr dikarin biha bin
391
-
392
- Bala xwe bidinê ku tevî şîfrekirina ji aliyê xerîdar ve çalak be jî, dijminek bi xuyangiya tam li ser server-aliyê weya şîfrekirî
393
- 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
394
- hin hewildan, hin an hemî avahiya giştî ya hiyerarşiya pelrêça kifş bikin.
395
- * Nîşe: Ji bo ewlekariya çêtir avahiyek berbiçav bikar bînin.*
396
- Dijmin dê navên pelrêçan/pelan nizanibe heya ku ew şîfrekirina we jî nezane
397
- kilît an jî bi awayekî serketî şîfre şikandibû. Wê demê hemû behîs bi dawî ne!
398
-
399
- ### Performansa û caching
400
- Operasyonên li ser hilanîna şîfrekirî dikarin hêdî bibin. Lîsteyên veger û jêbirin dikarin pir hêdî bibin.
401
- Veşartina 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.
402
-
403
- ## Zivirîna key
404
- Bi mifteya xweya nû re mobiletto biafirînin, dûv re daneyên kevn di nav wê de neynikê bikin:
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
- ## Navbera ajokar
417
- Ajokar her pelek JS ye ku fonksiyonek 'storageClient' bi vê îmzeyê derdixe:
418
-
419
- function storageClient (key, secret, opts)
420
-
421
- * `key` : rêzek, mifteya API-ya we (ji bo ajokera `local` ev pelrêça bingehîn e)
422
- * `secret` : xêzek, sira API-ya we (dibe ku ji bo ajokera `local` were derxistin)
423
- * `opts` : tiştek, taybetmendî li ser ajokerê ne:
424
- * Ji bo `local` , taybetmendiyên `fileMode` û `dirMode` diyar dikin ka pel û peldankên nû çawa têne afirandin.
425
- * Ji bo `s3` , taybetmendiya `bucket` hewce ye. Taybetmendiyên bijartî ev in:
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
- Tişta ku fonksiyona storageClient vedigerîne divê van fonksiyonan diyar bike:
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
- ## Têketin
457
- Mobiletto pirtûkxaneya têketinê [winston](https://www.npmjs.com/package/winston) bikar tîne.
458
-
459
- Têketin ** dê ** rêyên pelan û peyamên xeletiyê hebin, lê dê ** çu carî ** mifteyên, razan nehewîne,
460
- an agahdariya veavakirina girêdanê ya din.
461
-
462
- ### Asta têketinê
463
- Guherbara jîngehê ya `MOBILETTO_LOG_LEVEL` bikar bînin da ku asta têketinê saz bikin, yek bikar bînin
464
- 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)
465
-
466
- Asta `error` . Asta herî devkî `silly` e, her çend niha mobîl e
467
- di astên li jêr `debug` de têkevê nake
468
-
469
- MOBILETTO_LOG_LEVEL=silly # maximum logs!
470
-
471
- ### Pelê têketinê
472
- Bi xwerû, logger li konsolê dinivîse. Ji bo şandina têketinên pelê, `MOBILETTO_LOG_FILE` bike
473
- guhêrbar jîngehê. Dema ku têketin pelê, têketin dê êdî li konsolê neyên nivîsandin.
474
-
475
- MOBILETTO_LOG_FILE=/var/my_mobiletto_log
476
-
477
- Ji bo qefilandina têketinê:
478
-
479
- MOBILETTO_LOG_FILE=/dev/null
480
-
481
- </pre>