mobiletto 1.1.10 → 1.1.11

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 (116) hide show
  1. package/README.md +48 -0
  2. package/docs/README.md +113 -0
  3. package/docs/af/README.md +455 -0
  4. package/docs/am/README.md +455 -0
  5. package/docs/ar/README.md +455 -0
  6. package/docs/az/README.md +455 -0
  7. package/docs/be/README.md +455 -0
  8. package/docs/bg/README.md +455 -0
  9. package/docs/bn/README.md +455 -0
  10. package/docs/bs/README.md +455 -0
  11. package/docs/ca/README.md +455 -0
  12. package/docs/ceb/README.md +455 -0
  13. package/docs/co/README.md +455 -0
  14. package/docs/cs/README.md +455 -0
  15. package/docs/cy/README.md +455 -0
  16. package/docs/da/README.md +455 -0
  17. package/docs/de/README.md +455 -0
  18. package/docs/el/README.md +455 -0
  19. package/docs/eo/README.md +455 -0
  20. package/docs/es/README.md +455 -0
  21. package/docs/et/README.md +455 -0
  22. package/docs/eu/README.md +455 -0
  23. package/docs/fa/README.md +455 -0
  24. package/docs/fi/README.md +455 -0
  25. package/docs/fr/README.md +455 -0
  26. package/docs/fy/README.md +455 -0
  27. package/docs/ga/README.md +455 -0
  28. package/docs/gd/README.md +455 -0
  29. package/docs/gl/README.md +455 -0
  30. package/docs/gu/README.md +455 -0
  31. package/docs/ha/README.md +455 -0
  32. package/docs/haw/README.md +455 -0
  33. package/docs/he/README.md +455 -0
  34. package/docs/hi/README.md +455 -0
  35. package/docs/hmn/README.md +455 -0
  36. package/docs/hr/README.md +455 -0
  37. package/docs/ht/README.md +455 -0
  38. package/docs/hu/README.md +455 -0
  39. package/docs/hy/README.md +455 -0
  40. package/docs/id/README.md +455 -0
  41. package/docs/ig/README.md +455 -0
  42. package/docs/is/README.md +455 -0
  43. package/docs/it/README.md +455 -0
  44. package/docs/iw/README.md +455 -0
  45. package/docs/ja/README.md +455 -0
  46. package/docs/jv/README.md +455 -0
  47. package/docs/ka/README.md +455 -0
  48. package/docs/kk/README.md +455 -0
  49. package/docs/km/README.md +455 -0
  50. package/docs/kn/README.md +455 -0
  51. package/docs/ko/README.md +455 -0
  52. package/docs/ku/README.md +455 -0
  53. package/docs/ky/README.md +455 -0
  54. package/docs/la/README.md +455 -0
  55. package/docs/lb/README.md +455 -0
  56. package/docs/lo/README.md +455 -0
  57. package/docs/lt/README.md +455 -0
  58. package/docs/lv/README.md +455 -0
  59. package/docs/mg/README.md +455 -0
  60. package/docs/mi/README.md +455 -0
  61. package/docs/mk/README.md +455 -0
  62. package/docs/ml/README.md +455 -0
  63. package/docs/mn/README.md +455 -0
  64. package/docs/mr/README.md +455 -0
  65. package/docs/ms/README.md +455 -0
  66. package/docs/mt/README.md +455 -0
  67. package/docs/my/README.md +455 -0
  68. package/docs/ne/README.md +455 -0
  69. package/docs/nl/README.md +455 -0
  70. package/docs/no/README.md +455 -0
  71. package/docs/ny/README.md +455 -0
  72. package/docs/or/README.md +455 -0
  73. package/docs/pa/README.md +455 -0
  74. package/docs/pl/README.md +455 -0
  75. package/docs/ps/README.md +455 -0
  76. package/docs/pt/README.md +455 -0
  77. package/docs/ro/README.md +455 -0
  78. package/docs/ru/README.md +455 -0
  79. package/docs/rw/README.md +455 -0
  80. package/docs/sd/README.md +455 -0
  81. package/docs/si/README.md +455 -0
  82. package/docs/sk/README.md +455 -0
  83. package/docs/sl/README.md +455 -0
  84. package/docs/sm/README.md +455 -0
  85. package/docs/sn/README.md +455 -0
  86. package/docs/so/README.md +455 -0
  87. package/docs/sq/README.md +455 -0
  88. package/docs/sr/README.md +455 -0
  89. package/docs/st/README.md +455 -0
  90. package/docs/su/README.md +455 -0
  91. package/docs/sv/README.md +455 -0
  92. package/docs/sw/README.md +455 -0
  93. package/docs/ta/README.md +455 -0
  94. package/docs/te/README.md +455 -0
  95. package/docs/tg/README.md +455 -0
  96. package/docs/th/README.md +455 -0
  97. package/docs/tk/README.md +455 -0
  98. package/docs/tl/README.md +455 -0
  99. package/docs/tr/README.md +455 -0
  100. package/docs/tt/README.md +455 -0
  101. package/docs/ug/README.md +455 -0
  102. package/docs/uk/README.md +455 -0
  103. package/docs/ur/README.md +455 -0
  104. package/docs/uz/README.md +455 -0
  105. package/docs/vi/README.md +455 -0
  106. package/docs/xh/README.md +455 -0
  107. package/docs/yi/README.md +455 -0
  108. package/docs/yo/README.md +455 -0
  109. package/docs/zh/README.md +455 -0
  110. package/docs/zu/README.md +455 -0
  111. package/drivers/b2/index.js +24 -6
  112. package/hokey.json +16 -0
  113. package/index.js +7 -2
  114. package/package.json +1 -1
  115. package/test/api.spec.js +12 -9
  116. package/util/redis.js +1 -1
@@ -0,0 +1,455 @@
1
+ Mobiletto
2
+ =========
3
+
4
+ Mobiletto איז אַ דזשאַוואַסקריפּט סטאָרידזש אַבסטראַקשאַן שיכטע, מיט אַפּשאַנאַל טראַנספּעראַנט קליענט-זייַט ענקריפּשאַן.
5
+
6
+ # אינהאַלט
7
+ * [פארוואס מאָבילעטטאָ?](#פארוואס-מאָבילעטטאָ?)
8
+ * [שנעל אָנהייב](#קוויק אָנהייב)
9
+ * [מאָבילעטטאָ CLI](#מאָבילעטטאָ-קלי)
10
+ * [מקור](#מקור)
11
+ * [באַסיק באַניץ](#באַסיק באַניץ)
12
+ * [מעטאַדאַטאַ](# מעטאַדאַטאַ)
13
+ * [אָלטערנאַטיוו אַרייַנפיר נוסח](#אָלטערנאַטיוו-ימפּאָרט-נוסח)
14
+ * [קאַטשינג](# קאַטשינג)
15
+ * [שפּיגל](# מירראָרינג)
16
+ * [טראַנספּאַרענט ענקריפּשאַן](#טראַנספּאַרענט ענקריפּשאַן)
17
+ * [שליסל ראָוטיישאַן](# שליסל ראָוטיישאַן)
18
+ * [דרייווער צובינד](# דרייווער צובינד)
19
+ * [לאָגינג](#לאָגינג)
20
+
21
+ # לייענען דעם אין אן אנדער שפּראַך
22
+ דעם README.md דאָקומענט איז איבערגעזעצט, דורך [hokeylization](https://github.com/cobbzilla/hokeylization), אין
23
+ **[יעדער שפּראַך געשטיצט דורך Google Translate](https://cloud.google.com/translate/docs/languages)!**
24
+
25
+ איך בין זיכער אַז עס איז נישט גאנץ, אָבער איך האָפֿן עס איז בעסער ווי גאָרנישט!
26
+
27
+ [🇸🇦 אַראַביש](../ar/README.md)
28
+ [🇧🇩 בענגאַליש](../bn/README.md)
29
+ [🇩🇪 דייַטש](../de/README.md)
30
+ [🇺🇸 ענגליש](../en/README.md)
31
+ [🇪🇸 שפּאַניש](../es/README.md)
32
+ [🇫🇷 פראנצויזיש](../fr/README.md)
33
+ [🇹🇩 Hausa](../ha/README.md)
34
+ [🇮🇳 הינדיש](../hi/README.md)
35
+ [🇮🇩 אינדאָנעזיש](../id/README.md)
36
+ [🇮🇹 איטאַליעניש](../it/README.md)
37
+ [🇯🇵 יאַפּאַניש](../ja/README.md)
38
+ [🇰🇷 קאָרעיִש](../ko/README.md)
39
+ [🇮🇳 Maranthi](../mr/README.md)
40
+ [🇵🇱 פויליש](../pl/README.md)
41
+ [🇧🇷 פּאָרטוגעזיש](../pt/README.md)
42
+ [🇷🇺 רוסיש](../ru/README.md)
43
+ [🇰🇪 סוואַהילי](../sw/README.md)
44
+ [🇵🇭 Tagalog](../tl/README.md)
45
+ [🇹🇷 טערקיש](../tr/README.md)
46
+ [🇵🇰 אורדו](../ur/README.md)
47
+ [🇻🇳 וויעטנאַמעזיש](../vi/README.md)
48
+ [🇨🇳 כינעזיש](../zh/README.md)
49
+
50
+
51
+ **[📚 ... אַלע שפּראַכן ...](../README.md)**
52
+ ----
53
+
54
+ ### איז עס אַ פּראָבלעם מיט דעם איבערזעצונג פון די README?
55
+ די באַזונדער איבערזעצונג פון דער אָריגינעל [README](https://github.com/cobbzilla/mobiletto/blob/master/README.md)
56
+ קען זיין פלאָז - * קערעקשאַנז זענען זייער באַגריסן!* ביטע שיקן אַ [ציען בעטן אויף גיטהוב](https://github.com/cobbzilla/mobiletto/pulls),
57
+ אָדער אויב איר זענט נישט באַקוועם צו טאָן דאָס, [עפענען אַן אַרויסגעבן](https://github.com/cobbzilla/mobiletto/issues)
58
+
59
+ ווען איר שאַפֿן אַ נייַע GitHub אַרויסגעבן וועגן אַ איבערזעצונג, ביטע טאָן:
60
+ * אַרייַננעמען די URL פון די בלאַט (קאָפּי / פּאַפּ פון דעם בלעטערער אַדרעס באַר)
61
+ * אַרייַננעמען די פּינטלעך טעקסט וואָס איז פאַלש (קאָפּי / פּאַפּ פון בלעטערער)
62
+ * ביטע באַשרייַבן וואָס איז פאַלש - איז די איבערזעצונג פאַלש? איז די פאָרמאַטטינג עפעס צעבראכן?
63
+ * ביטע פאָרשלאָגן אַ פאָרשלאָג פון אַ בעסער איבערזעצונג, אָדער ווי דער טעקסט זאָל זיין רעכט פאָרמאַטטעד
64
+ * **אדאנק!**
65
+
66
+ ## פארוואס מאָבילעטטאָ?
67
+
68
+ ### זייַ געזונט פאַרקויפער שלאָס-אין!
69
+ די פאַרשידן וואָלקן סטאָרידזש פּראַוויידערז האָבן ינקאַמפּאַטאַבאַל אַפּיס. אפילו די וואָס שטרעבן פֿאַר "S3 קאַמפּאַטאַבילאַטי"
70
+ האָבן אידיאָסינקראַטיק ביכייוויערז.
71
+
72
+ ווען איר קלייַבן אַ באַזונדער סטאָרידזש פאַרקויפער פֿאַר דיין אַפּ, אויב איר קאָד גלייַך צו זייער אַפּי, דיין אַפּ
73
+ איז איצט אָפענגיק אויף דעם דינסט. ווי צייט גייט דורך און קאָד אַקיומיאַלייץ, טשאַנגינג ווענדאָרס ווערט
74
+ ינקריסינגלי אַנטענאַבאַל. ברוכים הבאים צו דער שפּאַס וועלט פון פאַרקויפער שלאָס-אין!
75
+
76
+ Mobiletto איז דיזיינד צו סאָלווע דעם פּראָבלעם. דורך קאָודינג דיין אַפּ צו Mobiletto's API, איר קענען לייכט
77
+ טוישן סטאָרידזש פּראַוויידערז און וויסן אַז די סטאָרידזש שיכטע פון דיין אַפּ וועט זיין יידעניקאַל.
78
+
79
+ ### ברייטע טעסטינג
80
+ אַלע דריווערס זענען טעסטעד פֿאַר יידעניקאַל נאַטור מיט 60+ טעסץ פֿאַר יעדער שאָפער.
81
+ מיר פּרובירן אַלע דריווערס מיט יעדער קאָמבינאַציע פון:
82
+ * ענקריפּשאַן: ביידע ענייבאַלד און פאַרקריפּלט
83
+ * רעדיס קאַש: ביידע ענייבאַלד און פאַרקריפּלט
84
+
85
+ דער צוגאַנג גיט אונדז שלום פון מיינונג אַז מאָבילעטטאָ וועט זיין די זעלבע ראַגאַרדלאַס פון וואָס שאָפער איר נוצן,
86
+ און ראַגאַרדלאַס פון צי איר געבן קאַטשינג און / אָדער ענקריפּשאַן.
87
+
88
+ ### דרייווער שטיצן
89
+ קראַנט Mobiletto סטאָרידזש דריווערס:
90
+ * `s3` : Amazon S3
91
+ * `b2` : Backblaze B2
92
+ * `local` : היגע פילעסיסטעם
93
+
94
+ * קאַנטריביושאַנז צו שטיצן מער וואָלקן סטאָרידזש פּראַוויידערז זענען זייער באַגריסן!*
95
+
96
+ ## מאָבילעטטאָ-קלי
97
+ Mobiletto איז בדעה צו זיין געוויינט ווי אַ ביבליאָטעק דורך אנדערע דזשאַוואַסקריפּט קאָד.
98
+
99
+ צו אַרבעטן מיט מאָבילעטטאָ ביי די באַפֿעלן שורה, נוצן [mobiletto-cli](https://www.npmjs.com/package/mobiletto-cli)
100
+
101
+ ## מקור
102
+ * [מאָבילעטטאָ אויף גיטהוב](https://github.com/cobbzilla/mobiletto)
103
+ * [מאָבילעטטאָ אויף נפּם](https://www.npmjs.com/package/mobiletto)
104
+
105
+ ## שנעל אָנהייב
106
+ א קורץ בייַשפּיל ניצן די Mobiletto `s3` שאָפער.
107
+
108
+ דער קאָד וואָלט לויפן די זעלבע אויב דער שאָפער איז געווען `b2` אָדער `local` .
109
+
110
+ const storage = require('mobiletto')
111
+ const bucket = await storage.connect('s3', aws_key, aws_secret, {bucket: 'bk'})
112
+
113
+ // list objects: returns array of metadata objects
114
+ const listing = await bucket.list()
115
+ const dirList = await bucket.list('some/dir/')
116
+ const everything = await bucket.list('', {recursive: true})
117
+
118
+ // write an entire file
119
+ let bytesWritten = await bucket.writeFile('some/path', someBufferOfData)
120
+
121
+ // write a file from a stream/generator
122
+ bytesWritten = await bucket.write('some/path', streamOrGenerator)
123
+
124
+ // read an entire file
125
+ // returns null if an exception would otherwise be thrown
126
+ const bufferOrNull = await bucket.safeReadFile('some/path')
127
+
128
+ // stream-read a file, passing data to callback
129
+ const bytesRead = await bucket.read('some/path', (chunk) => { ...do something with chunk... } )
130
+
131
+ // remove a file, returns the path removed
132
+ let removed = await bucket.remove('some/path') // removed is a string
133
+
134
+ // remove a directory, returns array of paths removed
135
+ removed = await bucket.remove('some/directory', {recursive: true}) // removed is now an array!
136
+
137
+ ----
138
+ ## יקערדיק באַניץ
139
+ א פיל מער ברייט בייַשפּיל, ווייזונג רובֿ פון די פֿעיִקייטן געפֿינט:
140
+
141
+ const { mobiletto } = require('mobiletto')
142
+
143
+ // General usage
144
+ const api = await mobiletto(driverName, key, secret, opts)
145
+
146
+ // To use 'local' driver:
147
+ // * key: base directory
148
+ // * secret: ignored, can be null
149
+ // * opts object:
150
+ // * readOnly: optional, never change anything on the filesystem; default is false
151
+ // * fileMode: optional, permissions used when creating new files, default is 0600. can be string or integer
152
+ // * dirMode: optional, permissions used when creating new directories, default is 0700. can be string or integer
153
+ const local = await mobiletto('local', '/home/ubuntu/tmp', null, {fileMode: 0o0600, dirMode: '0700'})
154
+
155
+ // To use 's3' driver:
156
+ // * key: AWS Access Key ID
157
+ // * secret: AWS Secret Key
158
+ // * opts object:
159
+ // * readOnly: optional, never change anything on the bucket; default is false
160
+ // * bucket: required, name of the S3 bucket
161
+ // * region: optional, the AWS region to communicate with, default is us-east-1
162
+ // * prefix: optional, all read/writes within the S3 bucket will be under this prefix
163
+ // * delimiter: optional, directory delimiter, default is '/' (note: always '/' when encryption is enabled)
164
+ const s3 = await mobiletto('s3', aws_key, aws_secret, {bucket: 'bk', region: 'us-east-1'})
165
+
166
+ // To use 'b2' driver:
167
+ // * key: Backblaze Key ID
168
+ // * secret: Backblaze Application Key
169
+ // * opts object:
170
+ // * readOnly: optional, never change anything on the bucket; default is false
171
+ // * bucket: required, the ID (**not the name**) of the B2 bucket
172
+ // * prefix: optional, all read/writes within the B2 bucket will be under this prefix
173
+ // * delimiter: optional, directory delimiter, default is '/' (note: always '/' when encryption is enabled)
174
+ // * partSize: optional, large files will be split into chunks of this size when uploading
175
+ const b3 = await mobiletto('b2', b2_key_id, b2_app_key, {bucket: 'bk', partSize: 10000000})
176
+
177
+ // List files
178
+ api.list() // --> returns an array of metadata objects
179
+
180
+ // List files recursively
181
+ api.list({ recursive: true })
182
+
183
+ // List files in a directory
184
+ const path = 'some/path'
185
+ api.list(path)
186
+ api.list(path, { recursive: true }) // also supports recursive flag
187
+
188
+ // Visit files in a directory -- visitor function must be async
189
+ api.list(path, { visitor: myAsyncFunc })
190
+ api.list(path, { visitor: myAsyncFunc, recursive: true })
191
+
192
+ // The `list` method throws MobilettoNotFoundError if the path does not exist
193
+ // When you call `safeList` on a non-existent path, it returns an empty array
194
+ api.safeList('/path/that/does/not/exist') // returns []
195
+
196
+ // Read metadata for a file
197
+ api.metadata(path) // returns metadata object
198
+
199
+ // The `metadata` method throws MobilettoNotFoundError if the path does not exist
200
+ // When you call `safeMetadata` on a non-existent path, it returns null
201
+ api.safeMetadata('/tmp/does_not_exist') // returns null
202
+
203
+ // Read a file
204
+ // Provide a callback that writes the data someplace
205
+ const callback = (chunk) => { ... write chunk somewhere ... }
206
+ api.read(path, callback) // returns count of bytes read
207
+
208
+ // Read an entire file at once
209
+ const data = await api.readFile(path) // returns a byte Buffer of the file contents
210
+
211
+ // Read an entire file at once
212
+ // returns null if an exception would otherwise be thrown
213
+ const bufferOrNull = await bucket.safeReadFile('some/path')
214
+
215
+ // Write a file
216
+ // Provide a generator function that yields chunks of data
217
+ const generator = function* () {
218
+ while ( ... more-data-to-return ... ) {
219
+ data = ... load-data ...
220
+ yield data
221
+ }
222
+ }
223
+ local.api(path, generator) // returns count of bytes written
224
+
225
+ // Write an entire file at once (convenience method)
226
+ await api.writeFile(path, bufferOrString) // returns count of bytes written
227
+
228
+ // Delete a file
229
+ // Quiet param is optional (default false), when set errors will not be thrown if the path does not exist
230
+ // Always returns a value or throws an error.
231
+ // Return value may be a single string of the file removed, or an array of all files removed (driver-dependent)
232
+ const quiet = true
233
+ api.remove(path, {quiet}) // returns single path removed
234
+
235
+ // Recursively delete a directory and do it quietly (do not report errors)
236
+ const recursive = true
237
+ const quiet = true
238
+ api.remove(path, {recursive, quiet}) // returns array of paths removed
239
+
240
+ ## מעטאַדאַטאַ
241
+ די `metadata` באַפֿעל קערט מעטאַדאַטאַ וועגן אַ איין טעקע סיסטעם פּאָזיציע.
242
+ פּונקט אַזוי, דער צוריקקער ווערט פון די `list` באַפֿעל איז אַ מענגע פון מעטאַדאַטאַ אַבדזשעקץ.
243
+
244
+ א מעטאַדאַטאַ כייפעץ קוקט ווי דאָס:
245
+
246
+ {
247
+ "name": "fully/qualified/path/to/file",
248
+ "type": "entry-type",
249
+ "size": size-in-bytes,
250
+ "ctime": creation-time-epoch-millis,
251
+ "mtime": modification-time-epoch-millis
252
+ }
253
+
254
+ די `type` פאַרמאָג קענען זיין `file` , `dir` , `link` אָדער `special` .
255
+
256
+ דעפּענדינג אויף דעם טיפּ פון שאָפער, אַ `list` באַפֿעל קען נישט צוריקקומען אַלע פעלדער. די `name` און `type` פּראָפּערטיעס
257
+ זאָל שטענדיק זיין פאָרשטעלן. א סאַבסאַקוואַנט `metadata` באַפֿעל וועט צוריקקומען אַלע בנימצא פּראָפּערטיעס.
258
+
259
+ ## אָלטערנאַטיוו אַרייַנפיר נוסח
260
+ אַרייַנפיר די גאָר- `connect` מאָדולע און נוצן די 'פאַרבינדן' פֿונקציע:
261
+
262
+ const storage = require('mobiletto')
263
+ const opts = {bucket: 'bk', region: 'us-east-1'}
264
+ const s3 = await storage.connect('s3', aws_key, aws_secret, opts)
265
+ const objectData = await s3.readFile('some/path')
266
+
267
+ ## קאַטשינג
268
+ Mobiletto אַרבעט בעסטער מיט אַ <a href="https://redis.io">רעדיס</a> קאַש.
269
+
270
+ Mobiletto וועט פּרווון צו פאַרבינדן צו אַ רעדיס בייַשפּיל אויף 127.0.0.1:6379
271
+
272
+ איר קענען אָווועררייד איינער פון די:
273
+ * שטעלן די `MOBILETTO_REDIS_HOST` ענוו וואַר, מאָבילעט צו פאַרבינדן דאָ אַנשטאָט פון לאָקאַלהאָסט
274
+ * שטעלן די `MOBILETTO_REDIS_PORT` ענוו וואַר, דעם פּאָרט וועט זיין געוויינט
275
+
276
+ Mobiletto וועט קראָם אַלע זיין רעדיס שליסלען מיט די פּרעפיקס `_mobiletto__` . איר קענען טוישן דעם
277
+ דורך באַשטעטיקן די `MOBILETTO_REDIS_PREFIX` env var.
278
+
279
+ איר קענען אויך שטעלן פּער-פֿאַרבינדונג קאַטשינג מיט די `opts.redisConfig` כייפעץ:
280
+
281
+ const redisConfig = {
282
+ enabled: true, // optional, default is true. if false other props are ignored
283
+ host: '127.0.0.1',
284
+ port: 6379,
285
+ prefix: '_mobiletto__'
286
+ }
287
+ const opts = { redisConfig, bucket: 'bk', region: 'us-east-1' }
288
+ const s3 = await storage.connect('s3', aws_key, aws_secret, opts)
289
+
290
+ ### דו זאלסט נישט וועלן רעדיס קאַטשינג?
291
+ צו דיסייבאַל: פאָרן `enabled: false` אין דיין `opts.redisConfig` כייפעץ ווען איר פאַרלייגן דיין קשר.
292
+
293
+ ווי דיסקאַסט אונטן, דיסייבאַלינג קאַטשינג וועט האָבן אַ אַדווערס ווירקונג אויף פאָרשטעלונג און האָבן מער ריקוועס
294
+ צו סטאָרידזש אַז איר טאַקע דאַרפֿן צו.
295
+
296
+ ### קאַטשינג גיידאַנס
297
+ ** ענקריפּטיד סטאָרידזש **: לייענען / שרייבן ענקריפּטיד סטאָרידזש איז בלויז אַ ביסל סלאָוער ווי נאָרמאַל,
298
+ אָבער נאַוואַגייטינג אַרום דיירעקטעריז (וואָס עטלעכע טינגז טאָן) איז גאַנץ טייַער. ניצן אַ רעדיס קאַש
299
+ וועט געבן איר אַ באַטייטיק פאָרשטעלונג בוסט.
300
+
301
+ די פעליקייַט קאַש איז זיכער, אָבער טוט נישט אַרבעטן געזונט אויב איר האָבן אַ פּלאַץ פון שרייַבן / אַראָפּנעמען אַפּעריישאַנז.
302
+ קיין שרייבן אָדער אַראָפּנעמען אָפּעראַציע ינוואַלאַדייץ די גאנצע קאַש, ינשורינג סאַבסאַקוואַנט לייענען וועט זען די
303
+ לעצט ענדערונגען.
304
+
305
+ ### CLI מכשירים
306
+ אויב איר נוצן אַ CLI געצייַג ווי [mobiletto-cli](https://www.npmjs.com/package/mobiletto-cli),
307
+ איר וועט באשטימט וועלן די רעדיס קאַש ענייבאַלד, ווייַל עס לאַסץ איבער ינוואַקיישאַנז פון די `mo` באַפֿעל.
308
+
309
+ ## שפיגלען
310
+
311
+ // Copy a local filesystem mobiletto to S3
312
+ s3.mirror(local)
313
+
314
+ // Mirror a local subdirectory from one mobiletto to an S3 mobiletto, with it's own subdirectory
315
+ local.mirror(s3, 'some/local-folder', 'some/s3-folder')
316
+
317
+ דער `mirror` באַפֿעל פּערפאָרמז אַ איין מאָל קאָפּיע פון אַלע טעקעס פון איין מאָבילעטטאָ צו אנדערן.
318
+ עס טוט נישט לויפן קיין פּראָצעס צו טייַנען דער שפּיגל איבער צייַט. לויפן די `mirror` באַפֿעל ווידער
319
+ צו סינגקראַנייז קיין פעלנדיק טעקעס.
320
+
321
+ דער צוריקקער ווערט פון `mirror` איז אַ פּשוט כייפעץ מיט קאָונטערס פֿאַר ווי פילע טעקעס זענען הצלחה
322
+ מירערד און ווי פילע טעקעס האָבן ערראָרס:
323
+
324
+ {
325
+ success: count-of-files-mirrored,
326
+ errors: count-of-files-with-errors
327
+ }
328
+
329
+ ווארענונג: מירערינג גרויס דאַטן שטעלט קענען זיין זייער צייט-קאַנסומינג און באַנדווידט-אינטענסיווע
330
+
331
+ מיט די `mirror` רופן סעמאַנטיקס עס קען מאל זיין קאַנפיוזינג צו פֿאַרשטיין ווער איז דער
332
+ לייענער און ווער איז דער שרייבער. ימאַדזשאַן עס ווי אַ אַסיינמאַנט ויסזאָגונג: די "לינקס מאָבילעטטאָ"
333
+ איז די זאַך וואָס איז אַסיינד צו (מירערד דאַטן געשריבן), און די "רעכט-האַנט מאָבילעטטאָ" (די
334
+ אַרגומענט צו דער `mirror` אופֿן) איז די ווערט אַסיינד (מירערד דאַטן איז לייענען).
335
+
336
+ ## טראַנספּעראַנט ענקריפּשאַן
337
+ געבן טראַנספּעראַנט קליענט-זייַט ענקריפּשאַן:
338
+
339
+ // Pass encryption parameters
340
+ const encryption = {
341
+ // key is required, must be >= 16 chars
342
+ key: randomstring.generate(128),
343
+
344
+ // optional, the default is to derive IV from key
345
+ // when set, IV must be >= 16 chars
346
+ iv: randomstring.generate(128),
347
+
348
+ // optional, the default is aes-256-cbc
349
+ algo: 'aes-256-cbc'
350
+ }
351
+ const api = await mobiletto(driverName, key, secret, opts, encryption)
352
+
353
+ // Subsequent write operations will encrypt data (client side) when writing
354
+ // Subsequent read operations will decrypt data (client side) when reading
355
+
356
+ וואס טוט זיך? א באַזונדער "דערווייַז פּאָזיציע" (דירענט) וועגווייַזער (ענקריפּטיד) טראַקס וואָס טעקעס זענען אין דעם
357
+ וועגווייַזער (אַקאַ די דירעקט וועגווייַזער).
358
+ * די `list` באַפֿעל לייענט די Directory פּאָזיציע טעקעס, דעקריפּט יעדער דרך ליסטעד; דערנאָך קערט מעטאַדאַטאַ פֿאַר יעדער טעקע
359
+ * `list` קאַמאַנדז זענען מער באַטלאָניש, ספּעציעל פֿאַר דיירעקטעריז מיט אַ גרויס נומער פון טעקעס
360
+ * דער `write` באַפֿעל שרייבט דירעקט טעקעס אין די דירעקט וועגווייַזער פון יעדער פאָטער, רעקורסיוולי; דעמאָלט שרייבט די טעקע
361
+ * `write` קאַמאַנדז וועט מאַכן אָ (ען) שרייבט, מיט N = טיפקייַט אין די וועגווייַזער כייעראַרקי
362
+ * די `remove` באַפֿעל רימוווז די קאָראַספּאַנדינג דירעקט טעקע, און זיין פאָטער אויב ליידיק, רעקורסיוולי; דעמאָלט רימוווז די טעקע
363
+ * ניט-רעקורסיווע `remove` קאַמאַנדז וועט מאַכן אָ (ען) לייענט און פּאַטענטשאַלי ווי פילע דיליץ, מיט N = טיפקייַט אין די וועגווייַזער כייעראַרקי
364
+ * רעקורסיווע `remove` קאַמאַנדז אויף גרויס און טיף פילעסיסטעמס קענען זיין טייַער
365
+
366
+ באַמערקונג אַז אפילו מיט ענקריפּשאַן פון קליענט זייַט, אַ קעגנער מיט פול וויזאַביליטי אין דיין ינקריפּטיד סערווער זייַט
367
+ סטאָרידזש, אפילו אָן די שליסל, קענען נאָך זען די גאַנץ נומער פון דירעקטעריז און ווי פילע טעקעס זענען אין יעדער, און מיט
368
+ עטלעכע מי, אַנטדעקן עטלעכע אָדער אַלע פון די קוילעלדיק סטרוקטור פון די וועגווייַזער כייעראַרקי.
369
+ *באַמערקונג: ניצן אַ לעפיערעך פלאַך סטרוקטור פֿאַר בעסער זיכערהייט.*
370
+ דער קעגנער וואָלט נישט וויסן די נעמען פון די דירעקטעריז / טעקעס אויב זיי אויך וויסן דיין ענקריפּשאַן
371
+ שליסל אָדער האט אַנדערש הצלחה קראַקט די ענקריפּשאַן. אַלע בעץ זענען אַוועק דעמאָלט!
372
+
373
+ ### פאָרשטעלונג און קאַטשינג
374
+ אָפּעראַטיאָנס אויף ינקריפּטיד סטאָרידזש קענען זיין פּאַמעלעך. רעקורסיווע ליסטינגס און רימווואַלז קענען זיין זייער פּאַמעלעך.
375
+ קאַטשינג דורך רעדיס העלפּס טרימענדאַסלי, אָבער טאָן אַז די קאַש איז פלאַשט אויף קיין שרייבט אָדער רימוווז.
376
+
377
+ ## שליסל ראָוטיישאַן
378
+ שאַפֿן אַ מאָבילעטטאָ מיט דיין נייַע שליסל, און שפּיגל די אַלט דאַטן אין עס:
379
+
380
+ const storage = require('mobiletto')
381
+
382
+ const oldEncryption = { key: .... }
383
+ const oldStorage = await storage.connect('s3', aws_key, aws_secret, {bucket: 'bk', region: 'us-east-1'}, oldEncryption)
384
+
385
+ const newEncryption = { key: .... }
386
+ const newStorage = await storage.connect('s3', aws_key, aws_secret, {bucket: 'zz', region: 'us-east-1'}, newEncryption)
387
+
388
+ newStorage.mirror(oldStorage) // if oldStorage is very large, this may take a looooooong time...
389
+
390
+ ## דרייווער צובינד
391
+ א שאָפער איז קיין JS טעקע וואָס עקספּאָרץ אַ 'סטאָראַגעקליענט' פֿונקציע מיט דעם כסימע:
392
+
393
+ function storageClient (key, secret, opts)
394
+
395
+ * `key` : אַ שטריקל, דיין אַפּי שליסל (פֿאַר די `local` שאָפער, דאָס איז די באַזע וועגווייַזער)
396
+ * `secret` : אַ שטריקל, דיין אַפּי סוד (קענען זיין איבערגעהיפּערט פֿאַר די `local` דרייווער)
397
+ * `opts` : אַ כייפעץ, די פּראָפּערטיעס זענען פּער שאָפער:
398
+ * פֿאַר `local` , די `fileMode` און `dirMode` פּראָפּערטיעס באַשטימען ווי נייַ קריייטינג טעקעס און דיירעקטעריז זענען באשאפן
399
+ * פֿאַר `s3` , די `bucket` פאַרמאָג איז פארלאנגט. אָפּטיאָנאַל פּראָפּערטיעס זענען:
400
+ * `region`: the S3 region, default is us-east-1
401
+ * `prefix`: a prefix to prepend to all S3 paths, default is the empty string
402
+ * `delimiter`: the directory delimiter, default is '/'
403
+
404
+ דער כייפעץ וואָס די storageClient פונקציע קערט מוזן דעפינירן די פאַנגקשאַנז:
405
+
406
+ // Test the driver before using, ensure proper configuration
407
+ async testConfig ()
408
+
409
+ // List files in path (or from base-directory)
410
+ // If recursive is true, list recursively
411
+ // If visitor is defined, it will be an async function. await the visitor function on each file found
412
+ // Otherwise, perform the listing and return an array of objects
413
+ async list (path, recursive = false, visitor = null) // path may be omitted
414
+
415
+ // Read metadata for a path
416
+ async metadata (path)
417
+
418
+ // Read a file
419
+ // callback receives a chunk of data. endCallback is called at end-of-stream
420
+ async read (path, callback, endCallback = null)
421
+
422
+ // Write a file
423
+ // driver must be able to handle a generator or a stream
424
+ async write (path, generatorOrReadableStream)
425
+
426
+ // Remove a file, or recursively delete a directory
427
+ // returns a string of a single path removed, or an array of multiple paths removed
428
+ async remove (path, recursive = false, quiet = false)
429
+
430
+ ## לאָגינג
431
+ Mobiletto ניצט די [winston](https://www.npmjs.com/package/winston) לאָגינג ביבליאָטעק.
432
+
433
+ לאָגס **וועט** אַנטהאַלטן טעקע פּאַטס און טעות אַרטיקלען, אָבער וועט **קיינמאָל** אַנטהאַלטן שליסלען, סיקריץ,
434
+ אָדער קיין אנדערע קשר קאַנפיגיעריישאַן אינפֿאָרמאַציע.
435
+
436
+ ### קלאָץ מדרגה
437
+ ניצן די `MOBILETTO_LOG_LEVEL` סוויווע בייַטעוודיק צו שטעלן די קלאָץ מדרגה, ניצן איינער
438
+ פון די `npm` לעוועלס דיפיינד אין [https://www.npmjs.com/package/winston#logging-levels](https://www.npmjs.com/package/winston#logging-levels)
439
+
440
+ די פעליקייַט מדרגה איז `error` . די מערסט ווערבאָוס מדרגה איז `silly` , כאָטש דערווייַל מאָבילעטטאָ
441
+ טוט נישט קלאָץ אין לעוועלס אונטער `debug`
442
+
443
+ MOBILETTO_LOG_LEVEL=silly # maximum logs!
444
+
445
+ ### קלאָץ טעקע
446
+ דורך פעליקייַט, די לאָגער שרייבט צו די קאַנסאָול. צו שיקן לאָגס צו אַ טעקע, שטעלן די `MOBILETTO_LOG_FILE`
447
+ סוויווע בייַטעוודיק. ווען לאָגינג צו אַ טעקע, לאָגס וועט ניט מער זיין געשריבן צו די קאַנסאָול.
448
+
449
+ MOBILETTO_LOG_FILE=/var/my_mobiletto_log
450
+
451
+ צו קער אַוועק לאָגינג:
452
+
453
+ MOBILETTO_LOG_FILE=/dev/null
454
+
455
+ </pre>