Skip to content
View as Markdown
View as Markdown

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

Interface: WaitForJobOptions

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

Options for waiting on a job.

Properties

onPoll()?

optional onPoll: (info) => void

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

Callback invoked on each poll with current status.

Parameters

info

WaitForJobPollInfo

Returns

void


pollIntervalSeconds?

optional pollIntervalSeconds: number

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

Polling interval in seconds (default: 3).


sleep()?

optional sleep: (ms) => Promise<void>

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

Custom sleep function for testing.

Parameters

ms

number

Returns

Promise<void>


timeoutSeconds?

optional timeoutSeconds: number

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

Maximum time to wait in seconds (default: no limit, 0 = no timeout).

Released under the Apache-2.0 License.