mobiletto 1.1.9 → 1.1.12
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/README.md +82 -4
- package/docs/README.md +113 -0
- package/docs/af/README.md +481 -0
- package/docs/am/README.md +481 -0
- package/docs/ar/README.md +481 -0
- package/docs/az/README.md +481 -0
- package/docs/be/README.md +481 -0
- package/docs/bg/README.md +481 -0
- package/docs/bn/README.md +481 -0
- package/docs/bs/README.md +481 -0
- package/docs/ca/README.md +481 -0
- package/docs/ceb/README.md +481 -0
- package/docs/co/README.md +481 -0
- package/docs/cs/README.md +481 -0
- package/docs/cy/README.md +481 -0
- package/docs/da/README.md +481 -0
- package/docs/de/README.md +481 -0
- package/docs/el/README.md +481 -0
- package/docs/eo/README.md +481 -0
- package/docs/es/README.md +481 -0
- package/docs/et/README.md +481 -0
- package/docs/eu/README.md +481 -0
- package/docs/fa/README.md +481 -0
- package/docs/fi/README.md +481 -0
- package/docs/fr/README.md +481 -0
- package/docs/fy/README.md +481 -0
- package/docs/ga/README.md +481 -0
- package/docs/gd/README.md +481 -0
- package/docs/gl/README.md +481 -0
- package/docs/gu/README.md +481 -0
- package/docs/ha/README.md +481 -0
- package/docs/haw/README.md +481 -0
- package/docs/he/README.md +481 -0
- package/docs/hi/README.md +481 -0
- package/docs/hmn/README.md +481 -0
- package/docs/hr/README.md +481 -0
- package/docs/ht/README.md +481 -0
- package/docs/hu/README.md +481 -0
- package/docs/hy/README.md +481 -0
- package/docs/id/README.md +481 -0
- package/docs/ig/README.md +481 -0
- package/docs/is/README.md +481 -0
- package/docs/it/README.md +481 -0
- package/docs/iw/README.md +481 -0
- package/docs/ja/README.md +481 -0
- package/docs/jv/README.md +481 -0
- package/docs/ka/README.md +481 -0
- package/docs/kk/README.md +481 -0
- package/docs/km/README.md +481 -0
- package/docs/kn/README.md +481 -0
- package/docs/ko/README.md +481 -0
- package/docs/ku/README.md +481 -0
- package/docs/ky/README.md +481 -0
- package/docs/la/README.md +481 -0
- package/docs/lb/README.md +481 -0
- package/docs/lo/README.md +481 -0
- package/docs/lt/README.md +481 -0
- package/docs/lv/README.md +481 -0
- package/docs/mg/README.md +481 -0
- package/docs/mi/README.md +481 -0
- package/docs/mk/README.md +481 -0
- package/docs/ml/README.md +481 -0
- package/docs/mn/README.md +481 -0
- package/docs/mr/README.md +481 -0
- package/docs/ms/README.md +481 -0
- package/docs/mt/README.md +481 -0
- package/docs/my/README.md +481 -0
- package/docs/ne/README.md +481 -0
- package/docs/nl/README.md +481 -0
- package/docs/no/README.md +481 -0
- package/docs/ny/README.md +481 -0
- package/docs/or/README.md +481 -0
- package/docs/pa/README.md +481 -0
- package/docs/pl/README.md +481 -0
- package/docs/ps/README.md +481 -0
- package/docs/pt/README.md +481 -0
- package/docs/ro/README.md +481 -0
- package/docs/ru/README.md +481 -0
- package/docs/rw/README.md +481 -0
- package/docs/sd/README.md +481 -0
- package/docs/si/README.md +481 -0
- package/docs/sk/README.md +481 -0
- package/docs/sl/README.md +481 -0
- package/docs/sm/README.md +481 -0
- package/docs/sn/README.md +481 -0
- package/docs/so/README.md +481 -0
- package/docs/sq/README.md +481 -0
- package/docs/sr/README.md +481 -0
- package/docs/st/README.md +481 -0
- package/docs/su/README.md +481 -0
- package/docs/sv/README.md +481 -0
- package/docs/sw/README.md +481 -0
- package/docs/ta/README.md +481 -0
- package/docs/te/README.md +481 -0
- package/docs/tg/README.md +481 -0
- package/docs/th/README.md +481 -0
- package/docs/tk/README.md +481 -0
- package/docs/tl/README.md +481 -0
- package/docs/tr/README.md +481 -0
- package/docs/tt/README.md +481 -0
- package/docs/ug/README.md +481 -0
- package/docs/uk/README.md +481 -0
- package/docs/ur/README.md +481 -0
- package/docs/uz/README.md +481 -0
- package/docs/vi/README.md +481 -0
- package/docs/xh/README.md +481 -0
- package/docs/yi/README.md +481 -0
- package/docs/yo/README.md +481 -0
- package/docs/zh/README.md +481 -0
- package/docs/zu/README.md +481 -0
- package/drivers/b2/index.js +24 -6
- package/hokey.json +16 -0
- package/index.js +32 -16
- package/package.json +3 -2
- package/test/api.spec.js +319 -306
- package/util/logger.js +1 -1
- package/util/redis.js +1 -1
|
@@ -0,0 +1,481 @@
|
|
|
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
|
+
* [वैकल्पिक आयात शैली](#वैकल्पिक-आयात-शैली)
|
|
16
|
+
* [क्यासिङ](#क्यासिङ)
|
|
17
|
+
* [मिररिङ](#मिररिङ)
|
|
18
|
+
* [पारदर्शी एन्क्रिप्शन](#पारदर्शी-इन्क्रिप्शन)
|
|
19
|
+
* [कुञ्जी घुमाउने](#कुञ्जी-रोटेशन)
|
|
20
|
+
* [ड्राइभर इन्टरफेस](#ड्राइभर-इन्टरफेस)
|
|
21
|
+
* [लगिङ](#लगिङ)
|
|
22
|
+
|
|
23
|
+
# यो अर्को भाषामा पढ्नुहोस्
|
|
24
|
+
यो README.md कागजात [hokeylization](https://github.com/cobbzilla/hokeylization) मार्फत अनुवाद गरिएको छ, मा
|
|
25
|
+
**[Google अनुवादद्वारा समर्थित हरेक भाषा](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
|
+
[🇹🇩 हौसा](../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
|
+
[🇵🇭 Tagalog](../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 यो समस्या समाधान गर्न डिजाइन गरिएको थियो। Mobiletto को API मा आफ्नो एप कोडिङ गरेर, तपाईं सजिलै गर्न सक्नुहुन्छ
|
|
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
|
+
* [GitHub मा mobiletto](https://github.com/cobbzilla/mobiletto)
|
|
105
|
+
* [mobiletto on 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 127.0.0.1:6379 मा एक redis उदाहरण जडान गर्न प्रयास गर्नेछ।
|
|
297
|
+
|
|
298
|
+
तपाईं यी मध्ये कुनै एक ओभरराइड गर्न सक्नुहुन्छ:
|
|
299
|
+
* `MOBILETTO_REDIS_HOST` env var सेट गर्नुहोस्, mobiletto यहाँ लोकलहोस्टको सट्टा जडान गर्नुहोस्
|
|
300
|
+
* `MOBILETTO_REDIS_PORT` env var सेट गर्नुहोस्, यो पोर्ट प्रयोग हुनेछ
|
|
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: 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
|
+
तपाइँ निश्चित रूपमा 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` आदेशले एक मोबाइलबाट अर्कोमा सबै फाइलहरूको एक पटकको प्रतिलिपि कार्य गर्दछ।
|
|
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
|
+
(मिरर गरिएको डाटा लेखिएको), र "दायाँ हात मोबाइलटो" (द
|
|
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` आदेशहरूले डाइरेक्टरी पदानुक्रममा N = गहिराइको साथ O(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
|
+
ड्राइभर कुनै पनि JS फाइल हो जसले यो हस्ताक्षरको साथ 'storageClient' प्रकार्य निर्यात गर्दछ:
|
|
418
|
+
|
|
419
|
+
function storageClient (key, secret, opts)
|
|
420
|
+
|
|
421
|
+
* `key` : एउटा स्ट्रिङ, तपाईको API कुञ्जी ( `local` ड्राइभरका लागि यो आधार निर्देशिका हो)
|
|
422
|
+
* `secret` : एउटा स्ट्रिङ, तपाईको एपीआई गोप्य ( `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
|
+
Mobiletto [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` हो। सबैभन्दा verbose स्तर `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>
|