-
Notifications
You must be signed in to change notification settings - Fork 0
Expand file tree
/
Copy pathmodule-queue.html
More file actions
826 lines (217 loc) · 45.6 KB
/
Copy pathmodule-queue.html
File metadata and controls
826 lines (217 loc) · 45.6 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
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
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
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
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
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
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
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
444
445
446
447
448
449
450
451
452
453
454
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
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
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
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
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
630
631
632
633
634
635
636
637
638
639
640
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
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
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
718
719
720
721
722
723
724
725
726
727
728
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
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
<!DOCTYPE html>
<html lang="en">
<head>
<meta charset="utf-8">
<title>queue - Documentation</title>
<script src="scripts/prettify/prettify.js"></script>
<script src="scripts/prettify/lang-css.js"></script>
<!--[if lt IE 9]>
<script src="//html5shiv.googlecode.com/svn/trunk/html5.js"></script>
<![endif]-->
<link type="text/css" rel="stylesheet" href="styles/prettify.css">
<link type="text/css" rel="stylesheet" href="styles/jsdoc.css">
<script src="scripts/nav.js" defer></script>
<meta name="viewport" content="width=device-width, initial-scale=1.0">
</head>
<body>
<input type="checkbox" id="nav-trigger" class="nav-trigger" />
<label for="nav-trigger" class="navicon-button x">
<div class="navicon"></div>
</label>
<label for="nav-trigger" class="overlay"></label>
<nav >
<h2><a href="index.html">Home</a></h2><h3>Classes</h3><ul><li><a href="module-dashboard-Dashboard.html">Dashboard</a><ul class='methods'><li data-type='method'><a href="module-dashboard-Dashboard.html#renderChart">renderChart</a></li><li data-type='method'><a href="module-dashboard-Dashboard.html#toBuffer">toBuffer</a></li><li data-type='method'><a href="module-dashboard-Dashboard.html#toDataURL">toDataURL</a></li></ul></li><li><a href="module-engine_isolation_fake_http-FakeIncomingMessage.html">FakeIncomingMessage</a></li><li><a href="module-engine_isolation_fake_http-FakeServerResponse.html">FakeServerResponse</a><ul class='methods'><li data-type='method'><a href="module-engine_isolation_fake_http-FakeServerResponse.html#toResult">toResult</a></li></ul></li><li><a href="module-engine_websocket_fanout-RedisFanout.html">RedisFanout</a><ul class='methods'><li data-type='method'><a href="module-engine_websocket_fanout-RedisFanout.html#publishApp">publishApp</a></li><li data-type='method'><a href="module-engine_websocket_fanout-RedisFanout.html#publishRoom">publishRoom</a></li><li data-type='method'><a href="module-engine_websocket_fanout-RedisFanout.html#start">start</a></li></ul></li><li><a href="module-image-ImageProcessor.html">ImageProcessor</a><ul class='methods'><li data-type='method'><a href="module-image-ImageProcessor.html#blur">blur</a></li><li data-type='method'><a href="module-image-ImageProcessor.html#composite">composite</a></li><li data-type='method'><a href="module-image-ImageProcessor.html#flip">flip</a></li><li data-type='method'><a href="module-image-ImageProcessor.html#flop">flop</a></li><li data-type='method'><a href="module-image-ImageProcessor.html#format">format</a></li><li data-type='method'><a href="module-image-ImageProcessor.html#greyscale">greyscale</a></li><li data-type='method'><a href="module-image-ImageProcessor.html#resize">resize</a></li><li data-type='method'><a href="module-image-ImageProcessor.html#rotate">rotate</a></li><li data-type='method'><a href="module-image-ImageProcessor.html#sharpen">sharpen</a></li><li data-type='method'><a href="module-image-ImageProcessor.html#toBuffer">toBuffer</a></li><li data-type='method'><a href="module-image-ImageProcessor.html#toFile">toFile</a></li></ul></li><li><a href="module-scheduler_coordination-RedisCoordinator.html">RedisCoordinator</a><ul class='methods'><li data-type='method'><a href="module-scheduler_coordination-RedisCoordinator.html#tryAllowRun">tryAllowRun</a></li></ul></li></ul><h3>Modules</h3><ul><li><a href="module-ai.html">ai</a><ul class='methods'><li data-type='method'><a href="module-ai.html#.chat">chat</a></li><li data-type='method'><a href="module-ai.html#.chatStream">chatStream</a></li><li data-type='method'><a href="module-ai.html#.complete">complete</a></li><li data-type='method'><a href="module-ai.html#.moderate">moderate</a></li><li data-type='method'><a href="module-ai.html#.parseDocument">parseDocument</a></li></ul></li><li><a href="module-audit.html">audit</a><ul class='methods'><li data-type='method'><a href="module-audit.html#~emit">emit</a></li><li data-type='method'><a href="module-audit.html#~initServer">initServer</a></li></ul></li><li><a href="module-auth.html">auth</a></li><li><a href="module-cache.html">cache</a><ul class='methods'><li data-type='method'><a href="module-cache.html#.clear">clear</a></li><li data-type='method'><a href="module-cache.html#.del">del</a></li><li data-type='method'><a href="module-cache.html#.get">get</a></li><li data-type='method'><a href="module-cache.html#.set">set</a></li></ul></li><li><a href="module-chart.html">chart</a><ul class='methods'><li data-type='method'><a href="module-chart.html#.registerFont">registerFont</a></li><li data-type='method'><a href="module-chart.html#.render">render</a></li></ul></li><li><a href="module-crypto.html">crypto</a><ul class='methods'><li data-type='method'><a href="module-crypto.html#.CRC32">CRC32</a></li><li data-type='method'><a href="module-crypto.html#.MD5">MD5</a></li><li data-type='method'><a href="module-crypto.html#.SHA2">SHA2</a></li><li data-type='method'><a href="module-crypto.html#.SHA3">SHA3</a></li><li data-type='method'><a href="module-crypto.html#.decrypt">decrypt</a></li><li data-type='method'><a href="module-crypto.html#.encrypt">encrypt</a></li><li data-type='method'><a href="module-crypto.html#.generateSecureRandomString">generateSecureRandomString</a></li><li data-type='method'><a href="module-crypto.html#.hashPassword">hashPassword</a></li><li data-type='method'><a href="module-crypto.html#.hmacSha256Encrypt">hmacSha256Encrypt</a></li><li data-type='method'><a href="module-crypto.html#.hmacSha256Verify">hmacSha256Verify</a></li><li data-type='method'><a href="module-crypto.html#.verifyPassword">verifyPassword</a></li></ul></li><li><a href="module-dashboard.html">dashboard</a><ul class='methods'><li data-type='method'><a href="module-dashboard.html#.init">init</a></li></ul></li><li><a href="module-db.html">db</a><ul class='methods'><li data-type='method'><a href="module-db.html#.execute">execute</a></li><li data-type='method'><a href="module-db.html#.query">query</a></li><li data-type='method'><a href="module-db.html#.transaction">transaction</a></li></ul></li><li><a href="module-egress.html">egress</a><ul class='methods'><li data-type='method'><a href="module-egress.html#~assertUrlAllowed">assertUrlAllowed</a></li><li data-type='method'><a href="module-egress.html#~assertUrlAllowedNoDns">assertUrlAllowedNoDns</a></li><li data-type='method'><a href="module-egress.html#~beforeRedirect">beforeRedirect</a></li><li data-type='method'><a href="module-egress.html#~classifyIp">classifyIp</a></li><li data-type='method'><a href="module-egress.html#~getMaxRedirects">getMaxRedirects</a></li><li data-type='method'><a href="module-egress.html#~initServer">initServer</a></li></ul></li><li><a href="module-email.html">email</a><ul class='methods'><li data-type='method'><a href="module-email.html#.send">send</a></li><li data-type='method'><a href="module-email.html#.sendWithConfig">sendWithConfig</a></li></ul></li><li><a href="module-encode.html">encode</a></li><li><a href="module-engine_app_registry.html">engine/app_registry</a><ul class='methods'><li data-type='method'><a href="module-engine_app_registry.html#~initializeApps">initializeApps</a></li></ul></li><li><a href="module-engine_boot.html">engine/boot</a><ul class='methods'><li data-type='method'><a href="module-engine_boot.html#~startServer">startServer</a></li></ul></li><li><a href="module-engine_config.html">engine/config</a><ul class='methods'><li data-type='method'><a href="module-engine_config.html#~applyHttpPortEnvOverride">applyHttpPortEnvOverride</a></li><li data-type='method'><a href="module-engine_config.html#~buildDefaultConfig">buildDefaultConfig</a></li><li data-type='method'><a href="module-engine_config.html#~loadConfig">loadConfig</a></li><li data-type='method'><a href="module-engine_config.html#~mergeUserConfig">mergeUserConfig</a></li></ul></li><li><a href="module-engine_http_servers.html">engine/http_servers</a><ul class='methods'><li data-type='method'><a href="module-engine_http_servers.html#~handleServerError">handleServerError</a></li><li data-type='method'><a href="module-engine_http_servers.html#~startHttpServers">startHttpServers</a></li></ul></li><li><a href="module-engine_isolation_fake_http.html">engine/isolation/fake_http</a></li><li><a href="module-engine_isolation_policy.html">engine/isolation/policy</a><ul class='methods'><li data-type='method'><a href="module-engine_isolation_policy.html#~appsForWorker">appsForWorker</a></li><li data-type='method'><a href="module-engine_isolation_policy.html#~resolveGroupId">resolveGroupId</a></li><li data-type='method'><a href="module-engine_isolation_policy.html#~resolveWorkerKey">resolveWorkerKey</a></li><li data-type='method'><a href="module-engine_isolation_policy.html#~restartDelayMs">restartDelayMs</a></li><li data-type='method'><a href="module-engine_isolation_policy.html#~shouldIsolateApp">shouldIsolateApp</a></li></ul></li><li><a href="module-engine_isolation_resource_limits.html">engine/isolation/resource_limits</a><ul class='methods'><li data-type='method'><a href="module-engine_isolation_resource_limits.html#~applyAfterSpawn">applyAfterSpawn</a></li><li data-type='method'><a href="module-engine_isolation_resource_limits.html#~applyRssLimit">applyRssLimit</a></li><li data-type='method'><a href="module-engine_isolation_resource_limits.html#~buildWorkerEnv">buildWorkerEnv</a></li><li data-type='method'><a href="module-engine_isolation_resource_limits.html#~describeLimits">describeLimits</a></li><li data-type='method'><a href="module-engine_isolation_resource_limits.html#~mergeNodeOptions">mergeNodeOptions</a></li><li data-type='method'><a href="module-engine_isolation_resource_limits.html#~normalizePriority">normalizePriority</a></li><li data-type='method'><a href="module-engine_isolation_resource_limits.html#~normalizeWorkerLimits">normalizeWorkerLimits</a></li><li data-type='method'><a href="module-engine_isolation_resource_limits.html#~positiveOrNull">positiveOrNull</a></li><li data-type='method'><a href="module-engine_isolation_resource_limits.html#~priorityToOsValue">priorityToOsValue</a></li></ul></li><li><a href="module-engine_isolation_worker_manager.html">engine/isolation/worker_manager</a><ul class='methods'><li data-type='method'><a href="module-engine_isolation_worker_manager.html#~buildInitPayload">buildInitPayload</a></li><li data-type='method'><a href="module-engine_isolation_worker_manager.html#~ensureWorker">ensureWorker</a></li><li data-type='method'><a href="module-engine_isolation_worker_manager.html#~executeOnWorker">executeOnWorker</a></li><li data-type='method'><a href="module-engine_isolation_worker_manager.html#~init">init</a></li><li data-type='method'><a href="module-engine_isolation_worker_manager.html#~maybeResetRestarts">maybeResetRestarts</a></li><li data-type='method'><a href="module-engine_isolation_worker_manager.html#~onWorkerMessage">onWorkerMessage</a></li><li data-type='method'><a href="module-engine_isolation_worker_manager.html#~readRequestBody">readRequestBody</a></li><li data-type='method'><a href="module-engine_isolation_worker_manager.html#~rememberApp">rememberApp</a></li><li data-type='method'><a href="module-engine_isolation_worker_manager.html#~scheduleAutoRestart">scheduleAutoRestart</a></li><li data-type='method'><a href="module-engine_isolation_worker_manager.html#~setAppsRegistry">setAppsRegistry</a></li><li data-type='method'><a href="module-engine_isolation_worker_manager.html#~startWorker">startWorker</a></li><li data-type='method'><a href="module-engine_isolation_worker_manager.html#~stopWorker">stopWorker</a></li><li data-type='method'><a href="module-engine_isolation_worker_manager.html#~stopWorkerByKey">stopWorkerByKey</a></li></ul></li><li><a href="module-engine_logger_setup.html">engine/logger_setup</a><ul class='methods'><li data-type='method'><a href="module-engine_logger_setup.html#~createServerLogger">createServerLogger</a></li></ul></li><li><a href="module-engine_metrics_hooks.html">engine/metrics_hooks</a><ul class='methods'><li data-type='method'><a href="module-engine_metrics_hooks.html#~metricsScrapeHooks">metricsScrapeHooks</a></li></ul></li><li><a href="module-engine_paths.html">engine/paths</a><ul class='methods'><li data-type='method'><a href="module-engine_paths.html#~ensureProjectDirs">ensureProjectDirs</a></li><li data-type='method'><a href="module-engine_paths.html#~resolveWebPath">resolveWebPath</a></li></ul></li><li><a href="module-engine_queue_service.html">engine/queue_service</a><ul class='methods'><li data-type='method'><a href="module-engine_queue_service.html#~addJob">addJob</a></li><li data-type='method'><a href="module-engine_queue_service.html#~discardDlqJob">discardDlqJob</a></li><li data-type='method'><a href="module-engine_queue_service.html#~failOrRetry">failOrRetry</a></li><li data-type='method'><a href="module-engine_queue_service.html#~getAdminStats">getAdminStats</a></li><li data-type='method'><a href="module-engine_queue_service.html#~getDlqJob">getDlqJob</a></li><li data-type='method'><a href="module-engine_queue_service.html#~initServer">initServer</a></li><li data-type='method'><a href="module-engine_queue_service.html#~listDlq">listDlq</a></li><li data-type='method'><a href="module-engine_queue_service.html#~listLiveJobs">listLiveJobs</a></li><li data-type='method'><a href="module-engine_queue_service.html#~moveToDlq">moveToDlq</a></li><li data-type='method'><a href="module-engine_queue_service.html#~processOne">processOne</a></li><li data-type='method'><a href="module-engine_queue_service.html#~resolveJobScript">resolveJobScript</a></li><li data-type='method'><a href="module-engine_queue_service.html#~retryDlqJob">retryDlqJob</a></li><li data-type='method'><a href="module-engine_queue_service.html#~setAppsRegistry">setAppsRegistry</a></li></ul></li><li><a href="module-engine_request_execute_script.html">engine/request/execute_script</a><ul class='methods'><li data-type='method'><a href="module-engine_request_execute_script.html#~executeScript">executeScript</a></li><li data-type='method'><a href="module-engine_request_execute_script.html#~executeScriptLocal">executeScriptLocal</a></li><li data-type='method'><a href="module-engine_request_execute_script.html#~executeScriptRemote">executeScriptRemote</a></li></ul></li><li><a href="module-engine_request_resolve.html">engine/request/resolve</a><ul class='methods'><li data-type='method'><a href="module-engine_request_resolve.html#~applyDefaultAppRoute">applyDefaultAppRoute</a></li><li data-type='method'><a href="module-engine_request_resolve.html#~privilegeScope">privilegeScope</a></li><li data-type='method'><a href="module-engine_request_resolve.html#~rejectIfAppMissing">rejectIfAppMissing</a></li><li data-type='method'><a href="module-engine_request_resolve.html#~rejectIfMaintenance">rejectIfMaintenance</a></li><li data-type='method'><a href="module-engine_request_resolve.html#~resolveApp">resolveApp</a></li><li data-type='method'><a href="module-engine_request_resolve.html#~resolveScriptTarget">resolveScriptTarget</a></li></ul></li><li><a href="module-engine_request_script_runner.html">engine/request/script_runner</a><ul class='methods'><li data-type='method'><a href="module-engine_request_script_runner.html#~runServerScript">runServerScript</a></li></ul></li><li><a href="module-engine_request_spa.html">engine/request/spa</a><ul class='methods'><li data-type='method'><a href="module-engine_request_spa.html#~handleSpa">handleSpa</a></li></ul></li><li><a href="module-engine_request_static.html">engine/request/static</a><ul class='methods'><li data-type='method'><a href="module-engine_request_static.html#~serveDirectoryOr404">serveDirectoryOr404</a></li><li data-type='method'><a href="module-engine_request_static.html#~serveStaticFile">serveStaticFile</a></li></ul></li><li><a href="module-engine_request_context_body.html">engine/request_context/body</a><ul class='methods'><li data-type='method'><a href="module-engine_request_context_body.html#~parseBodyAndRunHandler">parseBodyAndRunHandler</a></li></ul></li><li><a href="module-engine_request_context_build_g.html">engine/request_context/build_g</a><ul class='methods'><li data-type='method'><a href="module-engine_request_context_build_g.html#~endStream">endStream</a></li><li data-type='method'><a href="module-engine_request_context_build_g.html#~initializeGContext">initializeGContext</a></li><li data-type='method'><a href="module-engine_request_context_build_g.html#~startStream">startStream</a></li><li data-type='method'><a href="module-engine_request_context_build_g.html#~write">write</a></li><li data-type='method'><a href="module-engine_request_context_build_g.html#~writeSSE">writeSSE</a></li></ul></li><li><a href="module-engine_request_context_parse_size.html">engine/request_context/parse_size</a><ul class='methods'><li data-type='method'><a href="module-engine_request_context_parse_size.html#~parseSize">parseSize</a></li></ul></li><li><a href="module-engine_request_handler.html">engine/request_handler</a><ul class='methods'><li data-type='method'><a href="module-engine_request_handler.html#~createRequestHandler">createRequestHandler</a></li></ul></li><li><a href="module-engine_websocket_fanout.html">engine/websocket_fanout</a><ul class='methods'><li data-type='method'><a href="module-engine_websocket_fanout.html#~createRedisClient">createRedisClient</a></li><li data-type='method'><a href="module-engine_websocket_fanout.html#~decodePayload">decodePayload</a></li><li data-type='method'><a href="module-engine_websocket_fanout.html#~encodePayload">encodePayload</a></li><li data-type='method'><a href="module-engine_websocket_fanout.html#~normalizeFanout">normalizeFanout</a></li><li data-type='method'><a href="module-engine_websocket_fanout.html#~normalizeRedis">normalizeRedis</a></li><li data-type='method'><a href="module-engine_websocket_fanout.html#~waitReady">waitReady</a></li></ul></li><li><a href="module-engine_websocket_hub.html">engine/websocket_hub</a><ul class='methods'><li data-type='method'><a href="module-engine_websocket_hub.html#~assertRoomTenant">assertRoomTenant</a></li><li data-type='method'><a href="module-engine_websocket_hub.html#~attachServer">attachServer</a></li><li data-type='method'><a href="module-engine_websocket_hub.html#~createFacade">createFacade</a></li><li data-type='method'><a href="module-engine_websocket_hub.html#~fullPathFor">fullPathFor</a></li><li data-type='method'><a href="module-engine_websocket_hub.html#~getActiveAppName">getActiveAppName</a></li><li data-type='method'><a href="module-engine_websocket_hub.html#~handleUpgrade">handleUpgrade</a></li><li data-type='method'><a href="module-engine_websocket_hub.html#~initServer">initServer</a></li><li data-type='method'><a href="module-engine_websocket_hub.html#~onConnection">onConnection</a></li><li data-type='method'><a href="module-engine_websocket_hub.html#~parseUpgradeUrl">parseUpgradeUrl</a></li><li data-type='method'><a href="module-engine_websocket_hub.html#~registerApp">registerApp</a></li><li data-type='method'><a href="module-engine_websocket_hub.html#~sendToApp">sendToApp</a></li><li data-type='method'><a href="module-engine_websocket_hub.html#~sendToRoom">sendToRoom</a></li><li data-type='method'><a href="module-engine_websocket_hub.html#~setAppsRegistry">setAppsRegistry</a></li><li data-type='method'><a href="module-engine_websocket_hub.html#~tenantRoom">tenantRoom</a></li><li data-type='method'><a href="module-engine_websocket_hub.html#~unregisterApp">unregisterApp</a></li></ul></li><li><a href="module-formdata.html">formdata</a><ul class='methods'><li data-type='method'><a href="module-formdata.html#.create">create</a></li></ul></li><li><a href="module-fs.html">fs</a><ul class='methods'><li data-type='method'><a href="module-fs.html#.appendFile">appendFile</a></li><li data-type='method'><a href="module-fs.html#.appendFileSync">appendFileSync</a></li><li data-type='method'><a href="module-fs.html#.copyDir">copyDir</a></li><li data-type='method'><a href="module-fs.html#.copyDirSync">copyDirSync</a></li><li data-type='method'><a href="module-fs.html#.copyFile">copyFile</a></li><li data-type='method'><a href="module-fs.html#.copyFileSync">copyFileSync</a></li><li data-type='method'><a href="module-fs.html#.deleteFile">deleteFile</a></li><li data-type='method'><a href="module-fs.html#.deleteFileSync">deleteFileSync</a></li><li data-type='method'><a href="module-fs.html#.exists">exists</a></li><li data-type='method'><a href="module-fs.html#.existsSync">existsSync</a></li><li data-type='method'><a href="module-fs.html#.mkdir">mkdir</a></li><li data-type='method'><a href="module-fs.html#.mkdirSync">mkdirSync</a></li><li data-type='method'><a href="module-fs.html#.moveDir">moveDir</a></li><li data-type='method'><a href="module-fs.html#.moveDirSync">moveDirSync</a></li><li data-type='method'><a href="module-fs.html#.moveFile">moveFile</a></li><li data-type='method'><a href="module-fs.html#.moveFileSync">moveFileSync</a></li><li data-type='method'><a href="module-fs.html#.readFile">readFile</a></li><li data-type='method'><a href="module-fs.html#.readFileSync">readFileSync</a></li><li data-type='method'><a href="module-fs.html#.readJSONSync">readJSONSync</a></li><li data-type='method'><a href="module-fs.html#.rmdir">rmdir</a></li><li data-type='method'><a href="module-fs.html#.rmdirSync">rmdirSync</a></li><li data-type='method'><a href="module-fs.html#.writeFile">writeFile</a></li><li data-type='method'><a href="module-fs.html#.writeFileSync">writeFileSync</a></li><li data-type='method'><a href="module-fs.html#.writeJSONSync">writeJSONSync</a></li></ul></li><li><a href="module-gingee.html">gingee</a></li><li><a href="module-html.html">html</a><ul class='methods'><li data-type='method'><a href="module-html.html#.fromFile">fromFile</a></li><li data-type='method'><a href="module-html.html#.fromFileSync">fromFileSync</a></li><li data-type='method'><a href="module-html.html#.fromString">fromString</a></li><li data-type='method'><a href="module-html.html#.fromUrl">fromUrl</a></li></ul></li><li><a href="module-httpclient.html">httpclient</a><ul class='methods'><li data-type='method'><a href="module-httpclient.html#.get">get</a></li><li data-type='method'><a href="module-httpclient.html#.post">post</a></li></ul></li><li><a href="module-image.html">image</a><ul class='methods'><li data-type='method'><a href="module-image.html#.loadFromBuffer">loadFromBuffer</a></li><li data-type='method'><a href="module-image.html#.loadFromFile">loadFromFile</a></li></ul></li><li><a href="module-limits.html">limits</a><ul class='methods'><li data-type='method'><a href="module-limits.html#~applyServerTimeouts">applyServerTimeouts</a></li><li data-type='method'><a href="module-limits.html#~attachRequestContext">attachRequestContext</a></li><li data-type='method'><a href="module-limits.html#~clearRequestTimers">clearRequestTimers</a></li><li data-type='method'><a href="module-limits.html#~initServer">initServer</a></li><li data-type='method'><a href="module-limits.html#~onStreamStart">onStreamStart</a></li><li data-type='method'><a href="module-limits.html#~releaseRequest">releaseRequest</a></li><li data-type='method'><a href="module-limits.html#~remainingRequestMs">remainingRequestMs</a></li><li data-type='method'><a href="module-limits.html#~resolveForApp">resolveForApp</a></li><li data-type='method'><a href="module-limits.html#~resolveOutboundTimeoutMs">resolveOutboundTimeoutMs</a></li><li data-type='method'><a href="module-limits.html#~touchStream">touchStream</a></li><li data-type='method'><a href="module-limits.html#~tryAcquireOutbound">tryAcquireOutbound</a></li><li data-type='method'><a href="module-limits.html#~tryAcquireRequest">tryAcquireRequest</a></li></ul></li><li><a href="module-log_viewer.html">log_viewer</a><ul class='methods'><li data-type='method'><a href="module-log_viewer.html#~appLogsDir">appLogsDir</a></li><li data-type='method'><a href="module-log_viewer.html#~clampLines">clampLines</a></li><li data-type='method'><a href="module-log_viewer.html#~isLogViewerQueryNoise">isLogViewerQueryNoise</a></li><li data-type='method'><a href="module-log_viewer.html#~lineMatchesFilters">lineMatchesFilters</a></li><li data-type='method'><a href="module-log_viewer.html#~listLogFiles">listLogFiles</a></li><li data-type='method'><a href="module-log_viewer.html#~parseLogLine">parseLogLine</a></li><li data-type='method'><a href="module-log_viewer.html#~readFileTail">readFileTail</a></li><li data-type='method'><a href="module-log_viewer.html#~readLogFile">readLogFile</a></li><li data-type='method'><a href="module-log_viewer.html#~resolveLogDir">resolveLogDir</a></li><li data-type='method'><a href="module-log_viewer.html#~resolveLogFile">resolveLogFile</a></li><li data-type='method'><a href="module-log_viewer.html#~serverLogsDir">serverLogsDir</a></li></ul></li><li><a href="module-metrics.html">metrics</a><ul class='methods'><li data-type='method'><a href="module-metrics.html#~authorizeRequest">authorizeRequest</a></li><li data-type='method'><a href="module-metrics.html#~inc">inc</a></li><li data-type='method'><a href="module-metrics.html#~initServer">initServer</a></li><li data-type='method'><a href="module-metrics.html#~isAllowedRemote">isAllowedRemote</a></li><li data-type='method'><a href="module-metrics.html#~observe">observe</a></li><li data-type='method'><a href="module-metrics.html#~recordHttpRequest">recordHttpRequest</a></li><li data-type='method'><a href="module-metrics.html#~refreshDynamicGauges">refreshDynamicGauges</a></li><li data-type='method'><a href="module-metrics.html#~renderPrometheus">renderPrometheus</a></li><li data-type='method'><a href="module-metrics.html#~setGauge">setGauge</a></li><li data-type='method'><a href="module-metrics.html#~statusClass">statusClass</a></li><li data-type='method'><a href="module-metrics.html#~tryHandleRequest">tryHandleRequest</a></li></ul></li><li><a href="module-pdf.html">pdf</a><ul class='methods'><li data-type='method'><a href="module-pdf.html#.create">create</a></li></ul></li><li><a href="module-platform.html">platform</a><ul class='methods'><li data-type='method'><a href="module-platform.html#.createAppDirectory">createAppDirectory</a></li><li data-type='method'><a href="module-platform.html#.deleteApp">deleteApp</a></li><li data-type='method'><a href="module-platform.html#.installApp">installApp</a></li><li data-type='method'><a href="module-platform.html#.installFromBackup">installFromBackup</a></li><li data-type='method'><a href="module-platform.html#.listApps">listApps</a></li><li data-type='method'><a href="module-platform.html#.listBackups">listBackups</a></li><li data-type='method'><a href="module-platform.html#.mockRollback">mockRollback</a></li><li data-type='method'><a href="module-platform.html#.mockUpgrade">mockUpgrade</a></li><li data-type='method'><a href="module-platform.html#.packageApp">packageApp</a></li><li data-type='method'><a href="module-platform.html#.readFile">readFile</a></li><li data-type='method'><a href="module-platform.html#.registerNewApp">registerNewApp</a></li><li data-type='method'><a href="module-platform.html#.reloadApp">reloadApp</a></li><li data-type='method'><a href="module-platform.html#.rollbackApp">rollbackApp</a></li><li data-type='method'><a href="module-platform.html#.unzipToApp">unzipToApp</a></li><li data-type='method'><a href="module-platform.html#.upgradeApp">upgradeApp</a></li><li data-type='method'><a href="module-platform.html#.writeFile">writeFile</a></li><li data-type='method'><a href="module-platform.html#.zipApp">zipApp</a></li><li data-type='method'><a href="module-platform.html#~analyzeAppBackup">analyzeAppBackup</a></li><li data-type='method'><a href="module-platform.html#~discardQueueDlqJob">discardQueueDlqJob</a></li><li data-type='method'><a href="module-platform.html#~getAppPermissions">getAppPermissions</a></li><li data-type='method'><a href="module-platform.html#~getQueueStats">getQueueStats</a></li><li data-type='method'><a href="module-platform.html#~getSchedulerStatus">getSchedulerStatus</a></li><li data-type='method'><a href="module-platform.html#~listLogFiles">listLogFiles</a></li><li data-type='method'><a href="module-platform.html#~listQueueDlq">listQueueDlq</a></li><li data-type='method'><a href="module-platform.html#~listQueueLiveJobs">listQueueLiveJobs</a></li><li data-type='method'><a href="module-platform.html#~listSchedulerJobs">listSchedulerJobs</a></li><li data-type='method'><a href="module-platform.html#~readLogFile">readLogFile</a></li><li data-type='method'><a href="module-platform.html#~removeAppPermissions">removeAppPermissions</a></li><li data-type='method'><a href="module-platform.html#~retryQueueDlqJob">retryQueueDlqJob</a></li><li data-type='method'><a href="module-platform.html#~runSchedulerJob">runSchedulerJob</a></li><li data-type='method'><a href="module-platform.html#~setAppPermissions">setAppPermissions</a></li></ul></li><li><a href="module-qrcode.html">qrcode</a><ul class='methods'><li data-type='method'><a href="module-qrcode.html#.barcode">barcode</a></li><li data-type='method'><a href="module-qrcode.html#.qrcode">qrcode</a></li></ul></li><li><a href="module-queue.html">queue</a><ul class='methods'><li data-type='method'><a href="module-queue.html#~add">add</a></li><li data-type='method'><a href="module-queue.html#~getStats">getStats</a></li><li data-type='method'><a href="module-queue.html#~isEnabled">isEnabled</a></li></ul></li><li><a href="module-scheduler.html">scheduler</a><ul class='methods'><li data-type='method'><a href="module-scheduler.html#~getAdminStatus">getAdminStatus</a></li><li data-type='method'><a href="module-scheduler.html#~initServer">initServer</a></li><li data-type='method'><a href="module-scheduler.html#~listJobs">listJobs</a></li><li data-type='method'><a href="module-scheduler.html#~registerApp">registerApp</a></li><li data-type='method'><a href="module-scheduler.html#~reinitApp">reinitApp</a></li><li data-type='method'><a href="module-scheduler.html#~runNow">runNow</a></li><li data-type='method'><a href="module-scheduler.html#~shutdown">shutdown</a></li><li data-type='method'><a href="module-scheduler.html#~unregisterApp">unregisterApp</a></li></ul></li><li><a href="module-scheduler_coordination.html">scheduler_coordination</a><ul class='methods'><li data-type='method'><a href="module-scheduler_coordination.html#~computeFireSlot">computeFireSlot</a></li><li data-type='method'><a href="module-scheduler_coordination.html#~createRedisClient">createRedisClient</a></li><li data-type='method'><a href="module-scheduler_coordination.html#~leaderKey">leaderKey</a></li><li data-type='method'><a href="module-scheduler_coordination.html#~normalizeCoordination">normalizeCoordination</a></li><li data-type='method'><a href="module-scheduler_coordination.html#~normalizeRedis">normalizeRedis</a></li><li data-type='method'><a href="module-scheduler_coordination.html#~tickLockKey">tickLockKey</a></li></ul></li><li><a href="module-secrets.html">secrets</a><ul class='methods'><li data-type='method'><a href="module-secrets.html#~initServer">initServer</a></li><li data-type='method'><a href="module-secrets.html#~isSecretRef">isSecretRef</a></li><li data-type='method'><a href="module-secrets.html#~resolveDeep">resolveDeep</a></li><li data-type='method'><a href="module-secrets.html#~resolveValue">resolveValue</a></li></ul></li><li><a href="module-utils.html">utils</a></li><li><a href="module-uuid.html">uuid</a><ul class='methods'><li data-type='method'><a href="module-uuid.html#.v4">v4</a></li><li data-type='method'><a href="module-uuid.html#.validate">validate</a></li></ul></li><li><a href="module-websockets.html">websockets</a><ul class='methods'><li data-type='method'><a href="module-websockets.html#~assertRoomTenant">assertRoomTenant</a></li><li data-type='method'><a href="module-websockets.html#~getConnectionCount">getConnectionCount</a></li><li data-type='method'><a href="module-websockets.html#~getRoomSize">getRoomSize</a></li><li data-type='method'><a href="module-websockets.html#~tenantRoom">tenantRoom</a></li><li data-type='method'><a href="module-websockets.html#~toApp">toApp</a></li><li data-type='method'><a href="module-websockets.html#~toRoom">toRoom</a></li></ul></li><li><a href="module-zip.html">zip</a><ul class='methods'><li data-type='method'><a href="module-zip.html#.unzip">unzip</a></li><li data-type='method'><a href="module-zip.html#.zip">zip</a></li><li data-type='method'><a href="module-zip.html#.zipToFile">zipToFile</a></li></ul></li></ul><h3>Namespaces</h3><ul><li><a href="module-auth.jwt.html">jwt</a><ul class='methods'><li data-type='method'><a href="module-auth.jwt.html#.create">create</a></li><li data-type='method'><a href="module-auth.jwt.html#.verify">verify</a></li></ul></li><li><a href="module-encode.base58.html">base58</a><ul class='methods'><li data-type='method'><a href="module-encode.base58.html#.decode">decode</a></li><li data-type='method'><a href="module-encode.base58.html#.encode">encode</a></li></ul></li><li><a href="module-encode.base64.html">base64</a><ul class='methods'><li data-type='method'><a href="module-encode.base64.html#.decode">decode</a></li><li data-type='method'><a href="module-encode.base64.html#.decodeUrl">decodeUrl</a></li><li data-type='method'><a href="module-encode.base64.html#.encode">encode</a></li><li data-type='method'><a href="module-encode.base64.html#.encodeUrl">encodeUrl</a></li></ul></li><li><a href="module-encode.hex.html">hex</a><ul class='methods'><li data-type='method'><a href="module-encode.hex.html#.decode">decode</a></li><li data-type='method'><a href="module-encode.hex.html#.encode">encode</a></li></ul></li><li><a href="module-encode.html.html">html</a><ul class='methods'><li data-type='method'><a href="module-encode.html.html#.decode">decode</a></li><li data-type='method'><a href="module-encode.html.html#.encode">encode</a></li></ul></li><li><a href="module-encode.uri.html">uri</a><ul class='methods'><li data-type='method'><a href="module-encode.uri.html#.decode">decode</a></li><li data-type='method'><a href="module-encode.uri.html#.encode">encode</a></li></ul></li><li><a href="module-utils.misc.html">misc</a><ul class='methods'><li data-type='method'><a href="module-utils.misc.html#.clamp">clamp</a></li><li data-type='method'><a href="module-utils.misc.html#.groupBy">groupBy</a></li></ul></li><li><a href="module-utils.rnd.html">rnd</a><ul class='methods'><li data-type='method'><a href="module-utils.rnd.html#.bool">bool</a></li><li data-type='method'><a href="module-utils.rnd.html#.choice">choice</a></li><li data-type='method'><a href="module-utils.rnd.html#.color">color</a></li><li data-type='method'><a href="module-utils.rnd.html#.float">float</a></li><li data-type='method'><a href="module-utils.rnd.html#.floatInRange">floatInRange</a></li><li data-type='method'><a href="module-utils.rnd.html#.int">int</a></li><li data-type='method'><a href="module-utils.rnd.html#.intInRange">intInRange</a></li><li data-type='method'><a href="module-utils.rnd.html#.shuffle">shuffle</a></li><li data-type='method'><a href="module-utils.rnd.html#.string">string</a></li></ul></li><li><a href="module-utils.string.html">string</a><ul class='methods'><li data-type='method'><a href="module-utils.string.html#.capitalize">capitalize</a></li><li data-type='method'><a href="module-utils.string.html#.slugify">slugify</a></li><li data-type='method'><a href="module-utils.string.html#.stripHtml">stripHtml</a></li><li data-type='method'><a href="module-utils.string.html#.truncate">truncate</a></li></ul></li></ul><h3>Global</h3><ul><li><a href="global.html#FORBIDDEN_BUILTINS">FORBIDDEN_BUILTINS</a></li><li><a href="global.html#Redis">Redis</a></li><li><a href="global.html#createMemoryDriver">createMemoryDriver</a></li><li><a href="global.html#createRedisDriver">createRedisDriver</a></li><li><a href="global.html#deadLetter">deadLetter</a></li><li><a href="global.html#fail">fail</a></li><li><a href="global.html#init">init</a></li><li><a href="global.html#isPathInside">isPathInside</a></li><li><a href="global.html#listPending">listPending</a></li><li><a href="global.html#loadJsonFile">loadJsonFile</a></li><li><a href="global.html#loadOptional">loadOptional</a></li><li><a href="global.html#path">path</a></li><li><a href="global.html#pendingCounts">pendingCounts</a></li><li><a href="global.html#requireOptional">requireOptional</a></li><li><a href="global.html#resolveRedisConnection">resolveRedisConnection</a></li><li><a href="global.html#retryDlq">retryDlq</a></li><li><a href="global.html#runHttpScript">runHttpScript</a></li><li><a href="global.html#waitForResponseSettle">waitForResponseSettle</a></li><li><a href="global.html#workerState">workerState</a></li></ul>
</nav>
<div id="main">
<h1 class="page-title">queue</h1>
<section>
<header>
</header>
<article>
<div class="container-overview">
<div class="description usertext">Background job queue for Gingee apps.
Enqueue work from server scripts; handlers live under <code>box/jobs/</code>
(or paths mapped in <code>app.json</code> → <code>queue.jobs</code>).
<b>Server:</b> <code>gingee.json</code> → <code>queue</code> (driver <code>memory</code> or <code>redis</code>).
<b>IMPORTANT:</b> Requires the <code>queue</code> permission.</div>
<dl class="details">
<dt class="tag-description">Description:</dt>
<dd class="tag-description"><ul class="dummy"><li>Background job queue for Gingee apps.
Enqueue work from server scripts; handlers live under <code>box/jobs/</code>
(or paths mapped in <code>app.json</code> → <code>queue.jobs</code>).
<b>Server:</b> <code>gingee.json</code> → <code>queue</code> (driver <code>memory</code> or <code>redis</code>).
<b>IMPORTANT:</b> Requires the <code>queue</code> permission.</li></ul></dd>
</dl>
<h5 class="h5-examples">Examples</h5>
<pre class="prettyprint"><code>const queue = require('queue');
await queue.add('send-welcome', { userId: 42 });
// box/jobs/send-welcome.js runs later</code></pre>
<pre class="prettyprint"><code>// Job handler (box/jobs/send-welcome.js)
module.exports = async function () {
await gingee(async ($g) => {
const { payload, attempt } = $g.queue;
// ...
});
};</code></pre>
</div>
<h3 class="subsection-title">Methods</h3>
<h4 class="name" id="~add"><span class="type-signature type-signature-async, inner">(async, inner) </span>add<span class="signature">(name, payload<span class="signature-attributes">opt</span>, options<span class="signature-attributes">opt</span>)</span><span class="type-signature"> → {Promise.<{id: string, name: string, appName: string}>}</span></h4>
<dl class="details">
<dt class="tag-description">Description:</dt>
<dd class="tag-description"><ul class="dummy"><li>Enqueue a background job for the current app.</li></ul></dd>
</dl>
<h5 class="h5-parameters">Parameters:</h5>
<table class="params">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th>Attributes</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>name</code></td>
<td class="type">
<span class="param-type">string</span>
</td>
<td class="attributes">
</td>
<td class="description last">Job name (maps to box/jobs/{name}.js by default)</td>
</tr>
<tr>
<td class="name"><code>payload</code></td>
<td class="type">
<span class="param-type">*</span>
</td>
<td class="attributes">
<optional><br>
</td>
<td class="description last">JSON-serializable data for the handler ($g.queue.payload)</td>
</tr>
<tr>
<td class="name"><code>options</code></td>
<td class="type">
<span class="param-type">object</span>
</td>
<td class="attributes">
<optional><br>
</td>
<td class="description last">
<h6>Properties</h6>
<table class="params">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th>Attributes</th>
<th>Default</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>delayMs</code></td>
<td class="type">
<span class="param-type">number</span>
</td>
<td class="attributes">
<optional><br>
</td>
<td class="default">
<code>0</code>
</td>
<td class="description last">Delay before first run</td>
</tr>
<tr>
<td class="name"><code>attempts</code></td>
<td class="type">
<span class="param-type">number</span>
</td>
<td class="attributes">
<optional><br>
</td>
<td class="default">
</td>
<td class="description last">Max attempts (default server queue.default_attempts)</td>
</tr>
<tr>
<td class="name"><code>backoffMs</code></td>
<td class="type">
<span class="param-type">number</span>
</td>
<td class="attributes">
<optional><br>
</td>
<td class="default">
</td>
<td class="description last">Base backoff between retries</td>
</tr>
<tr>
<td class="name"><code>script</code></td>
<td class="type">
<span class="param-type">string</span>
</td>
<td class="attributes">
<optional><br>
</td>
<td class="default">
</td>
<td class="description last">Override script path relative to box/</td>
</tr>
</tbody>
</table>
</td>
</tr>
</tbody>
</table>
<h5 class="h5-returns">Returns:</h5>
<dl class="param-type">
<dt>
Type
</dt>
<dd>
<span class="param-type">Promise.<{id: string, name: string, appName: string}></span>
</dd>
</dl>
<h4 class="name" id="~getStats"><span class="type-signature type-signature-inner">(inner) </span>getStats<span class="signature">()</span><span class="type-signature"> → {object}</span></h4>
<dl class="details">
<dt class="tag-description">Description:</dt>
<dd class="tag-description"><ul class="dummy"><li>Server-side stats (also useful in privileged diagnostics).</li></ul></dd>
</dl>
<h5 class="h5-returns">Returns:</h5>
<dl class="param-type">
<dt>
Type
</dt>
<dd>
<span class="param-type">object</span>
</dd>
</dl>
<h4 class="name" id="~isEnabled"><span class="type-signature type-signature-inner">(inner) </span>isEnabled<span class="signature">()</span><span class="type-signature"> → {boolean}</span></h4>
<dl class="details">
<dt class="tag-description">Description:</dt>
<dd class="tag-description"><ul class="dummy"><li>Whether the server queue is enabled and a driver is running.</li></ul></dd>
</dl>
<h5 class="h5-returns">Returns:</h5>
<dl class="param-type">
<dt>
Type
</dt>
<dd>
<span class="param-type">boolean</span>
</dd>
</dl>
</article>
</section>
</div>
<br class="clear">
<footer>
Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 4.0.4</a> on Sun Jul 26 2026 14:22:22 GMT+0530 (India Standard Time) using the <a href="https://github.com/clenemt/docdash">docdash</a> theme.
</footer>
<script>prettyPrint();</script>
<script src="scripts/polyfill.js"></script>
<script src="scripts/linenumber.js"></script>
</body>
</html>