Skip to content

Function: runProgressibleJobs()

ts
function runProgressibleJobs<T>(
   ctx: Context, 
   jobs: T, 
options?: RunProgressibleJobsOptions): JobResults<T>;

Defined in: src/progress/runProgressibleJobs.ts:50

Run jobs and track each one as a progressible item.

Wraps each job so it reports its status (pending, running, done, failed) through the onUpdateProgressibles callback.

Type Parameters

Type Parameter
T extends JobList

Parameters

ParameterTypeDescription
ctxContextContext object.
jobsTList of jobs to run.
options?RunProgressibleJobsOptionsOptions including concurrency and progress callback.

Returns

JobResults<T>

An array of job results.

Example

ts
import {runProgressibleJobs} from '@matterway/sdk-progress';

const jobs = [
  {title: 'Scan barcodes', handler: async (ctx) => scanAll(ctx)},
  {title: 'Update inventory', handler: async (ctx) => syncInventory(ctx)},
];

const results = await runProgressibleJobs(ctx, jobs, {
  concurrency: 2,
  onUpdateProgressibles: (items) => console.log(items),
});

Matterway Assistant SDK Documentation