w-web-task 1.0.31 → 1.0.33

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.
@@ -29,7 +29,7 @@
29
29
  <nav >
30
30
 
31
31
 
32
- <h2><a href="index.html">Home</a></h2><h3>Classes</h3><ul><li><a href="WWebTask.html">WWebTask</a></li></ul><h3>Global</h3><ul><li><a href="global.html#createLockSave">createLockSave</a></li><li><a href="global.html#describeUpstream">describeUpstream</a></li><li><a href="global.html#maskQuery">maskQuery</a></li><li><a href="global.html#maskTok">maskTok</a></li><li><a href="global.html#maskUrl">maskUrl</a></li><li><a href="global.html#submitGuard">submitGuard</a></li><li><a href="global.html#wrapInjected">wrapInjected</a></li></ul>
32
+ <h2><a href="index.html">Home</a></h2><h3>Classes</h3><ul><li><a href="WWebTask.html">WWebTask</a></li></ul><h3>Global</h3><ul><li><a href="global.html#createAuthorizeExec">createAuthorizeExec</a></li><li><a href="global.html#createLockSave">createLockSave</a></li><li><a href="global.html#describeUpstream">describeUpstream</a></li><li><a href="global.html#maskQuery">maskQuery</a></li><li><a href="global.html#maskTok">maskTok</a></li><li><a href="global.html#maskUrl">maskUrl</a></li><li><a href="global.html#submitGuard">submitGuard</a></li><li><a href="global.html#wrapInjected">wrapInjected</a></li></ul>
33
33
 
34
34
  </nav>
35
35
 
@@ -80,7 +80,7 @@
80
80
 
81
81
  <dt class="tag-source">Source:</dt>
82
82
  <dd class="tag-source"><ul class="dummy"><li>
83
- <a href="server_WWebTask.mjs.html">server/WWebTask.mjs</a>, <a href="server_WWebTask.mjs.html#line48">line 48</a>
83
+ <a href="server_WWebTask.mjs.html">server/WWebTask.mjs</a>, <a href="server_WWebTask.mjs.html#line62">line 62</a>
84
84
  </li></ul></dd>
85
85
 
86
86
 
@@ -329,7 +329,7 @@
329
329
  </td>
330
330
 
331
331
 
332
- <td class="description last"><p>輸入驗證瀏覽使用者身份之處理函數,函數會傳入使用者資訊物件,通過此函數識別後回傳布林值,允許使用者回傳true,反之回傳false</p></td>
332
+ <td class="description last"><p>輸入驗證瀏覽使用者身份之處理函數,函數會傳入使用者資訊物件與來源字串(from),通過此函數識別後回傳布林值,允許使用者回傳true,反之回傳false。作用於登入檢查(/api/getUserByToken,from為'getUserByToken')與前端資料通道之每次請求(連線閘,from為w-converhp之apiType如'main'),兩者同一判定;拋錯或reject視同不允許</p></td>
333
333
  </tr>
334
334
 
335
335
 
@@ -365,7 +365,7 @@
365
365
  </td>
366
366
 
367
367
 
368
- <td class="description last"><p>輸入驗證應用程序使用者身份之處理函數,函數會傳入使用者資訊物件,通過此函數識別後回傳布林值,允許使用者回傳true,反之回傳false</p></td>
368
+ <td class="description last"><p>輸入驗證應用程序使用者身份之處理函數,函數會傳入使用者資訊物件與來源字串(from,為API名稱),通過此函數識別後回傳布林值,允許使用者回傳true,反之回傳false。作用於對外HTTP REST API(agent面);拋錯或reject視同不允許</p></td>
369
369
  </tr>
370
370
 
371
371
 
@@ -472,6 +472,447 @@
472
472
  </tr>
473
473
 
474
474
 
475
+
476
+ <tr>
477
+
478
+ <td class="name"><code>subfolder</code></td>
479
+
480
+
481
+ <td class="type">
482
+
483
+
484
+ <span class="param-type">String</span>
485
+
486
+
487
+
488
+
489
+ </td>
490
+
491
+
492
+ <td class="attributes">
493
+
494
+ &lt;optional><br>
495
+
496
+
497
+
498
+
499
+
500
+ </td>
501
+
502
+
503
+
504
+ <td class="default">
505
+
506
+ <code>''</code>
507
+
508
+ </td>
509
+
510
+
511
+ <td class="description last"><p>輸入網站子目錄字串,例如'mtask',預設''</p></td>
512
+ </tr>
513
+
514
+
515
+
516
+ <tr>
517
+
518
+ <td class="name"><code>urlRedirect</code></td>
519
+
520
+
521
+ <td class="type">
522
+
523
+
524
+ <span class="param-type">String</span>
525
+
526
+
527
+
528
+
529
+ </td>
530
+
531
+
532
+ <td class="attributes">
533
+
534
+ &lt;optional><br>
535
+
536
+
537
+
538
+
539
+
540
+ </td>
541
+
542
+
543
+
544
+ <td class="default">
545
+
546
+ <code>''</code>
547
+
548
+ </td>
549
+
550
+
551
+ <td class="description last"><p>輸入未登入時導向之網址字串(例如SSO登入頁),預設''</p></td>
552
+ </tr>
553
+
554
+
555
+
556
+ <tr>
557
+
558
+ <td class="name"><code>showLanguage</code></td>
559
+
560
+
561
+ <td class="type">
562
+
563
+
564
+ <span class="param-type">String</span>
565
+
566
+
567
+
568
+
569
+ </td>
570
+
571
+
572
+ <td class="attributes">
573
+
574
+ &lt;optional><br>
575
+
576
+
577
+
578
+
579
+
580
+ </td>
581
+
582
+
583
+
584
+ <td class="default">
585
+
586
+ <code>'y'</code>
587
+
588
+ </td>
589
+
590
+
591
+ <td class="description last"><p>輸入是否顯示語系選單字串,可選'y'、'n',預設'y'</p></td>
592
+ </tr>
593
+
594
+
595
+
596
+ <tr>
597
+
598
+ <td class="name"><code>language</code></td>
599
+
600
+
601
+ <td class="type">
602
+
603
+
604
+ <span class="param-type">String</span>
605
+
606
+
607
+
608
+
609
+ </td>
610
+
611
+
612
+ <td class="attributes">
613
+
614
+ &lt;optional><br>
615
+
616
+
617
+
618
+
619
+
620
+ </td>
621
+
622
+
623
+
624
+ <td class="default">
625
+
626
+ <code>'eng'</code>
627
+
628
+ </td>
629
+
630
+
631
+ <td class="description last"><p>輸入初始語系字串,可選'eng'、'cht',預設'eng'</p></td>
632
+ </tr>
633
+
634
+
635
+
636
+ <tr>
637
+
638
+ <td class="name"><code>webName</code></td>
639
+
640
+
641
+ <td class="type">
642
+
643
+
644
+ <span class="param-type">Object</span>
645
+
646
+
647
+
648
+
649
+ </td>
650
+
651
+
652
+ <td class="attributes">
653
+
654
+ &lt;optional><br>
655
+
656
+
657
+
658
+
659
+
660
+ </td>
661
+
662
+
663
+
664
+ <td class="default">
665
+
666
+ <code>{}</code>
667
+
668
+ </td>
669
+
670
+
671
+ <td class="description last"><p>輸入網站名稱物件,key為語系而值為字串,預設{}</p></td>
672
+ </tr>
673
+
674
+
675
+
676
+ <tr>
677
+
678
+ <td class="name"><code>webDescription</code></td>
679
+
680
+
681
+ <td class="type">
682
+
683
+
684
+ <span class="param-type">Object</span>
685
+
686
+
687
+
688
+
689
+ </td>
690
+
691
+
692
+ <td class="attributes">
693
+
694
+ &lt;optional><br>
695
+
696
+
697
+
698
+
699
+
700
+ </td>
701
+
702
+
703
+
704
+ <td class="default">
705
+
706
+ <code>{}</code>
707
+
708
+ </td>
709
+
710
+
711
+ <td class="description last"><p>輸入網站說明物件,key為語系而值為字串,預設{}</p></td>
712
+ </tr>
713
+
714
+
715
+
716
+ <tr>
717
+
718
+ <td class="name"><code>webLogo</code></td>
719
+
720
+
721
+ <td class="type">
722
+
723
+
724
+ <span class="param-type">String</span>
725
+
726
+
727
+
728
+
729
+ </td>
730
+
731
+
732
+ <td class="attributes">
733
+
734
+ &lt;optional><br>
735
+
736
+
737
+
738
+
739
+
740
+ </td>
741
+
742
+
743
+
744
+ <td class="default">
745
+
746
+ <code>''</code>
747
+
748
+ </td>
749
+
750
+
751
+ <td class="description last"><p>輸入網站logo字串,預設''</p></td>
752
+ </tr>
753
+
754
+
755
+
756
+ <tr>
757
+
758
+ <td class="name"><code>kpLangExt</code></td>
759
+
760
+
761
+ <td class="type">
762
+
763
+
764
+ <span class="param-type">Object</span>
765
+
766
+
767
+
768
+
769
+ </td>
770
+
771
+
772
+ <td class="attributes">
773
+
774
+ &lt;optional><br>
775
+
776
+
777
+
778
+
779
+
780
+ </td>
781
+
782
+
783
+
784
+ <td class="default">
785
+
786
+ <code>{}</code>
787
+
788
+ </td>
789
+
790
+
791
+ <td class="description last"><p>輸入擴充語系物件,預設{}</p></td>
792
+ </tr>
793
+
794
+
795
+
796
+ <tr>
797
+
798
+ <td class="name"><code>logFd</code></td>
799
+
800
+
801
+ <td class="type">
802
+
803
+
804
+ <span class="param-type">String</span>
805
+
806
+
807
+
808
+
809
+ </td>
810
+
811
+
812
+ <td class="attributes">
813
+
814
+ &lt;optional><br>
815
+
816
+
817
+
818
+
819
+
820
+ </td>
821
+
822
+
823
+
824
+ <td class="default">
825
+
826
+ <code>'./logs'</code>
827
+
828
+ </td>
829
+
830
+
831
+ <td class="description last"><p>輸入後端log資料夾字串,相對路徑以建構時之工作目錄解析,資料夾不可建立時(例如上層為檔案)於建構時拋錯(w-syslog 1.0.33起;於資料庫建立之前),預設'./logs'</p></td>
832
+ </tr>
833
+
834
+
835
+
836
+ <tr>
837
+
838
+ <td class="name"><code>logInterval</code></td>
839
+
840
+
841
+ <td class="type">
842
+
843
+
844
+ <span class="param-type">String</span>
845
+
846
+
847
+
848
+
849
+ </td>
850
+
851
+
852
+ <td class="attributes">
853
+
854
+ &lt;optional><br>
855
+
856
+
857
+
858
+
859
+
860
+ </td>
861
+
862
+
863
+
864
+ <td class="default">
865
+
866
+ <code>'hr'</code>
867
+
868
+ </td>
869
+
870
+
871
+ <td class="description last"><p>輸入後端log分檔模式字串,可選'day'、'hr',預設'hr'</p></td>
872
+ </tr>
873
+
874
+
875
+
876
+ <tr>
877
+
878
+ <td class="name"><code>archiveAfterDays</code></td>
879
+
880
+
881
+ <td class="type">
882
+
883
+
884
+ <span class="param-type">Integer</span>
885
+
886
+
887
+
888
+
889
+ </td>
890
+
891
+
892
+ <td class="attributes">
893
+
894
+ &lt;optional><br>
895
+
896
+
897
+
898
+
899
+
900
+ </td>
901
+
902
+
903
+
904
+ <td class="default">
905
+
906
+ <code>30</code>
907
+
908
+ </td>
909
+
910
+
911
+ <td class="description last"><p>輸入終態任務與舊訊息逾此天數搬至冷表之天數,小於等於0為停用,預設30
912
+ 已移除之設定:useCheckUser、getUserById、useExcludeWhenNotAdmin(w-serv-orm已移除),給予undefined、null、false以外之值即於建構時拋錯(於任何副作用之前)</p></td>
913
+ </tr>
914
+
915
+
475
916
  </tbody>
476
917
  </table>
477
918
 
@@ -501,7 +942,7 @@
501
942
 
502
943
 
503
944
  <div class="param-desc">
504
- <p>回傳物件,其內server為hapi伺服器實體</p>
945
+ <p>回傳w-serv-hapi之伺服器事件物件,可監聽error事件;w-serv-hapi 1.1.6起另帶ready與stop,惟stop只停止伺服器與其下游,不釋放本套件之計時器(封存掃描、雙擊防護占位)與資料庫連線,本套件以結束行程收尾</p>
505
946
  </div>
506
947
 
507
948
 
@@ -560,7 +1001,7 @@
560
1001
  <br class="clear">
561
1002
 
562
1003
  <footer>
563
- Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 4.0.5</a> on Sun Oct 11 2026 01:55:28 GMT+0800 (台北標準時間) using the <a href="https://github.com/clenemt/docdash">docdash</a> theme.
1004
+ Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 4.0.5</a> on Wed Oct 14 2026 08:01:17 GMT+0800 (台北標準時間) using the <a href="https://github.com/clenemt/docdash">docdash</a> theme.
564
1005
  </footer>
565
1006
 
566
1007
  <script>prettyPrint();</script>