@triophore/falconjs 1.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.
Files changed (53) hide show
  1. package/FalconAuthPlugin.js +473 -0
  2. package/LICENSE +21 -0
  3. package/README.md +2 -0
  4. package/core/auth.js +200 -0
  5. package/core/cache/redis_cacher.js +7 -0
  6. package/core/check_collection.js +9 -0
  7. package/core/crypto/encrypt_decrypt.js +19 -0
  8. package/core/errors.js +48 -0
  9. package/core/logger/log4js.js +89 -0
  10. package/core/logo.js +3 -0
  11. package/core/mongo/generateModelfromJsonFile.js +128 -0
  12. package/core/mongo/mongoSchmeFromJson.js +90 -0
  13. package/core/parse_num.js +8 -0
  14. package/core/rannum.js +33 -0
  15. package/core/ranstring.js +33 -0
  16. package/core/recursive-require-call.js +121 -0
  17. package/core/uitls/mongoose_to_joi.js +72 -0
  18. package/core/uitls/return.js +7 -0
  19. package/falcon.js +1644 -0
  20. package/falconAuthPlugin.js +17 -0
  21. package/falconBaseService.js +532 -0
  22. package/falconBaseWorker.js +540 -0
  23. package/index.js +4 -0
  24. package/out/Falcon.html +777 -0
  25. package/out/falcon.js.html +525 -0
  26. package/out/fonts/OpenSans-Bold-webfont.eot +0 -0
  27. package/out/fonts/OpenSans-Bold-webfont.svg +1830 -0
  28. package/out/fonts/OpenSans-Bold-webfont.woff +0 -0
  29. package/out/fonts/OpenSans-BoldItalic-webfont.eot +0 -0
  30. package/out/fonts/OpenSans-BoldItalic-webfont.svg +1830 -0
  31. package/out/fonts/OpenSans-BoldItalic-webfont.woff +0 -0
  32. package/out/fonts/OpenSans-Italic-webfont.eot +0 -0
  33. package/out/fonts/OpenSans-Italic-webfont.svg +1830 -0
  34. package/out/fonts/OpenSans-Italic-webfont.woff +0 -0
  35. package/out/fonts/OpenSans-Light-webfont.eot +0 -0
  36. package/out/fonts/OpenSans-Light-webfont.svg +1831 -0
  37. package/out/fonts/OpenSans-Light-webfont.woff +0 -0
  38. package/out/fonts/OpenSans-LightItalic-webfont.eot +0 -0
  39. package/out/fonts/OpenSans-LightItalic-webfont.svg +1835 -0
  40. package/out/fonts/OpenSans-LightItalic-webfont.woff +0 -0
  41. package/out/fonts/OpenSans-Regular-webfont.eot +0 -0
  42. package/out/fonts/OpenSans-Regular-webfont.svg +1831 -0
  43. package/out/fonts/OpenSans-Regular-webfont.woff +0 -0
  44. package/out/index.html +65 -0
  45. package/out/scripts/linenumber.js +25 -0
  46. package/out/scripts/prettify/Apache-License-2.0.txt +202 -0
  47. package/out/scripts/prettify/lang-css.js +2 -0
  48. package/out/scripts/prettify/prettify.js +28 -0
  49. package/out/styles/jsdoc-default.css +358 -0
  50. package/out/styles/prettify-jsdoc.css +111 -0
  51. package/out/styles/prettify-tomorrow.css +132 -0
  52. package/package.json +106 -0
  53. package/settings.js +1 -0
@@ -0,0 +1,777 @@
1
+ <!DOCTYPE html>
2
+ <html lang="en">
3
+ <head>
4
+ <meta charset="utf-8">
5
+ <title>JSDoc: Class: Falcon</title>
6
+
7
+ <script src="scripts/prettify/prettify.js"> </script>
8
+ <script src="scripts/prettify/lang-css.js"> </script>
9
+ <!--[if lt IE 9]>
10
+ <script src="//html5shiv.googlecode.com/svn/trunk/html5.js"></script>
11
+ <![endif]-->
12
+ <link type="text/css" rel="stylesheet" href="styles/prettify-tomorrow.css">
13
+ <link type="text/css" rel="stylesheet" href="styles/jsdoc-default.css">
14
+ </head>
15
+
16
+ <body>
17
+
18
+ <div id="main">
19
+
20
+ <h1 class="page-title">Class: Falcon</h1>
21
+
22
+
23
+
24
+
25
+
26
+
27
+ <section>
28
+
29
+ <header>
30
+
31
+ <h2><span class="attribs"><span class="type-signature"></span></span>Falcon<span class="signature">()</span><span class="type-signature"></span></h2>
32
+
33
+ <div class="class-description">Represents a Falcon Server.</div>
34
+
35
+
36
+ </header>
37
+
38
+ <article>
39
+ <div class="container-overview">
40
+
41
+
42
+
43
+
44
+ <h2>Constructor</h2>
45
+
46
+
47
+
48
+ <h4 class="name" id="Falcon"><span class="type-signature"></span>new Falcon<span class="signature">()</span><span class="type-signature"></span></h4>
49
+
50
+
51
+
52
+
53
+
54
+
55
+
56
+
57
+
58
+
59
+
60
+
61
+
62
+
63
+
64
+
65
+
66
+
67
+ <dl class="details">
68
+
69
+
70
+
71
+
72
+
73
+
74
+
75
+
76
+
77
+
78
+
79
+
80
+
81
+
82
+
83
+
84
+
85
+
86
+
87
+
88
+
89
+
90
+
91
+
92
+
93
+
94
+ <dt class="tag-source">Source:</dt>
95
+ <dd class="tag-source"><ul class="dummy"><li>
96
+ <a href="falcon.js.html">falcon.js</a>, <a href="falcon.js.html#line34">line 34</a>
97
+ </li></ul></dd>
98
+
99
+
100
+
101
+
102
+
103
+
104
+
105
+ </dl>
106
+
107
+
108
+
109
+
110
+
111
+
112
+
113
+
114
+
115
+
116
+
117
+
118
+
119
+
120
+
121
+
122
+
123
+
124
+
125
+
126
+
127
+ </div>
128
+
129
+
130
+
131
+
132
+
133
+
134
+
135
+
136
+
137
+
138
+
139
+
140
+
141
+
142
+
143
+
144
+ <h3 class="subsection-title">Methods</h3>
145
+
146
+
147
+
148
+
149
+
150
+
151
+
152
+ <h4 class="name" id="addRoute"><span class="type-signature">(async) </span>addRoute<span class="signature">(route)</span><span class="type-signature"></span></h4>
153
+
154
+
155
+
156
+
157
+
158
+
159
+
160
+
161
+
162
+
163
+
164
+
165
+
166
+
167
+ <h5>Parameters:</h5>
168
+
169
+
170
+ <table class="params">
171
+ <thead>
172
+ <tr>
173
+
174
+ <th>Name</th>
175
+
176
+
177
+ <th>Type</th>
178
+
179
+
180
+
181
+
182
+
183
+ <th class="last">Description</th>
184
+ </tr>
185
+ </thead>
186
+
187
+ <tbody>
188
+
189
+
190
+ <tr>
191
+
192
+ <td class="name"><code>route</code></td>
193
+
194
+
195
+ <td class="type">
196
+
197
+
198
+ <span class="param-type">*</span>
199
+
200
+
201
+
202
+ </td>
203
+
204
+
205
+
206
+
207
+
208
+ <td class="description last">for connecting</td>
209
+ </tr>
210
+
211
+
212
+ </tbody>
213
+ </table>
214
+
215
+
216
+
217
+
218
+
219
+
220
+ <dl class="details">
221
+
222
+
223
+
224
+
225
+
226
+
227
+
228
+
229
+
230
+
231
+
232
+
233
+
234
+
235
+
236
+
237
+
238
+
239
+
240
+
241
+
242
+
243
+
244
+
245
+
246
+
247
+ <dt class="tag-source">Source:</dt>
248
+ <dd class="tag-source"><ul class="dummy"><li>
249
+ <a href="falcon.js.html">falcon.js</a>, <a href="falcon.js.html#line206">line 206</a>
250
+ </li></ul></dd>
251
+
252
+
253
+
254
+
255
+
256
+
257
+
258
+ </dl>
259
+
260
+
261
+
262
+
263
+
264
+
265
+
266
+
267
+
268
+
269
+
270
+
271
+
272
+
273
+
274
+ <h5>Returns:</h5>
275
+
276
+
277
+ <div class="param-desc">
278
+ context
279
+ </div>
280
+
281
+
282
+
283
+
284
+
285
+
286
+
287
+
288
+
289
+
290
+
291
+
292
+
293
+
294
+
295
+ <h4 class="name" id="init"><span class="type-signature">(async) </span>init<span class="signature">()</span><span class="type-signature"></span></h4>
296
+
297
+
298
+
299
+
300
+
301
+
302
+ <div class="description">
303
+ starts the initializing process
304
+ </div>
305
+
306
+
307
+
308
+
309
+
310
+
311
+
312
+
313
+
314
+
315
+
316
+
317
+
318
+ <dl class="details">
319
+
320
+
321
+
322
+
323
+
324
+
325
+
326
+
327
+
328
+
329
+
330
+
331
+
332
+
333
+
334
+
335
+
336
+
337
+
338
+
339
+
340
+
341
+
342
+
343
+
344
+
345
+ <dt class="tag-source">Source:</dt>
346
+ <dd class="tag-source"><ul class="dummy"><li>
347
+ <a href="falcon.js.html">falcon.js</a>, <a href="falcon.js.html#line109">line 109</a>
348
+ </li></ul></dd>
349
+
350
+
351
+
352
+
353
+
354
+
355
+
356
+ </dl>
357
+
358
+
359
+
360
+
361
+
362
+
363
+
364
+
365
+
366
+
367
+
368
+
369
+
370
+
371
+
372
+ <h5>Returns:</h5>
373
+
374
+
375
+ <div class="param-desc">
376
+ context
377
+ </div>
378
+
379
+
380
+
381
+
382
+
383
+
384
+
385
+
386
+
387
+
388
+
389
+
390
+
391
+
392
+
393
+ <h4 class="name" id="registerAuth"><span class="type-signature">(async) </span>registerAuth<span class="signature">()</span><span class="type-signature"></span></h4>
394
+
395
+
396
+
397
+
398
+
399
+
400
+ <div class="description">
401
+ Override this function to handle your own auth
402
+ </div>
403
+
404
+
405
+
406
+
407
+
408
+
409
+
410
+
411
+
412
+
413
+
414
+
415
+
416
+ <dl class="details">
417
+
418
+
419
+
420
+
421
+
422
+
423
+
424
+
425
+
426
+
427
+
428
+
429
+
430
+
431
+
432
+
433
+
434
+
435
+
436
+
437
+
438
+
439
+
440
+
441
+
442
+
443
+ <dt class="tag-source">Source:</dt>
444
+ <dd class="tag-source"><ul class="dummy"><li>
445
+ <a href="falcon.js.html">falcon.js</a>, <a href="falcon.js.html#line313">line 313</a>
446
+ </li></ul></dd>
447
+
448
+
449
+
450
+
451
+
452
+
453
+
454
+ </dl>
455
+
456
+
457
+
458
+
459
+
460
+
461
+
462
+
463
+
464
+
465
+
466
+
467
+
468
+
469
+
470
+
471
+
472
+
473
+
474
+
475
+
476
+
477
+
478
+
479
+
480
+
481
+ <h4 class="name" id="registerSocketIOMiddleware"><span class="type-signature"></span>registerSocketIOMiddleware<span class="signature">()</span><span class="type-signature"></span></h4>
482
+
483
+
484
+
485
+
486
+
487
+
488
+ <div class="description">
489
+ Get Socket IO middle ware
490
+ </div>
491
+
492
+
493
+
494
+
495
+
496
+
497
+
498
+
499
+
500
+
501
+
502
+
503
+
504
+ <dl class="details">
505
+
506
+
507
+
508
+
509
+
510
+
511
+
512
+
513
+
514
+
515
+
516
+
517
+
518
+
519
+
520
+
521
+
522
+
523
+
524
+
525
+
526
+
527
+
528
+
529
+
530
+
531
+ <dt class="tag-source">Source:</dt>
532
+ <dd class="tag-source"><ul class="dummy"><li>
533
+ <a href="falcon.js.html">falcon.js</a>, <a href="falcon.js.html#line306">line 306</a>
534
+ </li></ul></dd>
535
+
536
+
537
+
538
+
539
+
540
+
541
+
542
+ </dl>
543
+
544
+
545
+
546
+
547
+
548
+
549
+
550
+
551
+
552
+
553
+
554
+
555
+
556
+
557
+
558
+ <h5>Returns:</h5>
559
+
560
+
561
+ <div class="param-desc">
562
+ context
563
+ </div>
564
+
565
+
566
+
567
+
568
+
569
+
570
+
571
+
572
+
573
+
574
+
575
+
576
+
577
+
578
+
579
+ <h4 class="name" id="runServer"><span class="type-signature">(async) </span>runServer<span class="signature">()</span><span class="type-signature"></span></h4>
580
+
581
+
582
+
583
+
584
+
585
+
586
+ <div class="description">
587
+ Starts the server
588
+ </div>
589
+
590
+
591
+
592
+
593
+
594
+
595
+
596
+
597
+
598
+
599
+
600
+
601
+
602
+ <dl class="details">
603
+
604
+
605
+
606
+
607
+
608
+
609
+
610
+
611
+
612
+
613
+
614
+
615
+
616
+
617
+
618
+
619
+
620
+
621
+
622
+
623
+
624
+
625
+
626
+
627
+
628
+
629
+ <dt class="tag-source">Source:</dt>
630
+ <dd class="tag-source"><ul class="dummy"><li>
631
+ <a href="falcon.js.html">falcon.js</a>, <a href="falcon.js.html#line281">line 281</a>
632
+ </li></ul></dd>
633
+
634
+
635
+
636
+
637
+
638
+
639
+
640
+ </dl>
641
+
642
+
643
+
644
+
645
+
646
+
647
+
648
+
649
+
650
+
651
+
652
+
653
+
654
+
655
+
656
+
657
+
658
+
659
+
660
+
661
+
662
+
663
+
664
+
665
+
666
+
667
+ <h4 class="name" id="validateAuth"><span class="type-signature">(async) </span>validateAuth<span class="signature">()</span><span class="type-signature"></span></h4>
668
+
669
+
670
+
671
+
672
+
673
+
674
+ <div class="description">
675
+ Handler for auth validation
676
+ </div>
677
+
678
+
679
+
680
+
681
+
682
+
683
+
684
+
685
+
686
+
687
+
688
+
689
+
690
+ <dl class="details">
691
+
692
+
693
+
694
+
695
+
696
+
697
+
698
+
699
+
700
+
701
+
702
+
703
+
704
+
705
+
706
+
707
+
708
+
709
+
710
+
711
+
712
+
713
+
714
+
715
+
716
+
717
+ <dt class="tag-source">Source:</dt>
718
+ <dd class="tag-source"><ul class="dummy"><li>
719
+ <a href="falcon.js.html">falcon.js</a>, <a href="falcon.js.html#line330">line 330</a>
720
+ </li></ul></dd>
721
+
722
+
723
+
724
+
725
+
726
+
727
+
728
+ </dl>
729
+
730
+
731
+
732
+
733
+
734
+
735
+
736
+
737
+
738
+
739
+
740
+
741
+
742
+
743
+
744
+
745
+
746
+
747
+
748
+
749
+
750
+
751
+
752
+
753
+
754
+
755
+ </article>
756
+
757
+ </section>
758
+
759
+
760
+
761
+
762
+ </div>
763
+
764
+ <nav>
765
+ <h2><a href="index.html">Home</a></h2><h3>Classes</h3><ul><li><a href="Falcon.html">Falcon</a></li></ul>
766
+ </nav>
767
+
768
+ <br class="clear">
769
+
770
+ <footer>
771
+ Documentation generated by <a href="https://github.com/jsdoc/jsdoc">JSDoc 4.0.5</a> on Sun Oct 19 2025 12:00:49 GMT+0530 (India Standard Time)
772
+ </footer>
773
+
774
+ <script> prettyPrint(); </script>
775
+ <script src="scripts/linenumber.js"> </script>
776
+ </body>
777
+ </html>