mobiletto 1.2.1 → 2.0.1

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/tg/README.md DELETED
@@ -1,481 +0,0 @@
1
- Mobiletto
2
- =========
3
-
4
- Mobiletto як қабати абстраксияи нигаҳдории JavaScript мебошад, ки бо рамзгузории ихтиёрии шаффофи муштарӣ.
5
-
6
- # Мундариҷа
7
- * [Чаро Mobiletto?](#Why-Mobiletto?)
8
- * [Оғози зуд](#Оғози зуд)
9
- * [Mobiletto CLI](#mobiletto-cli)
10
- * [Манбаъ](#Манбаъ)
11
- * [Насб](#Насб)
12
- * [Дастгирӣ ва маблағгузорӣ](#Дастгирӣ ва маблағгузорӣ)
13
- * [Истифодаи асосӣ](#Истифодаи асосӣ)
14
- * [Метамаълумот](#Метамаълумот)
15
- * [Услуби воридоти алтернативӣ](#Alternate-import-style)
16
- * [Кэшкунӣ](#Кэшкунӣ)
17
- * [Оинакунӣ](#Оинакунӣ)
18
- * [Рамзгузории шаффоф](#Шаффоф-рамзгузорӣ)
19
- * [Ратсияи калид](#Калиди гардиш)
20
- * [Интерфейси ронанда](#Драйвер-интерфейс)
21
- * [Рӯйхатгирӣ](#Ҷорҷӯӣ)
22
-
23
- # Инро ба забони дигар хонед
24
- Ин ҳуҷҷати README.md тавассути [hokeylization](https://github.com/cobbzilla/hokeylization) ба забони тарҷума шудааст
25
- **[ҳар забоне, ки аз ҷониби Google Translate дастгирӣ мешавад](https://cloud.google.com/translate/docs/languages)!**
26
-
27
- Ман итминон дорам, ки ин комил нест, аммо ман умедворам, ки он аз ҳеҷ чиз беҳтар аст!
28
-
29
- [🇸🇦 Арабӣ](../ar/README.md)
30
- [🇧🇩 Бенгалӣ](../bn/README.md)
31
- [🇩🇪 Олмон](../de/README.md)
32
- [🇺🇸 англисӣ](../en/README.md)
33
- [🇪🇸 испанӣ](../es/README.md)
34
- [🇫🇷 Фаронса](../fr/README.md)
35
- [🇹🇩 Hausa](../ha/README.md)
36
- [🇮🇳 Ҳиндӣ](../hi/README.md)
37
- [🇮🇩 Индонезия](../id/README.md)
38
- [🇮🇹 Италия](../it/README.md)
39
- [🇯🇵 Ҷопон](../ja/README.md)
40
- [🇰🇷 Кореяи](../ko/README.md)
41
- [🇮🇳 Марантӣ](../mr/README.md)
42
- [🇵🇱 Лаҳистон](../pl/README.md)
43
- [🇧🇷 португалӣ](../pt/README.md)
44
- [🇷🇺 русӣ](../ru/README.md)
45
- [🇰🇪 Суахили](../sw/README.md)
46
- [🇵🇭 Тагалогӣ](../tl/README.md)
47
- [🇹🇷 Туркӣ](../tr/README.md)
48
- [🇵🇰 урду](../ur/README.md)
49
- [🇻🇳 Ветнамӣ](../vi/README.md)
50
- [🇨🇳 Чин](../zh/README.md)
51
-
52
-
53
- **[📚 ... Ҳама забонҳо ...](../README.md)**
54
- ----
55
-
56
- ### Оё бо ин тарҷумаи README мушкилот вуҷуд дорад?
57
- Ин тарҷумаи махсуси аслии [README](https://github.com/cobbzilla/mobiletto/blob/master/README.md)
58
- метавонад хато бошад -- *ислоҳот хеле хуш омадед!* Лутфан [дархости кашидан дар GitHub](https://github.com/cobbzilla/mobiletto/pulls) фиристед.
59
- ё агар шумо ин корро бароҳат надоред, [як масъаларо кушоед](https://github.com/cobbzilla/mobiletto/issues)
60
-
61
- Вақте ки шумо дар бораи тарҷума масъалаи нави GitHub эҷод мекунед, лутфан амал кунед:
62
- * URL-и саҳифаро дохил кунед (аз сатри суроғаҳои браузер нусхабардорӣ/часбонед)
63
- * матни дақиқи нодурустро дохил кунед (аз браузер нусхабардорӣ/часбонед)
64
- * лутфан шарҳ диҳед, ки чӣ хато аст -- тарҷума нодуруст аст? оё форматкунӣ ягон хел вайрон шудааст?
65
- * лутфан пешниҳод кунед, ки тарҷумаи беҳтар ё чӣ гуна матн бояд дуруст формат карда шавад
66
- * **Сипос!**
67
-
68
- ## Чаро Mobiletto?
69
-
70
- ### Хайр, фурӯшанда баста!
71
- Провайдерҳои гуногуни нигаҳдории абр API-ҳои номувофиқ доранд. Ҳатто онҳое, ки барои "мутобиқати S3" мекӯшанд
72
- рафтору кирдори хоса доранд.
73
-
74
- Вақте ки шумо як фурӯшандаи махсуси нигаҳдории барномаро интихоб мекунед, агар шумо бевосита ба API-и онҳо рамзгузорӣ кунед, барномаи шумо
75
- ҳоло ба он хидмат вобаста аст. Вақте ки вақт мегузарад ва код ҷамъ мешавад, фурӯшандагон иваз мешаванд
76
- беш аз пеш нотавон аст. Хуш омадед ба ҷаҳони фароғатии бастабандии фурӯшанда!
77
-
78
- Mobiletto барои ҳалли ин мушкилот тарҳрезӣ шудааст. Бо рамзгузории барномаи худ ба API-и mobiletto, шумо метавонед ба осонӣ
79
- провайдерҳои анборро иваз кунед ва бидонед, ки қабати нигаҳдории барномаи шумо якхела рафтор хоҳад кард.
80
-
81
- ### Санҷиши васеъ
82
- Ҳама ронандагон барои рафтори якхела бо 60+ санҷиш барои ҳар як ронанда санҷида мешаванд.
83
- Мо ҳамаи ронандагонро бо ҳар як комбинатсияи:
84
- * Рамзгузорӣ: ҳам фаъол ва ҳам ғайрифаъол
85
- * Кэши Redis: ҳам фаъол ва ҳам ғайрифаъол
86
-
87
- Ин равиш ба мо оромиро медиҳад, ки mobiletto новобаста аз он ки шумо кадом ронандаро истифода мебаред, ҳамон рафтор хоҳад кард.
88
- ва новобаста аз он ки шумо кэш ва/ё рамзгузориро фаъол мекунед.
89
-
90
- ### Дастгирии ронанда
91
- Драйверҳои ҷории нигаҳдории Mobiletto:
92
- * `s3` : Amazon S3
93
- * `b2` : Барқарор B2
94
- * `local` : системаи файлии маҳаллӣ
95
-
96
- *Ҳиссагузориҳо барои дастгирии провайдерҳои нигаҳдории абрӣ хеле хуш омадед!*
97
-
98
- ## mobiletto-cli
99
- Mobiletto пешбинӣ шудааст, ки ҳамчун китобхона бо дигар кодҳои JavaScript истифода шавад.
100
-
101
- Барои кор бо mobiletto дар сатри фармон, истифода баред [mobiletto-cli](https://www.npmjs.com/package/mobiletto-cli)
102
-
103
- ## Сарчашма
104
- * [mobiletto дар GitHub](https://github.com/cobbzilla/mobiletto)
105
- * [mobiletto дар npm](https://www.npmjs.com/package/mobiletto)
106
-
107
- ## Дастгирӣ ва маблағгузорӣ
108
- Ман кӯшиш мекунам, ки як таҳиягари нармафзори кушодаасос бошам. Ман кор мекардам
109
- саноати нармафзор дар тӯли солҳои зиёд, ман ширкатҳои муваффақро оғоз кардам ва онҳоро ба ширкатҳои давлатӣ фурӯхтам.
110
- Ба наздикӣ ман корамро аз даст додам ва аслан кори дигаре надорам
111
-
112
- Аз ин рӯ, ман кӯшиш мекунам, ки нармафзори муфид нависам ва бубинам, ки оё ин кор мекунад
113
-
114
- Агар шумо аз истифодаи ин нармафзор лаззат мебаред, ман барои ҳатто хеле миннатдор хоҳам буд
115
- хурдтарин [саҳми ҳармоҳа тавассути Patreon](https://www.patreon.com/cobbzilla)
116
-
117
- *Сипос!*
118
-
119
- ## Насбкунӣ
120
- Бо истифода аз `npm` " ё `yarn` . Эҳтимол шумо мехоҳед версияи `lite` , ки ҳама чизро дар бар намегирад
121
- файлҳои README тарҷумашуда:
122
-
123
- npm install mobiletto-lite
124
- yarn add mobiletto-lite
125
-
126
- Агар шумо дар ҳақиқат хоҳед, ки файлҳои README бо ҳар забон, версияи пурраи онро насб кунед:
127
-
128
- npm install mobiletto
129
- yarn add mobiletto
130
-
131
- ## Оғози зуд
132
- Намунаи кӯтоҳ бо истифода аз драйвери mobiletto `s3` .
133
-
134
- Агар драйвер `b2` ё `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
- ## Истифодаи асосӣ
165
- Мисоли хеле васеътар, ки аксари хусусиятҳои пешниҳодшударо нишон медиҳад:
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
- ## Метамаълумот
267
- Фармони `metadata` метамаълумотро дар бораи як вуруди системаи файлӣ бармегардонад.
268
- Ба ҳамин монанд, арзиши баргардонидани фармони `list` массиви объектҳои метамаълумот аст.
269
-
270
- Объекти метамаълумот чунин менамояд:
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` метавонад `file` ", `dir` ", `link` ё `special` .
281
-
282
- Вобаста аз намуди драйвер, фармони `list` метавонад на ҳама майдонҳоро баргардонад. Хусусиятҳои `name` ва `type`
283
- бояд ҳамеша ҳузур дошта бошад. Фармони минбаъдаи `metadata` ҳамаи хосиятҳои дастрасро бармегардонад.
284
-
285
- ## Услуби алтернативии воридот
286
- Модули мукаммалро ворид кунед ва функсияи `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
- ## Кэш
294
- Mobiletto бо кэши <a href="https://redis.io">redis</a> беҳтарин кор мекунад.
295
-
296
- Mobiletto кӯшиш мекунад, ки ба як нусхаи redis дар 127.0.0.1:6379 пайваст шавад
297
-
298
- Шумо метавонед яке аз инҳоро бекор кунед:
299
- * Env var `MOBILETTO_REDIS_HOST` -ро насб кунед, барои пайваст шудан ба ин ҷо ба ҷои localhost
300
- * Env var `MOBILETTO_REDIS_PORT` -ро танзим кунед, ин порт истифода мешавад
301
-
302
- Mobiletto ҳамаи калидҳои redis-и худро бо префикси `_mobiletto__` . Шумо метавонед инро тағир диҳед
303
- бо гузоштани `MOBILETTO_REDIS_PREFIX` env var.
304
-
305
- Шумо инчунин метавонед кэшкунии ҳар як пайвастшавиро бо объекти `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
- ### Оё кэшкунии дубораро намехоҳед?
317
- Барои хомӯш кардан: ҳангоми барқарор кардани пайвастшавӣ дар объекти `opts.redisConfig` -и худ 'enabled `enabled: false` ' -ро гузаронед.
318
-
319
- Тавре ки дар зер баррасӣ шуд, ғайрифаъол кардани кэш ба кор таъсири манфӣ мерасонад ва дархостҳои бештарро ба бор меорад
320
- ба нигоҳдорӣ, ки ба шумо воқеан лозим аст.
321
-
322
- ### Роҳнамои кэш
323
- **Захираи рамзгузоришуда**: хондан/навиштани нигаҳдории рамзгузоришуда аз муқаррарӣ каме сусттар аст,
324
- аммо паймоиш дар атрофи директорияҳо (ки баъзе чизҳо мекунанд) хеле гарон аст. Истифодаи кэши redis
325
- ба шумо афзоиши назарраси иҷроиш медиҳад.
326
-
327
- Кэши пешфарз бехатар аст, аммо агар шумо амалиёти зиёди навиштан/нест кардан дошта бошед, хуб кор намекунад.
328
- Ҳама гуна амалиёти навиштан ё хориҷ кардан тамоми кэшро беэътибор мегардонад ва мутмаин аст, ки хонданҳои минбаъда
329
- тағйироти охирин.
330
-
331
- ### Воситаҳои CLI
332
- Агар шумо асбоби CLI-ро истифода баред, ба монанди [mobiletto-cli](https://www.npmjs.com/package/mobiletto-cli),
333
- шумо бешубҳа хоҳед, ки кэши redis фаъол карда шавад, зеро он дар тамоми даъватҳои фармони `mo` давом мекунад.
334
-
335
- ## Зеркашӣ
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
- Фармони `mirror` нусхаи якдафъаинаи ҳамаи файлҳоро аз як mobiletto ба дигараш иҷро мекунад.
344
- Он ягон равандро барои нигоҳ доштани оина бо мурури замон иҷро намекунад. Фармони `mirror` дубора иҷро кунед
345
- барои ҳамоҳангсозии ҳама файлҳои гумшуда.
346
-
347
- Қимати баргардонидани `mirror` як объекти оддӣ бо ҳисобкунакҳо барои бомуваффақият будани чанд файл мебошад
348
- оинашуда ва чанд файл хатогӣ дошт:
349
-
350
- {
351
- success: count-of-files-mirrored,
352
- errors: count-of-files-with-errors
353
- }
354
-
355
- ОГОҲ: Зеркашӣ кардани маҷмӯаҳои бузурги додаҳо метавонад хеле вақт ва фарохмаҷро талаб кунад
356
-
357
- Бо семантикаи занги `mirror` баъзан фаҳмидани кист, метавонад печида бошад
358
- хонанда ва нависанда кист. Онро ҳамчун як изҳороти супориш тасаввур кунед: "mobiletto дасти чап"
359
- он чизест, ки ба он таъин карда мешавад (маълумоти оинашуда навишта шудааст) ва "mobiletto-дасти рост" (
360
- аргумент ба усули `mirror` ) арзиши таъиншуда аст (маълумоти оина хонда мешавад).
361
-
362
- ## Рамзгузории шаффоф
363
- Рамзгузории шаффофи муштариро фаъол созед:
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
- Чӣ мегузарад? Феҳристи алоҳидаи "дохили феҳрист" (дирентӣ) (рамзгузорӣ) пайгирӣ мекунад, ки дар он кадом файлҳо мавҷуданд
383
- директория (ака директорияи dirent).
384
- * Фармони `list` файлҳои вуруди феҳристҳоро мехонад, ҳар як роҳи рӯйхатшударо рамзкушо мекунад; баъд метамаълумотро барои ҳар як файл бармегардонад
385
- * Фармонҳои `list` , махсусан барои директорияҳои дорои шумораи зиёди файлҳо
386
- * Фармони `write` ҳар як волидайн ба таври рекурсивӣ менависад; баъд файлро менависад
387
- * Фармонҳои `write` O(N) -ро дар бар мегиранд, бо N = амиқ дар иерархияи директория
388
- * Фармони `remove` файли мувофиқро нест мекунад ва волидайни онро агар холӣ бошад, ба таври рекурсивӣ нест мекунад; баъд файлро нест мекунад
389
- * Фармонҳои `remove` O(N) ва эҳтимолан ҳамон қадар ҳазф мешаванд, бо N = амиқ дар иерархияи директория
390
- * Фармонҳои `remove` дар системаҳои файлии калон ва амиқ метавонанд гарон бошанд
391
-
392
- Дар хотир доред, ки ҳатто ҳангоми фаъол кардани рамзгузории муштарӣ, рақиб бо дидани пурраи сервери рамзгузоришудаи шумо
393
- нигоҳдорӣ, ҳатто бе калид, то ҳол метавонад шумораи умумии директорияҳо ва чанд файл дар ҳар як ва бо дидани
394
- баъзе кӯшишҳо, кашф баъзе ё ҳамаи сохтори умумии иерархияи директория.
395
- *Эзоҳ: Барои бехатарии беҳтар сохтори нисбатан ҳамворро истифода баред.*
396
- Рақиб номи директорияҳо/файлҳоро намедонад, агар онҳо рамзгузории шуморо низ надонанд
397
- калид ё ба таври дигар рамзкунониро бомуваффақият шикаста буд. Пас ҳама шартгузориҳо хомӯш мешаванд!
398
-
399
- ### Иҷро ва кэш
400
- Амалиёт дар нигаҳдории рамзгузорӣ метавонад суст бошад. Рӯйхатҳои рекурсивӣ ва хориҷкунӣ метавонанд хеле суст бошанд.
401
- Кэшкунӣ тавассути redis хеле кӯмак мекунад, аммо қайд кунед, ки кэш ҳангоми навиштан ё нест кардан тоза карда мешавад.
402
-
403
- ## Гардиши калид
404
- Бо калиди нави худ як mobiletto эҷод кунед ва маълумоти кӯҳнаро дар он инъикос кунед:
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
- ## Интерфейси ронанда
417
- Драйвер ҳама гуна файли JS мебошад, ки функсияи 'storageClient'-ро бо ин имзо содир мекунад:
418
-
419
- function storageClient (key, secret, opts)
420
-
421
- * `key` : сатр, калиди API-и шумо (барои драйвери `local` ин феҳристи асосӣ аст)
422
- * `secret` : сатр, сирри API-и шумо (метавонад барои драйвери `local` сарфи назар карда шавад)
423
- * `opts` : объект, хосиятҳо барои як драйвер мебошанд:
424
- * Барои `local` " хосиятҳои `fileMode` " ва `dirMode` муайян мекунанд, ки чӣ гуна файлҳо ва директорияҳои нав эҷод карда мешаванд
425
- * Барои `s3` , хосияти `bucket` лозим аст. Хусусиятҳои ихтиёрӣ инҳоянд:
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
- Объекте, ки функсияи storageClient бармегардонад, бояд ин вазифаҳоро муайян кунад:
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
- ## Сабзавот
457
- Mobiletto китобхонаи сабти [winston](https://www.npmjs.com/package/winston) -ро истифода мебарад.
458
-
459
- Гузоришҳо ** дорои роҳҳои файл ва паёмҳои хатогӣ мебошанд, аммо ** ҳеҷ гоҳ ** калидҳо, асрорҳо,
460
- ё ягон маълумоти дигари конфигуратсияи пайвастшавӣ.
461
-
462
- ### Сатҳи сабт
463
- Барои танзим кардани сатҳи гузориш бо истифода аз як тағирёбандаи муҳити `MOBILETTO_LOG_LEVEL` -ро истифода баред
464
- сатҳҳои `npm` дар [https://www.npmjs.com/package/winston#logging-levels](https://www.npmjs.com/package/winston#logging-levels) муайян карда шудаанд.
465
-
466
- Сатҳи пешфарз `error` аст. Сатҳи аз ҳама муфассалтар `silly` аст, гарчанде ки дар айни замон mobiletto
467
- дар сатҳҳои поёнии `debug`
468
-
469
- MOBILETTO_LOG_LEVEL=silly # maximum logs!
470
-
471
- ### Файли сабт
472
- Бо нобаёнӣ, сабткунанда ба консол менависад. Барои фиристодани гузоришҳо ба файл, `MOBILETTO_LOG_FILE` -ро танзим кунед
473
- тағйирёбандаи муҳити зист. Ҳангоми ворид шудан ба файл, гузоришҳо дигар ба консол навишта намешаванд.
474
-
475
- MOBILETTO_LOG_FILE=/var/my_mobiletto_log
476
-
477
- Барои хомӯш кардани сабт:
478
-
479
- MOBILETTO_LOG_FILE=/dev/null
480
-
481
- </pre>