Skip to content
v9.1.1
Français

TaskQueue

import type { TaskQueue } from "@elie-laloum/outpost";

Parameters and properties

Section titled “Parameters and properties”
  • enqueueRequired
    (request: QueueRequest) => Promise<QueueJob>
    Store a pending job, or return the stored job, in any status, when the ID already holds an identical request. A different request under an existing ID is rejected.
  • getRequired
    (id: string) => Promise<QueueJob | undefined>
    Return the job for an ID, or undefined when absent; a job past its deadline comes back cancelled.
  • claimRequired
    (request: QueueClaim) => Promise<QueueJob | undefined>
    Take a pending job, or an active job whose lease expired, for one of the listed handlers; increment its fence and start a lease. Returns undefined when no job is eligible.
  • renewRequired
    (lease: QueueLease, leaseMs: number) => Promise<QueueJob>
    Extend the lease by leaseMs, capped at the job’s deadline. Rejects with Stale queue lease when the worker, fence or lease expiry no longer match.
  • completeRequired
    (lease: QueueLease, result: QueueResult) => Promise<QueueJob>
    Store the result and mark the job done, or failed when result.error is set. Rejects with Stale queue lease unless the lease is still current.
  • cancelRequired
    (id: string, fence: number) => Promise<QueueJob>
    Cancel a pending or active job and increment its fence; a finished job is returned unchanged. Rejects with Stale queue fence when fence differs from the job’s current fence.

Signature

Section titled “Signature”
export interface TaskQueue {
  enqueue(request: QueueRequest): Promise<QueueJob>;
  get(id: string): Promise<QueueJob | undefined>;
  claim(request: QueueClaim): Promise<QueueJob | undefined>;
  renew(lease: QueueLease, leaseMs: number): Promise<QueueJob>;
  complete(lease: QueueLease, result: QueueResult): Promise<QueueJob>;
  cancel(id: string, fence: number): Promise<QueueJob>;
}
Section titled “Related contracts”