Class Sidetrack<Queues>

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

Type Parameters

Queues extends SidetrackQueuesGenericType

Hierarchy (view full)

Sidetrack
- SidetrackTest

Index

Constructors

Methods

cancelJob deleteJob getJob insertJob start stop

Constructors

constructor

new Sidetrack<Queues>(options): Sidetrack<Queues>
Type Parameters
- Queues extends SidetrackQueuesGenericType
Parameters
- options: SidetrackOptions<Queues>
Returns Sidetrack<Queues>
- Defined in index.ts:41

Methods

cancelJob

cancelJob(jobId, options?): Promise<void>
Parameters
- jobId: string
- Optional options: SidetrackCancelJobOptions
Returns Promise<void>
- Defined in index.ts:53

deleteJob

deleteJob(jobId, options?): Promise<void>
Parameters
- jobId: string
- Optional options: SidetrackDeleteJobOptions
Returns Promise<void>
- Defined in index.ts:61

getJob

getJob(jobId, options?): Promise<default>
Parameters
- jobId: string
- Optional options: SidetrackGetJobOptions
Returns Promise<default>
- Defined in index.ts:69

insertJob

insertJob<K>(queueName, payload, options?): Promise<default>
Type Parameters
- K extends string | number | symbol
Parameters
- queueName: K
- payload: Queues[K]
- Optional options: SidetrackInsertJobOptions
Returns Promise<default>
- Defined in index.ts:80

start

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

Returns Promise<void>
- Defined in index.ts:95

stop

stop(): Promise<void>
Turn off polling

Returns Promise<void>
- Defined in index.ts:104