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.
- package/lib/cjs/index.d.ts +2 -0
- package/lib/cjs/index.js +30 -0
- package/lib/cjs/package.json +16 -0
- package/lib/esm/index.d.ts +2 -0
- package/lib/esm/index.js +12 -0
- package/package.json +27 -13
- package/.babelrc +0 -5
- package/.eslintrc.js +0 -14
- package/docs/README.md +0 -113
- package/docs/af/README.md +0 -481
- package/docs/am/README.md +0 -481
- package/docs/ar/README.md +0 -481
- package/docs/az/README.md +0 -481
- package/docs/be/README.md +0 -481
- package/docs/bg/README.md +0 -481
- package/docs/bn/README.md +0 -481
- package/docs/bs/README.md +0 -481
- package/docs/ca/README.md +0 -481
- package/docs/ceb/README.md +0 -481
- package/docs/co/README.md +0 -481
- package/docs/cs/README.md +0 -481
- package/docs/cy/README.md +0 -481
- package/docs/da/README.md +0 -481
- package/docs/de/README.md +0 -481
- package/docs/el/README.md +0 -481
- package/docs/eo/README.md +0 -481
- package/docs/es/README.md +0 -481
- package/docs/et/README.md +0 -481
- package/docs/eu/README.md +0 -481
- package/docs/fa/README.md +0 -481
- package/docs/fi/README.md +0 -481
- package/docs/fr/README.md +0 -481
- package/docs/fy/README.md +0 -481
- package/docs/ga/README.md +0 -481
- package/docs/gd/README.md +0 -481
- package/docs/gl/README.md +0 -481
- package/docs/gu/README.md +0 -481
- package/docs/ha/README.md +0 -481
- package/docs/haw/README.md +0 -481
- package/docs/he/README.md +0 -481
- package/docs/hi/README.md +0 -481
- package/docs/hmn/README.md +0 -481
- package/docs/hr/README.md +0 -481
- package/docs/ht/README.md +0 -481
- package/docs/hu/README.md +0 -481
- package/docs/hy/README.md +0 -481
- package/docs/id/README.md +0 -481
- package/docs/ig/README.md +0 -481
- package/docs/is/README.md +0 -481
- package/docs/it/README.md +0 -481
- package/docs/iw/README.md +0 -481
- package/docs/ja/README.md +0 -481
- package/docs/jv/README.md +0 -481
- package/docs/ka/README.md +0 -481
- package/docs/kk/README.md +0 -481
- package/docs/km/README.md +0 -481
- package/docs/kn/README.md +0 -481
- package/docs/ko/README.md +0 -481
- package/docs/ku/README.md +0 -481
- package/docs/ky/README.md +0 -481
- package/docs/la/README.md +0 -481
- package/docs/lb/README.md +0 -481
- package/docs/lo/README.md +0 -481
- package/docs/lt/README.md +0 -481
- package/docs/lv/README.md +0 -481
- package/docs/mg/README.md +0 -481
- package/docs/mi/README.md +0 -481
- package/docs/mk/README.md +0 -481
- package/docs/ml/README.md +0 -481
- package/docs/mn/README.md +0 -481
- package/docs/mr/README.md +0 -481
- package/docs/ms/README.md +0 -481
- package/docs/mt/README.md +0 -481
- package/docs/my/README.md +0 -481
- package/docs/ne/README.md +0 -481
- package/docs/nl/README.md +0 -481
- package/docs/no/README.md +0 -481
- package/docs/ny/README.md +0 -481
- package/docs/or/README.md +0 -481
- package/docs/pa/README.md +0 -481
- package/docs/pl/README.md +0 -481
- package/docs/ps/README.md +0 -481
- package/docs/pt/README.md +0 -481
- package/docs/ro/README.md +0 -481
- package/docs/ru/README.md +0 -481
- package/docs/rw/README.md +0 -481
- package/docs/sd/README.md +0 -481
- package/docs/si/README.md +0 -481
- package/docs/sk/README.md +0 -481
- package/docs/sl/README.md +0 -481
- package/docs/sm/README.md +0 -481
- package/docs/sn/README.md +0 -481
- package/docs/so/README.md +0 -481
- package/docs/sq/README.md +0 -481
- package/docs/sr/README.md +0 -481
- package/docs/st/README.md +0 -481
- package/docs/su/README.md +0 -481
- package/docs/sv/README.md +0 -481
- package/docs/sw/README.md +0 -481
- package/docs/ta/README.md +0 -481
- package/docs/te/README.md +0 -481
- package/docs/tg/README.md +0 -481
- package/docs/th/README.md +0 -481
- package/docs/tk/README.md +0 -481
- package/docs/tl/README.md +0 -481
- package/docs/tr/README.md +0 -481
- package/docs/tt/README.md +0 -481
- package/docs/ug/README.md +0 -481
- package/docs/uk/README.md +0 -481
- package/docs/ur/README.md +0 -481
- package/docs/uz/README.md +0 -481
- package/docs/vi/README.md +0 -481
- package/docs/xh/README.md +0 -481
- package/docs/yi/README.md +0 -481
- package/docs/yo/README.md +0 -481
- package/docs/zh/README.md +0 -481
- package/docs/zu/README.md +0 -481
- package/drivers/b2/index.js +0 -451
- package/drivers/local/index.js +0 -315
- package/drivers/s3/index.js +0 -316
- package/hokey.json +0 -16
- package/index.js +0 -29
- package/test/api.spec.js +0 -512
- package/test/crypt.spec.js +0 -67
package/docs/tt/README.md
DELETED
|
@@ -1,481 +0,0 @@
|
|
|
1
|
-
Мобильтто
|
|
2
|
-
=========
|
|
3
|
-
|
|
4
|
-
Mobiletto - JavaScript саклагыч абстракция катламы, клиент ягыннан өстәмә ачык шифрлау.
|
|
5
|
-
|
|
6
|
-
# Эчтәлек
|
|
7
|
-
* [Нигә Мобилтто?](# Нигә-Мобилтто?)
|
|
8
|
-
* [Тиз башлау](# Тиз башлау)
|
|
9
|
-
* [Mobiletto CLI](# mobiletto-клиент)
|
|
10
|
-
* [Чыганак](# Чыганак)
|
|
11
|
-
* [Урнаштыру](# урнаштыру)
|
|
12
|
-
* [Ярдәм һәм финанслау](# Ярдәм-финанслау)
|
|
13
|
-
* [Төп куллану](# Төп куллану)
|
|
14
|
-
* [Мета мәгълүматлар](# Мета мәгълүматлар)
|
|
15
|
-
* [Альтернатив импорт стиле](# Альтернатив-импорт-стиль)
|
|
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
|
-
[🇸🇦 Гарәпчә](docs / ar / README.md)
|
|
30
|
-
[🇧🇩 Бенгали](docs / bn / README.md)
|
|
31
|
-
[🇩🇪 Алманча](docs / de / README.md)
|
|
32
|
-
[🇺🇸 Инглизчә](docs / en / README.md)
|
|
33
|
-
[🇪🇸 Испанча](docs / es / README.md)
|
|
34
|
-
[🇫🇷 Французча](docs / fr / README.md)
|
|
35
|
-
[🇹🇩 Хауса](докс / га / README.md)
|
|
36
|
-
[🇮🇳 Hindiинди](docs / hi / README.md)
|
|
37
|
-
[🇮🇩 Индонезия](docs / id / README.md)
|
|
38
|
-
[🇮🇹 Италия](docs / it / README.md)
|
|
39
|
-
[🇯🇵 Япон](docs / ja / README.md)
|
|
40
|
-
[🇰🇷 Корея](docs / ko / README.md)
|
|
41
|
-
[🇮🇳 Маранти](docs / mr / README.md)
|
|
42
|
-
[🇵🇱 Поляк](docs / pl / README.md)
|
|
43
|
-
[🇧🇷 Португалча](docs / pt / README.md)
|
|
44
|
-
[🇷🇺 русча](docs / ru / README.md)
|
|
45
|
-
[🇰🇪 Суахили](docs / sw / README.md)
|
|
46
|
-
[🇵🇭 Тагалог](docs / tl / README.md)
|
|
47
|
-
[🇹🇷 Төрекчә](docs / tr / README.md)
|
|
48
|
-
[🇵🇰 Урду](docs / ur / README.md)
|
|
49
|
-
[🇻🇳 Вьетнам](docs / vi / README.md)
|
|
50
|
-
[🇨🇳 Кытай](docs / zh / README.md)
|
|
51
|
-
|
|
52
|
-
|
|
53
|
-
** [📚 ... Барлык телләр ...](docs / 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
|
-
## Нигә Мобилтто?
|
|
69
|
-
|
|
70
|
-
### Сау бул, сатучы йозак!
|
|
71
|
-
Төрле болыт саклаучыларның туры килмәгән API-лары бар. "S3 яраклашуы" өчен омтылганнар да
|
|
72
|
-
идиосинкратик тәртипкә ия.
|
|
73
|
-
|
|
74
|
-
Сезнең кушымтагыз өчен билгеле саклаучы сатучы сайлаганда, турыдан-туры аларның API, кушымтагызга код бирсәгез
|
|
75
|
-
хәзер бу хезмәткә бәйле. Вакыт узу белән код туплангач, сатучылар үзгәрә
|
|
76
|
-
көннән-көн тотрыксыз. Сатучыларның кызыклы дөньясына рәхим итегез!
|
|
77
|
-
|
|
78
|
-
Mobiletto бу проблеманы чишү өчен эшләнгән. Кушымтагызны мобильто API-ка кодлап, сез җиңел генә эшли аласыз
|
|
79
|
-
саклагычларны үзгәртегез һәм сезнең кушымтаның саклагыч катламы бертөрле эш итәчәген белегез.
|
|
80
|
-
|
|
81
|
-
### Зур тест
|
|
82
|
-
Барлык драйверлар да бер йөртүче өчен 60+ тест белән бер үк тәртип өчен сынала.
|
|
83
|
-
Без барлык драйверларны һәр комбинация белән сынап карыйбыз:
|
|
84
|
-
* Шифрлау: кушылган да, инвалид та
|
|
85
|
-
* Redis кэш: кушылган да, инвалид та
|
|
86
|
-
|
|
87
|
-
Бу ысул безгә тынычлык бирә, мобилтто нинди драйвер куллансаң да үзен шулай тотар,
|
|
88
|
-
һәм сез кэшлау һәм / яки шифрлау мөмкинлеген бирәсез.
|
|
89
|
-
|
|
90
|
-
### Шофер ярдәме
|
|
91
|
-
Хәзерге Mobiletto саклагычлары:
|
|
92
|
-
* `s3` : Amazon S3
|
|
93
|
-
* `b2` : В2
|
|
94
|
-
* `local` җирле": җирле файл системасы
|
|
95
|
-
|
|
96
|
-
* Болыт саклаучыларга ярдәм итү өчен кертемнәр бик рәхимле! *
|
|
97
|
-
|
|
98
|
-
## mobiletto-клиент
|
|
99
|
-
Mobiletto бүтән JavaScript коды белән китапханә буларак кулланылырга тиеш.
|
|
100
|
-
|
|
101
|
-
Мобильтто белән боерык сызыгында эшләү өчен, [mobiletto-cli] кулланыгыз (https://www.npmjs.com/package/mobiletto-cli)
|
|
102
|
-
|
|
103
|
-
## Чыганак
|
|
104
|
-
* [GitHub'та мобильто](https://github.com/cobbzilla/mobiletto)
|
|
105
|
-
* [төнге мобильто](https://www.npmjs.com/package/mobiletto)
|
|
106
|
-
|
|
107
|
-
## Ярдәм һәм финанслау
|
|
108
|
-
Мин профессиональ ачык чыганак программа тәэминаты булырга тырышам. Мин эшлим
|
|
109
|
-
озак еллар программа тәэминаты индустриясе, мин уңышлы компанияләр башладым һәм аларны җәмәгать компанияләренә саттым.
|
|
110
|
-
Күптән түгел мин эшемне югалттым, һәм минем бүтән тезелешем юк
|
|
111
|
-
|
|
112
|
-
Шуңа күрә мин файдалы программа язарга тырышам һәм моның эшләвен тикшерәм
|
|
113
|
-
|
|
114
|
-
Әгәр дә сез бу программаны кулланырга яратсагыз, мин хәтта бик рәхмәтле булыр идем
|
|
115
|
-
иң кечкенә [Патрон аша айлык өлеш](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
|
-
`s3` "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` " милеге "файл", `dir` `file` , " `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
|
-
Мобилтто <a href="https://redis.io">редис</a> кэш белән иң яхшы эшли.
|
|
295
|
-
|
|
296
|
-
Mobiletto 127.0.0.1:6379 телефоны буенча редис инстанциясенә тоташырга тырышачак
|
|
297
|
-
|
|
298
|
-
Сез аларның икесен дә кире кагарга мөмкин:
|
|
299
|
-
* " `MOBILETTO_REDIS_HOST` env var, мобильто монда локальхост урынына тоташу
|
|
300
|
-
* " `MOBILETTO_REDIS_PORT` " env вариантын куегыз, бу порт кулланылачак
|
|
301
|
-
|
|
302
|
-
Mobiletto барлык редис ачкычларын " `_mobiletto__` " префиксы белән саклаячак. Сез моны үзгәртә аласыз
|
|
303
|
-
" `MOBILETTO_REDIS_PREFIX` env вариантын куеп.
|
|
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: false` " тапшырыгыз.
|
|
318
|
-
|
|
319
|
-
Түбәндә каралганча, кэшны сүндерү эшкә тискәре йогынты ясар һәм күбрәк сорау бирер
|
|
320
|
-
чыннан да кирәк булган саклауга.
|
|
321
|
-
|
|
322
|
-
### Кэш белән идарә итү
|
|
323
|
-
** Шифрланган саклагыч **: шифрланган саклауны уку / язу гадәтигә караганда әкренрәк,
|
|
324
|
-
ләкин каталоглар буенча йөрү (кайбер әйберләр эшли) шактый кыйммәт. Редис кэш куллану
|
|
325
|
-
сизелерлек эшне арттырачак.
|
|
326
|
-
|
|
327
|
-
Килешү кэш куркынычсыз, ләкин язу / бетерү операцияләре күп булса, яхшы эшләми.
|
|
328
|
-
Теләсә нинди язу яки бетерү операциясе бөтен кэшны юкка чыгара, алдагы укуларны күрәчәк
|
|
329
|
-
соңгы үзгәрешләр.
|
|
330
|
-
|
|
331
|
-
### CLI кораллары
|
|
332
|
-
Әгәр дә сез [mobiletto-cli](https://www.npmjs.com/package/mobiletto-cli) кебек CLI коралын кулланасыз икән,
|
|
333
|
-
сез, һичшиксез, редис кэшының эшләвен теләрсез, чөнки ул " `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` " боерыгы бер мобильтодан икенчесенә барлык файлларның бер тапкыр күчерелмәсен башкара.
|
|
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
|
-
укучы һәм язучы кем. Аны бирем сүзләре кебек күз алдыгызга китерегез: "сул кул мобильто"
|
|
359
|
-
билгеләнгән әйбер (көзге мәгълүматлар язылган), һәм "уң кул мобильто" (
|
|
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
|
-
каталог (дирент каталог).
|
|
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
|
-
Редис аша кэш бик зур ярдәм итә, ләкин игътибар итегез, кэш теләсә нинди язуларга яисә бетерелгәннәргә.
|
|
402
|
-
|
|
403
|
-
## Ачкыч әйләнү
|
|
404
|
-
Яңа ачкыч белән мобильто ясагыз, аннары иске мәгълүматны чагылдырыгыз:
|
|
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
|
-
Драйвер - бу имза белән 'storageClient' функциясен экспортлаучы JS файл.
|
|
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
|
-
Саклау клиенты функциясе кире кайткан объект бу функцияләрне билгеләргә тиеш:
|
|
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
|
-
Мобилто [winston](https://www.npmjs.com/package/winston) теркәлү китапханәсен куллана.
|
|
458
|
-
|
|
459
|
-
Бүрәнәләр ** файл юлларын һәм хата хәбәрләрен үз эченә ала, ләкин ** беркайчан да ачкычлар, серләр булмаячак,
|
|
460
|
-
яки бүтән тоташу конфигурациясе турында мәгълүмат.
|
|
461
|
-
|
|
462
|
-
### Бүрәнә дәрәҗәсе
|
|
463
|
-
" `MOBILETTO_LOG_LEVEL` " мохит үзгәрүчесен кулланыгыз, бүрәнә дәрәҗәсен билгеләү өчен
|
|
464
|
-
[https://www.npmjs.com/package/winston#logging-levels)(https://www.npmjs.com/package/winston#logging-levels) белән билгеләнгән " `npm` " дәрәҗәләре.
|
|
465
|
-
|
|
466
|
-
Килешенгән дәрәҗә - " `error` . Иң фигыль дәрәҗәсе - " `silly` , хәзерге вакытта мобильто
|
|
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>
|