JobQueue
Defined in: packages/messaging/src/queue/job-queue.interface.ts:85
Type Parameters
섹션 제목: “Type Parameters”T
Methods
섹션 제목: “Methods”cleanupTerminal()?
섹션 제목: “cleanupTerminal()?”
optionalcleanupTerminal(options?):Promise<number>
Defined in: packages/messaging/src/queue/job-queue.interface.ts:130
Removes finished jobs: completed and failed ones by default, or those
with the given statuses, and with olderThan, only those that finished
before it.
Parameters
섹션 제목: “Parameters”options?
섹션 제목: “options?”JobQueueCleanupOptions | JobStatus[]
Returns
섹션 제목: “Returns”Promise<number>
clear()
섹션 제목: “clear()”clear():
Promise<void>
Defined in: packages/messaging/src/queue/job-queue.interface.ts:115
Returns
섹션 제목: “Returns”Promise<void>
complete()
섹션 제목: “complete()”complete(
jobId,result?):Promise<void>
Defined in: packages/messaging/src/queue/job-queue.interface.ts:99
Parameters
섹션 제목: “Parameters”jobId
섹션 제목: “jobId”string
result?
섹션 제목: “result?”any
Returns
섹션 제목: “Returns”Promise<void>
dequeue()
섹션 제목: “dequeue()”dequeue(
options?):Promise<Job<T> |undefined>
Defined in: packages/messaging/src/queue/job-queue.interface.ts:97
Parameters
섹션 제목: “Parameters”options?
섹션 제목: “options?”Returns
섹션 제목: “Returns”Promise<Job<T> | undefined>
enqueue()
섹션 제목: “enqueue()”enqueue(
type,data,options?):Promise<Job<T>>
Defined in: packages/messaging/src/queue/job-queue.interface.ts:86
Parameters
섹션 제목: “Parameters”type
섹션 제목: “type”string
data
섹션 제목: “data”T
options?
섹션 제목: “options?”delay?
섹션 제목: “delay?”number
maxAttempts?
섹션 제목: “maxAttempts?”number
metadata?
섹션 제목: “metadata?”Record<string, any>
priority?
섹션 제목: “priority?”number
Returns
섹션 제목: “Returns”Promise<Job<T>>
fail()
섹션 제목: “fail()”fail(
jobId,error,retry?):Promise<void>
Defined in: packages/messaging/src/queue/job-queue.interface.ts:101
Parameters
섹션 제목: “Parameters”jobId
섹션 제목: “jobId”string
error
섹션 제목: “error”string | Error
retry?
섹션 제목: “retry?”Returns
섹션 제목: “Returns”Promise<void>
getJob()
섹션 제목: “getJob()”getJob(
jobId):Promise<Job<T> |undefined>
Defined in: packages/messaging/src/queue/job-queue.interface.ts:111
Parameters
섹션 제목: “Parameters”jobId
섹션 제목: “jobId”string
Returns
섹션 제목: “Returns”Promise<Job<T> | undefined>
nextDueAt()?
섹션 제목: “nextDueAt()?”
optionalnextDueAt():Promise<Date|undefined>
Defined in: packages/messaging/src/queue/job-queue.interface.ts:123
When dequeue() next has work: the earliest due time of a pending job
or, with leases, lease expiry of a processing one. A time in the past
means dequeue() has work now, even when it only settles an expired
lease. undefined when no job is pending or leased.
Returns
섹션 제목: “Returns”Promise<Date | undefined>
peek()
섹션 제목: “peek()”peek():
Promise<Job<T> |undefined>
Defined in: packages/messaging/src/queue/job-queue.interface.ts:107
Returns
섹션 제목: “Returns”Promise<Job<T> | undefined>
remove()
섹션 제목: “remove()”remove(
jobId):Promise<boolean>
Defined in: packages/messaging/src/queue/job-queue.interface.ts:113
Parameters
섹션 제목: “Parameters”jobId
섹션 제목: “jobId”string
Returns
섹션 제목: “Returns”Promise<boolean>
size()
섹션 제목: “size()”size():
Promise<number>
Defined in: packages/messaging/src/queue/job-queue.interface.ts:109
Returns
섹션 제목: “Returns”Promise<number>