Skip to Content
APIReactuseQueue

useQueue

Hook for accessing and controlling the job queue.

Signature

function useQueue(filter?: { actionKey?: string }): {
  jobs: QueuedJob[];
  pendingCount: number;
  retry: (jobId: string) => Promise<void>;
  cancel: (jobId: string) => void;
};

Parameters

FieldTypeDescription
filter.actionKeystring?Only show jobs for this action. Omit for entire queue

When actionKey is set, re-renders only when that action’s queue changes (per-action snapshot stability).

Returns

FieldTypeDescription
jobsQueuedJob[]Filtered job list
pendingCountnumberqueued + running count
retry(jobId) => Promise<void>Retry a failed/queued job
cancel(jobId) => voidCancel a job

Example

const { jobs, pendingCount, retry, cancel } = useQueue({ actionKey: 'save' });
 
return (
  <ul>
    {jobs.map((job) => (
      <li key={job.id}>
        {job.actionKey} — {job.status}
        {job.status === 'failed' && <button onClick={() => retry(job.id)}>Retry</button>}
        <button onClick={() => cancel(job.id)}>Cancel</button>
      </li>
    ))}
  </ul>
);
Last updated on
useActionDefault Options