Interface BatchAwaitOptions

interface BatchAwaitOptions {
    cancelToken?: CancellationToken;
    pollInterval?: number;
    progressReport?: (status: SalesforceBatchJobStatus) => any;
    timeout?: number;
}

Index

Properties

cancelToken? pollInterval? progressReport? timeout?

Properties

`Optional`cancelToken

cancelToken?: CancellationToken

Optional cancellation token that when triggered aborts the batch and returns

`Optional`pollInterval

pollInterval?: number

Frequency to poll in ms for batch progress when awaiting or executing a batch

Default

`Optional`progressReport

progressReport?: (status: SalesforceBatchJobStatus) => any

Progress callback that contains the current batch status

`Optional`timeout

timeout?: number

Timeout value in ms after which the batch is aborted if it did not complete with in the set time