Class JobScheduler

Base class for all classes that need to interact with queues. This class is normally not used directly, but extended by the other classes.

Hierarchy (View Summary)

QueueBase
- JobScheduler

Index

Constructors

constructor

new JobScheduler(
    name: string,
    opts: RepeatBaseOptions,
    Connection?: typeof RedisConnection,
): JobScheduler
Parameters
- name: string
- opts: RepeatBaseOptions
- OptionalConnection: typeof RedisConnection
Returns JobScheduler
Overrides QueueBase.constructor
- Defined in classes/job-scheduler.ts:23

Properties

closing

closing: Promise<void>

keys

keys: KeysMap

`Readonly`name

name: string

The name of the queue.

opts

opts: QueueBaseOptions = ...

Options for the queue.

`Readonly`qualifiedName

qualifiedName: string

toKey

toKey: (type: string) => string

Accessors

client

get client(): Promise<RedisClient>
Returns a promise that resolves to a redis client. Normally used only by subclasses.

Returns Promise<RedisClient>
Inherited from QueueBase.client
- Defined in classes/queue-base.ts:93

databaseType

get databaseType(): DatabaseType
Returns the database type of the Redis instance the client is connected to,

Returns DatabaseType
Inherited from QueueBase.databaseType
- Defined in classes/queue-base.ts:111

redisVersion

get redisVersion(): string
Returns the version of the Redis instance the client is connected to,

Returns string
Inherited from QueueBase.redisVersion
- Defined in classes/queue-base.ts:104

Methods

close

close(): Promise<void>
Closes the connection and returns a promise that resolves when the connection is closed.

Returns Promise<void>
Inherited from QueueBase.close
- Defined in classes/queue-base.ts:160

disconnect

disconnect(): Promise<void>
Force disconnects a connection.

Returns Promise<void>
Inherited from QueueBase.disconnect
- Defined in classes/queue-base.ts:172

emit

emit(event: string | symbol, ...args: any[]): boolean
Emits an event. Normally used by subclasses to emit events.
Parameters
- event: string | symbol
  The emitted event.
- ...args: any[]
Returns boolean
Inherited from QueueBase.emit
- Defined in classes/queue-base.ts:129

getJobSchedulers

getJobSchedulers<D = any>(
    start?: number,
    end?: number,
    asc?: boolean,
): Promise<JobSchedulerJson<D>[]>
Type Parameters
- D = any
Parameters
- start: number = 0
- end: number = -1
- asc: boolean = false
Returns Promise<JobSchedulerJson<D>[]>
- Defined in classes/job-scheduler.ts:395

getScheduler

getScheduler<D = any>(id: string): Promise<JobSchedulerJson<D>>
Type Parameters
- D = any
Parameters
- id: string
Returns Promise<JobSchedulerJson<D>>
- Defined in classes/job-scheduler.ts:369

getSchedulersCount

getSchedulersCount(): Promise<number>
Returns Promise<number>
- Defined in classes/job-scheduler.ts:416

isJobScheduler

isJobScheduler(id: string): Promise<boolean>
Checks if a given id corresponds to a registered job scheduler.

This is used to disambiguate between new job scheduler ids (which may contain any number of colon segments) and legacy repeatable job keys (which always contain 5+ colon segments). Relying purely on segment count is not safe because a user-provided jobSchedulerId may itself contain 5+ colon segments, which would otherwise be misclassified as a legacy repeatable key.

We cannot use ZSCORE on the shared repeat sorted set because legacy repeatable jobs are stored in the same sorted set and would be reported as schedulers. Instead, we probe the per-id metadata hash (repeat:<id>) for the ic (iteration count) field, which is written exclusively by storeJobScheduler and is never set by the legacy addRepeatableJob flow.
Parameters
- id: string
Returns Promise<boolean>
- Defined in classes/job-scheduler.ts:363

removeJobScheduler

removeJobScheduler(jobSchedulerId: string): Promise<number>
Parameters
- jobSchedulerId: string
Returns Promise<number>
- Defined in classes/job-scheduler.ts:257

trace

trace<T>(
    spanKind: SpanKind,
    operation: string,
    destination: string,
    callback: (span?: Span, dstPropagationMetadata?: string) => T | Promise<T>,
    srcPropagationMetadata?: string,
): Promise<T | Promise<T>>
Wraps the code with telemetry and provides a span for configuration.
Type Parameters
- T
Parameters
- spanKind: SpanKind
  kind of the span: Producer, Consumer, Internal
- operation: string
  operation name (such as add, process, etc)
- destination: string
  destination name (normally the queue name)
- callback: (span?: Span, dstPropagationMetadata?: string) => T | Promise<T>
  code to wrap with telemetry
- OptionalsrcPropagationMetadata: string
Returns Promise<T | Promise<T>>
Inherited from QueueBase.trace
- Defined in classes/queue-base.ts:205

upsertJobScheduler

upsertJobScheduler<T = any, R = any, N extends string = string>(
    jobSchedulerId: string,
    repeatOpts: Omit<RepeatOptions, "key" | "prevMillis">,
    jobName: N,
    jobData: T,
    opts: JobSchedulerTemplateOptions,
    __namedParameters: { override: boolean; producerId?: string },
): Promise<Job<T, R, N>>
Type Parameters
- T = any
- R = any
- N extends string = string
Parameters
- jobSchedulerId: string
- repeatOpts: Omit<RepeatOptions, "key" | "prevMillis">
- jobName: N
- jobData: T
- opts: JobSchedulerTemplateOptions
- __namedParameters: { override: boolean; producerId?: string }
Returns Promise<Job<T, R, N>>
- Defined in classes/job-scheduler.ts:34

waitUntilReady

waitUntilReady(): Promise<RedisClient>
Returns Promise<RedisClient>
Inherited from QueueBase.waitUntilReady
- Defined in classes/queue-base.ts:143

Class JobScheduler

Hierarchy (View Summary)

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

Returns JobScheduler

Properties

closing

keys

Readonlyname

opts

ReadonlyqualifiedName

toKey

Accessors

client

Returns Promise<RedisClient>

databaseType

Returns DatabaseType

redisVersion

Returns string

Methods

close

Returns Promise<void>

disconnect

Returns Promise<void>

emit

Parameters

Returns boolean

getJobSchedulers

Type Parameters

Parameters

Returns Promise<JobSchedulerJson<D>[]>

getScheduler

Type Parameters

Parameters

Returns Promise<JobSchedulerJson<D>>

getSchedulersCount

Returns Promise<number>

isJobScheduler

Parameters

Returns Promise<boolean>

removeJobScheduler

Parameters

Returns Promise<number>

trace

Type Parameters

Parameters

Returns Promise<T | Promise<T>>

upsertJobScheduler

Type Parameters

Parameters

Returns Promise<Job<T, R, N>>

waitUntilReady

Returns Promise<RedisClient>

Settings

On This Page

`Readonly`name

`Readonly`qualifiedName