Skip to content
View as Markdown
View as Markdown

@salesforce/b2c-tooling-sdk / operations/jobs / waitForJob

Function: waitForJob()

waitForJob(instance, jobId, executionId, options): Promise<{ }>

Defined in: packages/b2c-tooling-sdk/src/operations/jobs/run.ts:221

Waits for a job execution to complete.

Polls the job status until it reaches a terminal state (finished or aborted).

Parameters

instance

B2CInstance

B2C instance

jobId

string

Job ID

executionId

string

Execution ID to wait for

options

WaitForJobOptions = {}

Wait options

Returns

Promise<{ }>

Final execution status

Throws

Error if job fails (status ERROR or aborted)

Throws

Error if timeout is exceeded

Example

typescript
// Simple wait
const result = await waitForJob(instance, 'my-job', 'exec-123');

// With poll callback
const result = await waitForJob(instance, 'my-job', 'exec-123', {
  onPoll: (info) => {
    console.log(`Status: ${info.status} (${info.elapsedSeconds}s elapsed)`);
  }
});

Released under the Apache-2.0 License.