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.
- 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/yo/README.md
DELETED
|
@@ -1,481 +0,0 @@
|
|
|
1
|
-
Mobiletto
|
|
2
|
-
========
|
|
3
|
-
|
|
4
|
-
Mobiletto jẹ Layer abstraction ibi ipamọ JavaScript, pẹlu iyan fifi ẹnọ kọ nkan-ẹgbẹ alabara.
|
|
5
|
-
|
|
6
|
-
# Awọn akoonu
|
|
7
|
-
* [Kí nìdí Mobiletto?](#Kí nìdí-Mobiletto?)
|
|
8
|
-
* [Ibẹrẹ kiakia](#Ibẹrẹ-kia)
|
|
9
|
-
* [Mobiletto CLI](#mobiletto-cli)
|
|
10
|
-
* [Orisun](#Orisun)
|
|
11
|
-
* [Fifi sori ẹrọ](#Fifi sori ẹrọ)
|
|
12
|
-
* [Atilẹyin ati Ifowopamọ](#Atilẹyin-ati-Ifunwo)
|
|
13
|
-
* [Lilo ipilẹ](#Ipilẹ-lilo)
|
|
14
|
-
* [Metadata](#Metadata)
|
|
15
|
-
* [Ara agbewọle agbewọle miiran](#Aṣa miiran-import-ara)
|
|
16
|
-
* [Caching](#Caching)
|
|
17
|
-
* [Mirror](#Mirror)
|
|
18
|
-
* [Ìsekóòdù ti o han gbangba](#Transparent-ìsekóòdù)
|
|
19
|
-
* [Kọtini yiyi](#Kọtini-yiyi)
|
|
20
|
-
* [Oluwakọ ni wiwo](#Oluwakọ-ni wiwo)
|
|
21
|
-
* [Wọle](#Igi wọle)
|
|
22
|
-
|
|
23
|
-
# Ka eyi ni ede miiran
|
|
24
|
-
Iwe README.md yii ti ni itumọ, nipasẹ [hokeylization](https://github.com/cobbzilla/hokeylization), sinu
|
|
25
|
-
**[gbogbo ede ni atilẹyin nipasẹ Google Tumọ](https://cloud.google.com/translate/docs/languages)!**
|
|
26
|
-
|
|
27
|
-
Mo ni idaniloju pe ko pe, ṣugbọn Mo nireti pe o dara ju ohunkohun lọ!
|
|
28
|
-
|
|
29
|
-
[🇸🇦 Larubawa](../ar/README.md)
|
|
30
|
-
[🇧🇩 Ede Bengali](../bn/README.md)
|
|
31
|
-
[🇩🇪 Jẹmánì](../de/README.md)
|
|
32
|
-
[🇺🇸 English](../en/README.md)
|
|
33
|
-
[🇪🇸 Spani](../es/README.md)
|
|
34
|
-
[🇫🇷 Faranse](../fr/README.md)
|
|
35
|
-
[🇹🇩 Hausa](../ha/README.md)
|
|
36
|
-
[🇮🇳 Hindi](../hi/README.md)
|
|
37
|
-
[🇮🇩 Indonesian](../id/README.md)
|
|
38
|
-
[🇮🇹 Itali](../it/README.md)
|
|
39
|
-
[🇯🇵 Japanese](../ja/README.md)
|
|
40
|
-
[🇰🇷 Korean](../ko/README.md)
|
|
41
|
-
[🇮🇳 Marathi](../mr/README.md)
|
|
42
|
-
[🇵🇱 Polish](../pl/README.md)
|
|
43
|
-
[🇧🇷 Portuguese](../pt/README.md)
|
|
44
|
-
[🇷🇺 Russian](../ru/README.md)
|
|
45
|
-
[🇰🇪 Swahili](../sw/README.md)
|
|
46
|
-
[🇵🇭 Tagalog](../tl/README.md)
|
|
47
|
-
[🇹🇷 Tọki](../tr/README.md)
|
|
48
|
-
[🇵🇰 Urdu](../ur/README.md)
|
|
49
|
-
[🇻🇳 Vietnamese](../vi/README.md)
|
|
50
|
-
[🇨🇳 Kannada](../zh/README.md)
|
|
51
|
-
|
|
52
|
-
|
|
53
|
-
**[📚 ... Gbogbo Ede ...](../README.md)**
|
|
54
|
-
----
|
|
55
|
-
|
|
56
|
-
### Njẹ iṣoro kan wa pẹlu itumọ README yii?
|
|
57
|
-
Itumọ ni pato ti atilẹba [README](https://github.com/cobbzilla/mobiletto/blob/master/README.md)
|
|
58
|
-
le jẹ abawọn - * awọn atunṣe ṣe itẹwọgba pupọ!* Jọwọ fi ibeere kan ranṣẹ si GitHub (https://github.com/cobbzilla/mobiletto/pulls),
|
|
59
|
-
tabi ti o ko ba ni itunu lati ṣe iyẹn, [ṣii ọrọ kan](https://github.com/cobbzilla/mobiletto/issues)
|
|
60
|
-
|
|
61
|
-
Nigbati o ba ṣẹda ọrọ GitHub tuntun nipa itumọ kan, jọwọ ṣe:
|
|
62
|
-
* pẹlu URL oju-iwe naa (daakọ/lẹẹmọ lati ọpa adirẹsi aṣawakiri)
|
|
63
|
-
* pẹlu ọrọ gangan ti o jẹ aṣiṣe (daakọ/lẹẹmọ lati ẹrọ aṣawakiri)
|
|
64
|
-
* Jọwọ ṣapejuwe ohun ti ko tọ -- ṣe itumọ naa ko tọ? ti wa ni awọn kika baje bakan?
|
|
65
|
-
* Fi inurere funni ni imọran itumọ ti o dara julọ, tabi bi o ṣe yẹ ki ọrọ naa ṣe tito daradara
|
|
66
|
-
* **E dupe!**
|
|
67
|
-
|
|
68
|
-
## Kí nìdí Mobiletto?
|
|
69
|
-
|
|
70
|
-
### Titiipa olutaja o dabọ!
|
|
71
|
-
Awọn oriṣiriṣi awọn olupese ibi ipamọ awọsanma ni awọn API ti ko ni ibamu. Paapaa awọn ti o tiraka fun “ibamu S3”
|
|
72
|
-
ni awọn iwa idiosyncratic.
|
|
73
|
-
|
|
74
|
-
Nigbati o ba yan olutaja ibi ipamọ kan pato fun app rẹ, ti o ba koodu taara si API wọn, app rẹ
|
|
75
|
-
ni bayi ti o gbẹkẹle iṣẹ yẹn. Bi akoko ti n lọ ati pe koodu kojọpọ, awọn olutaja iyipada di
|
|
76
|
-
increasingly untenable. Kaabọ si agbaye igbadun ti titiipa ataja!
|
|
77
|
-
|
|
78
|
-
Mobiletto jẹ apẹrẹ lati yanju iṣoro yii. Nipa ifaminsi app rẹ si API mobiletto, o le ni irọrun
|
|
79
|
-
yi awọn olupese ibi ipamọ pada ki o mọ pe Layer ibi ipamọ ohun elo rẹ yoo huwa bakanna.
|
|
80
|
-
|
|
81
|
-
### Ayẹwo nla
|
|
82
|
-
Gbogbo awọn awakọ ni idanwo fun ihuwasi kanna pẹlu awọn idanwo 60+ fun awakọ kọọkan.
|
|
83
|
-
A ṣe idanwo gbogbo awakọ pẹlu gbogbo akojọpọ:
|
|
84
|
-
* Ìsekóòdù: mejeeji ṣiṣẹ ati alaabo
|
|
85
|
-
* Kaṣe Redis: mejeeji ṣiṣẹ ati alaabo
|
|
86
|
-
|
|
87
|
-
Ọna yii fun wa ni alaafia-ọkan pe mobiletto yoo huwa kanna laibikita iru awakọ ti o lo,
|
|
88
|
-
ati laibikita boya o jeki caching ati/tabi ìsekóòdù.
|
|
89
|
-
|
|
90
|
-
### Awakọ support
|
|
91
|
-
Awọn awakọ ibi ipamọ Mobiletto lọwọlọwọ:
|
|
92
|
-
* `s3` : Amazon S3
|
|
93
|
-
* `b2` : Backblaze B2
|
|
94
|
-
* `local` : eto faili agbegbe
|
|
95
|
-
|
|
96
|
-
* Awọn ifunni lati ṣe atilẹyin awọn olupese ibi ipamọ awọsanma diẹ sii jẹ itẹwọgba!
|
|
97
|
-
|
|
98
|
-
## mobiletto-cli
|
|
99
|
-
Mobiletto ti pinnu lati ṣee lo bi ile-ikawe nipasẹ koodu JavaScript miiran.
|
|
100
|
-
|
|
101
|
-
Lati ṣiṣẹ pẹlu mobiletto ni laini aṣẹ, lo [mobiletto-cli](https://www.npmjs.com/package/mobiletto-cli)
|
|
102
|
-
|
|
103
|
-
## Orisun
|
|
104
|
-
* [mobiletto lori GitHub](https://github.com/cobbzilla/mobiletto)
|
|
105
|
-
* [mobiletto lori npm](https://www.npmjs.com/package/mobiletto)
|
|
106
|
-
|
|
107
|
-
## Atilẹyin ati igbeowosile
|
|
108
|
-
Mo ngbiyanju lati jẹ oludasilẹ sọfitiwia orisun ṣiṣi ọjọgbọn. Mo ti ṣiṣẹ ninu
|
|
109
|
-
ile-iṣẹ sọfitiwia fun ọpọlọpọ ọdun, Mo ti bẹrẹ awọn ile-iṣẹ aṣeyọri ati ta wọn si awọn ile-iṣẹ gbangba.
|
|
110
|
-
Laipẹ Mo padanu iṣẹ mi, ati pe Emi ko ni iṣẹ miiran ti o laini gaan
|
|
111
|
-
|
|
112
|
-
Nitorinaa Emi yoo gbiyanju kikọ sọfitiwia iranlọwọ ati rii boya iyẹn ṣiṣẹ
|
|
113
|
-
|
|
114
|
-
Ti o ba gbadun lilo sọfitiwia yii, Emi yoo dupe pupọ fun paapaa awọn
|
|
115
|
-
ti o kere julọ [ilowosi oṣooṣu nipasẹ Patreon](https://www.patreon.com/cobbzilla)
|
|
116
|
-
|
|
117
|
-
*E dupe!*
|
|
118
|
-
|
|
119
|
-
## Fifi sori ẹrọ
|
|
120
|
-
Fi sori ẹrọ ni lilo `npm` tabi `yarn` . O ṣee ṣe ki o fẹ ẹya `lite` ti ko pẹlu gbogbo wọn
|
|
121
|
-
Awọn faili README ti a tumọ:
|
|
122
|
-
|
|
123
|
-
npm install mobiletto-lite
|
|
124
|
-
yarn add mobiletto-lite
|
|
125
|
-
|
|
126
|
-
Ti o ba fẹ gaan awọn faili README ni gbogbo ede, fi ẹya kikun sii:
|
|
127
|
-
|
|
128
|
-
npm install mobiletto
|
|
129
|
-
yarn add mobiletto
|
|
130
|
-
|
|
131
|
-
## Ibẹrẹ kiakia
|
|
132
|
-
Apeere kukuru nipa lilo awakọ mobiletto `s3` .
|
|
133
|
-
|
|
134
|
-
Koodu yii yoo ṣiṣẹ kanna ti awakọ ba jẹ `b2` tabi `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
|
-
## Ipilẹ lilo
|
|
165
|
-
Apeere lọpọlọpọ diẹ sii, ti n ṣafihan pupọ julọ awọn ẹya ti a funni:
|
|
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
|
-
Aṣẹ `metadata` da metadata pada nipa titẹ sii eto faili kan ṣoṣo.
|
|
268
|
-
Bakanna, iye ipadabọ lati pipaṣẹ `list` jẹ akojọpọ awọn nkan metadata.
|
|
269
|
-
|
|
270
|
-
Ohun metadata dabi eleyi:
|
|
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
|
-
Ohun-ini `type` le jẹ `file` , `dir` , `link` , tabi `special` .
|
|
281
|
-
|
|
282
|
-
Da lori iru awakọ, pipaṣẹ `list` le ma da gbogbo awọn aaye pada. Awọn ohun-ini `name` orukọ' ati `type`
|
|
283
|
-
yẹ ki o wa nigbagbogbo. Aṣẹ `metadata` ti o tẹle yoo da gbogbo awọn ohun-ini to wa pada.
|
|
284
|
-
|
|
285
|
-
## Aṣa agbewọle miiran
|
|
286
|
-
Ṣe agbewọle module ti o ni iwọn ni kikun ki o lo iṣẹ `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
|
-
## Caching
|
|
294
|
-
Mobiletto ṣiṣẹ dara julọ pẹlu kaṣe <a href="https://redis.io">redis</a> .
|
|
295
|
-
|
|
296
|
-
Mobiletto yoo gbiyanju lati sopọ si a redis apeere on 127.0.0.1:6379
|
|
297
|
-
|
|
298
|
-
O le fagilee ọkan ninu awọn wọnyi:
|
|
299
|
-
* Ṣeto `MOBILETTO_REDIS_HOST` env var, mobiletto so nibi dipo localhost
|
|
300
|
-
* Ṣeto `MOBILETTO_REDIS_PORT` env var, ibudo yii yoo ṣee lo
|
|
301
|
-
|
|
302
|
-
Mobiletto yoo fi gbogbo awọn bọtini redis pamọ pẹlu ìpele `_mobiletto__` . O le yi eyi pada
|
|
303
|
-
nipa `MOBILETTO_REDIS_PREFIX` env var.
|
|
304
|
-
|
|
305
|
-
O tun le ṣeto caching fun-asopọ pẹlu ohun `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
|
-
### Ṣe o ko fẹ caching redis?
|
|
317
|
-
Lati mu: kọja `enabled: false` ninu ohun `opts.redisConfig` rẹ nigbati o ba fi idi asopọ rẹ mulẹ.
|
|
318
|
-
|
|
319
|
-
Gẹgẹbi a ti jiroro ni isalẹ, piparẹ caching yoo ni ipa ti ko dara lori iṣẹ ṣiṣe ati fa awọn ibeere diẹ sii
|
|
320
|
-
si ibi ipamọ ti o nilo gaan.
|
|
321
|
-
|
|
322
|
-
### Caching itoni
|
|
323
|
-
** Ibi ipamọ ti paroko ***: kika / kikọ ibi ipamọ fifi ẹnọ kọ nkan jẹ o lọra diẹ ju deede,
|
|
324
|
-
ṣugbọn lilọ kiri ni ayika awọn ilana (eyiti diẹ ninu awọn nkan ṣe) jẹ gbowolori gaan. Lilo kaṣe redis
|
|
325
|
-
yoo fun ọ ni ilọsiwaju iṣẹ ṣiṣe pataki.
|
|
326
|
-
|
|
327
|
-
Kaṣe aiyipada jẹ ailewu, ṣugbọn ko ṣiṣẹ daradara ti o ba ni ọpọlọpọ kikọ / yọ awọn iṣẹ kuro.
|
|
328
|
-
Eyikeyi iṣẹ kikọ tabi yọkuro sọ gbogbo kaṣe di asan, ni idaniloju awọn kika ti o tẹle yoo rii
|
|
329
|
-
titun ayipada.
|
|
330
|
-
|
|
331
|
-
### CLI irinṣẹ
|
|
332
|
-
Ti o ba n lo ohun elo CLI bii [mobiletto-cli](https://www.npmjs.com/package/mobiletto-cli),
|
|
333
|
-
dajudaju iwọ yoo fẹ ki kaṣe redis ṣiṣẹ, bi o ti wa kọja awọn ẹbẹ ti pipaṣẹ `mo` .
|
|
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
|
-
Aṣẹ `mirror` n ṣe ẹda ẹyọkan ti gbogbo awọn faili lati alagbeka si miiran.
|
|
344
|
-
Ko ṣe ilana eyikeyi lati ṣetọju digi ni akoko pupọ. Ṣiṣe aṣẹ `mirror` lẹẹkansi
|
|
345
|
-
lati muuṣiṣẹpọ eyikeyi awọn faili ti o padanu.
|
|
346
|
-
|
|
347
|
-
Iye ipadabọ lati `mirror` jẹ ohun ti o rọrun pẹlu awọn iṣiro fun iye awọn faili ti o ṣaṣeyọri
|
|
348
|
-
digi ati melo ni awọn faili ti ni awọn aṣiṣe:
|
|
349
|
-
|
|
350
|
-
{
|
|
351
|
-
success: count-of-files-mirrored,
|
|
352
|
-
errors: count-of-files-with-errors
|
|
353
|
-
}
|
|
354
|
-
|
|
355
|
-
IKILO: Digiri awọn eto data nla le jẹ akoko-n gba ati bandiwidi-lekoko
|
|
356
|
-
|
|
357
|
-
Pẹlu awọn `mirror` o le jẹ airoju nigbakan lati ni oye tani
|
|
358
|
-
oluka ati tani onkqwe. Fojuinu rẹ bi alaye iyansilẹ: “mobiletto ọwọ osi”
|
|
359
|
-
jẹ ohun ti a yàn si (awọn data digi ti a kọ), ati "mobiletto ọwọ ọtun" (awọn
|
|
360
|
-
ariyanjiyan si ọna `mirror` ) ni iye ti a yàn (awọn data digi ti wa ni kika).
|
|
361
|
-
|
|
362
|
-
## Sihin ìsekóòdù
|
|
363
|
-
Mu fifi ẹnọ kọ nkan si ẹgbẹ onibara ṣiṣẹ:
|
|
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
|
-
Kilo n ṣẹlẹ? Itọkasi "titẹsi iwe-ilana" (itọkasi) itọsọna (ti paroko) tọpinpin kini awọn faili wa ninu iyẹn
|
|
383
|
-
liana (aka awọn dirent liana).
|
|
384
|
-
* Aṣẹ `list` ka awọn faili titẹ sii liana, decrypts kọọkan ọna ti a ṣe akojọ; lẹhinna da metadata pada fun faili kọọkan
|
|
385
|
-
* Awọn pipaṣẹ `list` diẹ sii, pataki fun awọn ilana pẹlu nọmba nla ti awọn faili
|
|
386
|
-
* Aṣẹ `write` kọ awọn faili ti o taara sinu itọsọna taara ti obi kọọkan, leralera; lẹhinna kọ faili naa
|
|
387
|
-
Awọn aṣẹ `write` yoo fa O(N) kọ, pẹlu N = ijinle ninu awọn ilana ilana
|
|
388
|
-
* Aṣẹ `remove` yọ faili dirant ti o baamu kuro, ati obi rẹ ti o ba ṣofo, leralera; lẹhinna yọ faili naa kuro
|
|
389
|
-
* Awọn aṣẹ `remove` ṣe loorekoore yoo fa kika O(N) ati agbara bi ọpọlọpọ paarẹ, pẹlu N = ijinle ninu awọn ilana ilana
|
|
390
|
-
* Awọn pipaṣẹ `remove` lori awọn ọna ṣiṣe faili nla ati jin le jẹ gbowolori
|
|
391
|
-
|
|
392
|
-
Ṣe akiyesi pe paapaa pẹlu fifi ẹnọ kọ nkan-ẹgbẹ alabara ṣiṣẹ, ọta kan pẹlu hihan ni kikun si ẹgbẹ olupin ti paroko rẹ
|
|
393
|
-
ibi ipamọ, paapaa laisi bọtini, tun le rii nọmba lapapọ ti awọn ilana ati iye awọn faili ti o wa ninu ọkọọkan, ati pẹlu
|
|
394
|
-
diẹ ninu awọn akitiyan , iwari diẹ ninu awọn tabi gbogbo awọn ti awọn ìwò be ti awọn logalomomoise liana.
|
|
395
|
-
* Akiyesi: Lo eto alapin kan fun aabo to dara julọ.
|
|
396
|
-
Ọta naa ko ni mọ awọn orukọ ti awọn ilana/faili ayafi ti wọn tun mọ fifi ẹnọ kọ nkan rẹ
|
|
397
|
-
bọtini tabi bibẹẹkọ ti ṣaṣeyọri sisan fifi ẹnọ kọ nkan naa. Gbogbo awọn tẹtẹ wa ni pipa lẹhinna!
|
|
398
|
-
|
|
399
|
-
### Performance ati caching
|
|
400
|
-
Awọn iṣẹ lori ibi ipamọ ti paroko le lọra. Awọn atokọ atunṣe ati awọn yiyọ kuro le lọra pupọ.
|
|
401
|
-
Caching nipasẹ redis ṣe iranlọwọ lọpọlọpọ, ṣugbọn ṣe akiyesi pe kaṣe naa ti fọ lori eyikeyi kikọ tabi yọkuro.
|
|
402
|
-
|
|
403
|
-
## Yiyi bọtini
|
|
404
|
-
Ṣẹda mobiletto pẹlu bọtini titun rẹ, lẹhinna digi data atijọ sinu rẹ:
|
|
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
|
-
## Iwakọ ni wiwo
|
|
417
|
-
Awakọ jẹ eyikeyi faili JS ti o ṣe okeere iṣẹ 'ipamọClient' pẹlu ibuwọlu yii:
|
|
418
|
-
|
|
419
|
-
function storageClient (key, secret, opts)
|
|
420
|
-
|
|
421
|
-
* `key` : okun kan, bọtini API rẹ (fun awakọ `local` eyi ni itọsọna ipilẹ)
|
|
422
|
-
* `secret` : okun kan, aṣiri API rẹ (le jẹ yọkuro fun awakọ `local` )
|
|
423
|
-
* `opts` : ohun kan, awọn ohun-ini jẹ fun awakọ kan:
|
|
424
|
-
* Fun `local` , awọn `fileMode` ati `dirMode` ini pinnu bi ṣiṣẹda titun awọn faili ati awọn ilana ti wa ni da
|
|
425
|
-
* Fun `s3` , ohun-ini `bucket` ni a nilo. Awọn ohun-ini iyan jẹ:
|
|
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
|
-
Nkan ti ibi ipamọ iṣẹ Onibara pada gbọdọ ṣalaye awọn iṣẹ wọnyi:
|
|
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
|
-
## Wọle
|
|
457
|
-
Mobiletto nlo [winston](https://www.npmjs.com/package/winston) ile-ikawe gedu.
|
|
458
|
-
|
|
459
|
-
Awọn akọọlẹ ** yoo ni awọn ọna faili ati awọn ifiranṣẹ aṣiṣe, ṣugbọn kii yoo ni awọn bọtini, awọn aṣiri,
|
|
460
|
-
tabi eyikeyi alaye iṣeto ni asopọ miiran.
|
|
461
|
-
|
|
462
|
-
### Ipele Wọle
|
|
463
|
-
Lo iyipada ayika `MOBILETTO_LOG_LEVEL` lati ṣeto ipele akọọlẹ, ni lilo ọkan
|
|
464
|
-
ti awọn ipele `npm` ti ṣalaye ni [https://www.npmjs.com/package/winston#logging-levels](https://www.npmjs.com/package/winston#logging-levels)
|
|
465
|
-
|
|
466
|
-
Ipele aiyipada jẹ `error` . Awọn julọ verbose ipele ni `silly` , biotilejepe Lọwọlọwọ mobiletto
|
|
467
|
-
ko wọle ni awọn ipele ni isalẹ `debug`
|
|
468
|
-
|
|
469
|
-
MOBILETTO_LOG_LEVEL=silly # maximum logs!
|
|
470
|
-
|
|
471
|
-
### Faili wọle
|
|
472
|
-
Nipa aiyipada, logger kọwe si console. Lati fi awọn akọọlẹ ranṣẹ si faili kan, ṣeto `MOBILETTO_LOG_FILE`
|
|
473
|
-
oniyipada ayika. Nigbati o ba wọle si faili kan, awọn akọọlẹ kii yoo kọ si console mọ.
|
|
474
|
-
|
|
475
|
-
MOBILETTO_LOG_FILE=/var/my_mobiletto_log
|
|
476
|
-
|
|
477
|
-
Lati pa gedu:
|
|
478
|
-
|
|
479
|
-
MOBILETTO_LOG_FILE=/dev/null
|
|
480
|
-
|
|
481
|
-
</pre>
|