Class Sidetrack<Queues>

Main class that contains all the primary methods for interacting with Sidetrack

Type Parameters

Queues extends SidetrackQueuesGenericType

Hierarchy (View Summary)

Sidetrack
- SidetrackTest

Index

Constructors

constructor

Methods

cancelJob deactivateCronSchedule deleteCronSchedule deleteJob getJob insertJob scheduleCron start stop

Constructors

constructor

new Sidetrack<Queues extends SidetrackQueuesGenericType>(
options: SidetrackOptions<Queues>,
): Sidetrack<Queues>
Type Parameters
- Queues extends SidetrackQueuesGenericType
Parameters
- options: SidetrackOptions<Queues>
Returns Sidetrack<Queues>
- Defined in packages/sidetrack/src/index.ts:44

Methods

cancelJob

cancelJob(jobId: string, options?: SidetrackCancelJobOptions): Promise<void>
Parameters
- jobId: string
- Optionaloptions: SidetrackCancelJobOptions
Returns Promise<void>
- Defined in packages/sidetrack/src/index.ts:48

deactivateCronSchedule

deactivateCronSchedule<K extends string | number | symbol>(
    queueName: K,
    cronExpression: string,
    options?: SidetrackDeactivateCronScheduleOptions,
): Promise<void>
Deactivate a cron schedule. This prevents the cron schedule from creating new jobs.
Type Parameters
- K extends string | number | symbol
Parameters
- queueName: K
  The queue to deactivate the cron job from
- cronExpression: string
  The cron expression to deactivate
- Optionaloptions: SidetrackDeactivateCronScheduleOptions
Returns Promise<void>
- Defined in packages/sidetrack/src/index.ts:110

deleteCronSchedule

deleteCronSchedule<K extends string | number | symbol>(
    queueName: K,
    cronExpression: string,
    options?: SidetrackDeleteCronScheduleOptions,
): Promise<void>
Delete a cron schedule. This removes the cron job from the database.
Type Parameters
- K extends string | number | symbol
Parameters
- queueName: K
  The queue to delete the cron job from
- cronExpression: string
  The cron expression to delete
- Optionaloptions: SidetrackDeleteCronScheduleOptions
Returns Promise<void>
- Defined in packages/sidetrack/src/index.ts:127

deleteJob

deleteJob(jobId: string, options?: SidetrackDeleteJobOptions): Promise<void>
Parameters
- jobId: string
- Optionaloptions: SidetrackDeleteJobOptions
Returns Promise<void>
- Defined in packages/sidetrack/src/index.ts:56

getJob

getJob(jobId: string, options?: SidetrackGetJobOptions): Promise<SidetrackJobs>
Parameters
- jobId: string
- Optionaloptions: SidetrackGetJobOptions
Returns Promise<SidetrackJobs>
- Defined in packages/sidetrack/src/index.ts:64

insertJob

insertJob<K extends string | number | symbol>(
    queueName: K,
    payload: Queues[K],
    options?: SidetrackInsertJobOptions,
): Promise<SidetrackJobs>
Type Parameters
- K extends string | number | symbol
Parameters
- queueName: K
- payload: Queues[K]
- Optionaloptions: SidetrackInsertJobOptions
Returns Promise<SidetrackJobs>
- Defined in packages/sidetrack/src/index.ts:75

scheduleCron

scheduleCron<K extends string | number | symbol>(
    queueName: K,
    cronExpression: string,
    payload: Queues[K],
    options?: SidetrackCronJobOptions,
): Promise<SidetrackCronJobs>
Schedule a cron job on a queue
Type Parameters
- K extends string | number | symbol
Parameters
- queueName: K
  The queue to schedule the cron job on
- cronExpression: string
  A 5 or 6 part cron expression
- payload: Queues[K]
- Optionaloptions: SidetrackCronJobOptions
Returns Promise<SidetrackCronJobs>
- Defined in packages/sidetrack/src/index.ts:92

start

start(): Promise<void>
Automatically run migrations and start polling the DB for jobs

Returns Promise<void>
- Defined in packages/sidetrack/src/index.ts:142

stop

stop(): void
Turn off polling

Returns void
- Defined in packages/sidetrack/src/index.ts:156

Class Sidetrack<Queues>

Type Parameters

Hierarchy (View Summary)

Index

Constructors

Methods

Constructors

constructor

Type Parameters

Parameters

Returns Sidetrack<Queues>

Methods

cancelJob

Parameters

Returns Promise<void>

deactivateCronSchedule

Type Parameters

Parameters

Returns Promise<void>

deleteCronSchedule

Type Parameters

Parameters

Returns Promise<void>

deleteJob

Parameters

Returns Promise<void>

getJob

Parameters

Returns Promise<SidetrackJobs>

insertJob

Type Parameters

Parameters

Returns Promise<SidetrackJobs>

scheduleCron

Type Parameters

Parameters

Returns Promise<SidetrackCronJobs>

start

Returns Promise<void>

stop

Returns void

Settings

On This Page