SQLiteJobQueue
Defined in: packages/messaging/src/queue/sqlite-job-queue.ts:13
Type Parameters
Section titled “Type Parameters”T
Implements
Section titled “Implements”JobQueue<T>
Constructors
Section titled “Constructors”Constructor
Section titled “Constructor”new SQLiteJobQueue<
T>(options?):SQLiteJobQueue<T>
Defined in: packages/messaging/src/queue/sqlite-job-queue.ts:16
Parameters
Section titled “Parameters”options?
Section titled “options?”SQLiteJobQueueOptions = {}
Returns
Section titled “Returns”SQLiteJobQueue<T>
Methods
Section titled “Methods”cleanupTerminal()
Section titled “cleanupTerminal()”cleanupTerminal(
statuses?):Promise<number>
Defined in: packages/messaging/src/queue/sqlite-job-queue.ts:293
Parameters
Section titled “Parameters”statuses?
Section titled “statuses?”JobStatus[] = ...
Returns
Section titled “Returns”Promise<number>
Implementation of
Section titled “Implementation of”clear()
Section titled “clear()”clear():
Promise<void>
Defined in: packages/messaging/src/queue/sqlite-job-queue.ts:289
Returns
Section titled “Returns”Promise<void>
Implementation of
Section titled “Implementation of”close()
Section titled “close()”close():
void
Defined in: packages/messaging/src/queue/sqlite-job-queue.ts:314
Returns
Section titled “Returns”void
complete()
Section titled “complete()”complete(
jobId,_result?):Promise<void>
Defined in: packages/messaging/src/queue/sqlite-job-queue.ts:172
Parameters
Section titled “Parameters”string
_result?
Section titled “_result?”any
Returns
Section titled “Returns”Promise<void>
Implementation of
Section titled “Implementation of”dequeue()
Section titled “dequeue()”dequeue():
Promise<Job<T> |undefined>
Defined in: packages/messaging/src/queue/sqlite-job-queue.ts:146
Returns
Section titled “Returns”Promise<Job<T> | undefined>
Implementation of
Section titled “Implementation of”enqueue()
Section titled “enqueue()”enqueue(
type,data,options?):Promise<Job<T>>
Defined in: packages/messaging/src/queue/sqlite-job-queue.ts:93
Parameters
Section titled “Parameters”string
T
options?
Section titled “options?”delay?
Section titled “delay?”number
maxAttempts?
Section titled “maxAttempts?”number
metadata?
Section titled “metadata?”Record<string, any>
priority?
Section titled “priority?”number
Returns
Section titled “Returns”Promise<Job<T>>
Implementation of
Section titled “Implementation of”fail()
Section titled “fail()”fail(
jobId,error,retry?):Promise<void>
Defined in: packages/messaging/src/queue/sqlite-job-queue.ts:184
Parameters
Section titled “Parameters”string
string | Error
retry?
Section titled “retry?”JobRetryDirective = ...
Returns
Section titled “Returns”Promise<void>
Implementation of
Section titled “Implementation of”getJob()
Section titled “getJob()”getJob(
jobId):Promise<Job<T> |undefined>
Defined in: packages/messaging/src/queue/sqlite-job-queue.ts:258
Parameters
Section titled “Parameters”string
Returns
Section titled “Returns”Promise<Job<T> | undefined>
Implementation of
Section titled “Implementation of”peek()
Section titled “peek()”peek():
Promise<Job<T> |undefined>
Defined in: packages/messaging/src/queue/sqlite-job-queue.ts:225
Returns
Section titled “Returns”Promise<Job<T> | undefined>
Implementation of
Section titled “Implementation of”remove()
Section titled “remove()”remove(
jobId):Promise<boolean>
Defined in: packages/messaging/src/queue/sqlite-job-queue.ts:275
Parameters
Section titled “Parameters”string
Returns
Section titled “Returns”Promise<boolean>
Implementation of
Section titled “Implementation of”size()
Section titled “size()”size():
Promise<number>
Defined in: packages/messaging/src/queue/sqlite-job-queue.ts:246
Returns
Section titled “Returns”Promise<number>