ResumableBatchOptions

Defined in: src/transfers/resumableBatch.ts:236

Options accepted by runResumableBatch.

Properties

Property	Type	Description	Defined in
bandwidthLimit?	TransferBandwidthLimit	Bandwidth limit forwarded to the queue.	src/transfers/resumableBatch.ts:258
batchStore	TransferBatchStateStore	Step-completion persistence.	src/transfers/resumableBatch.ts:246
client?	TransferClient	Client whose defaults seed queue retry/timeout policies.	src/transfers/resumableBatch.ts:250
concurrency?	number	Maximum steps executed concurrently. Defaults to 1.	src/transfers/resumableBatch.ts:252
engine?	TransferEngine	Transfer engine override forwarded to the queue.	src/transfers/resumableBatch.ts:248
executor	TransferExecutor	Executor for individual jobs. Pass an executor created with createProviderTransferExecutor and a resume option so interrupted files also resume at the byte level.	src/transfers/resumableBatch.ts:244
onError?	(item: TransferQueueItem, error: unknown) => void	Failure observer per failed step.	src/transfers/resumableBatch.ts:266
onProgress?	(event: TransferProgressEvent) => void	Progress observer shared across the batch.	src/transfers/resumableBatch.ts:262
onReceipt?	(receipt: TransferReceipt) => void	Completion observer per successful step.	src/transfers/resumableBatch.ts:264
plan	TransferPlan	Plan to execute (or re-execute after a crash).	src/transfers/resumableBatch.ts:238
retry?	TransferRetryPolicy	Retry policy forwarded to the queue.	src/transfers/resumableBatch.ts:254
signal?	AbortSignal	Abort signal canceling the batch run.	src/transfers/resumableBatch.ts:260
timeout?	TransferTimeoutPolicy	Timeout policy forwarded to the queue.	src/transfers/resumableBatch.ts:256