Preparing search index...
The search index is not available
@taskforcesh/bullmq-pro - v7.25.0
@taskforcesh/bullmq-pro
v1
QueueScheduler
Class QueueScheduler
Hierarchy
QueueScheduler
QueueScheduler
Index
Constructors
constructor
Properties
closing
keys
name
opts
to
Key
Accessors
client
redis
Version
Methods
close
disconnect
emit
is
Running
off
on
once
run
wait
Until
Ready
Constructors
constructor
new
Queue
Scheduler
(
name
,
opts
?
)
:
QueueScheduler
Parameters
name
:
string
Optional
opts
:
QueueSchedulerOptions
Returns
QueueScheduler
Properties
closing
closing
:
Promise
<
void
>
keys
keys
:
KeysMap
Readonly
name
name
:
string
opts
opts
:
QueueSchedulerOptions
to
Key
to
Key
:
(
(
type
)
=>
string
)
Type declaration
(
type
)
:
string
Parameters
type
:
string
Returns
string
Accessors
client
get
client
(
)
:
Promise
<
RedisClient
>
Returns
Promise
<
RedisClient
>
redis
Version
get
redisVersion
(
)
:
string
Returns
string
Methods
close
close
(
)
:
Promise
<
void
>
Returns
Promise
<
void
>
disconnect
disconnect
(
)
:
Promise
<
void
>
Returns
Promise
<
void
>
emit
emit
<
U
>
(
event
,
...
args
)
:
boolean
Type Parameters
U
extends
keyof
QueueSchedulerListener
Parameters
event
:
U
Rest
...
args
:
Parameters
<
QueueSchedulerListener
[
U
]
>
Returns
boolean
is
Running
is
Running
(
)
:
boolean
Returns
boolean
off
off
<
U
>
(
eventName
,
listener
)
:
QueueScheduler
Type Parameters
U
extends
keyof
QueueSchedulerListener
Parameters
eventName
:
U
listener
:
QueueSchedulerListener
[
U
]
Returns
QueueScheduler
on
on
<
U
>
(
event
,
listener
)
:
QueueScheduler
Type Parameters
U
extends
keyof
QueueSchedulerListener
Parameters
event
:
U
listener
:
QueueSchedulerListener
[
U
]
Returns
QueueScheduler
once
once
<
U
>
(
event
,
listener
)
:
QueueScheduler
Type Parameters
U
extends
keyof
QueueSchedulerListener
Parameters
event
:
U
listener
:
QueueSchedulerListener
[
U
]
Returns
QueueScheduler
run
run
(
)
:
Promise
<
void
>
Returns
Promise
<
void
>
wait
Until
Ready
wait
Until
Ready
(
)
:
Promise
<
RedisClient
>
Returns
Promise
<
RedisClient
>
Settings
Member Visibility
Inherited
Theme
OS
Light
Dark
On This Page
constructor
closing
keys
name
opts
to
Key
client
redis
Version
close
disconnect
emit
is
Running
off
on
once
run
wait
Until
Ready
@taskforcesh/bullmq-
pro -
v7.25.0
v7
v6
v5
v4
v3
v2
v1
Job
Pro
Queue
Pro
Queue
Scheduler
Pro
Worker
Pro
Metrics
Time
Child
Pool
Flow
Producer
Job
Queue
Queue
Base
Queue
Events
Queue
Scheduler
Redis
Connection
Repeat
Unrecoverable
Error
Worker
Child
Process
Ext
Job
Node
Job
Ttl
Map
Jobs
Pro
Options
Queue
Pro
Options
Worker
Pro
Options
Processor
Pro
Redis
Client
Generated using
TypeDoc