TransferQueueOptions
Defined in: src/transfers/TransferQueue.ts:29
Options used to create a transfer queue.
Properties
Section titled “Properties”| Property | Type | Description | Defined in |
|---|---|---|---|
bandwidthLimit? | TransferBandwidthLimit | Optional throughput limit shape passed to transfer executors. | src/transfers/TransferQueue.ts:48 |
client? | TransferClient | Transfer client whose defaults seed the queue’s retry and timeout policies when not set here or per drain. | src/transfers/TransferQueue.ts:36 |
concurrency? | number | Maximum jobs to execute at the same time. Defaults to 1. | src/transfers/TransferQueue.ts:38 |
engine? | TransferEngine | Transfer engine used to execute queued jobs. Defaults to a new engine. | src/transfers/TransferQueue.ts:31 |
executor? | TransferExecutor | Default executor used for jobs that do not provide one directly. | src/transfers/TransferQueue.ts:40 |
onError? | (item: TransferQueueItem, error: unknown) => void | Failure observer for failed jobs. | src/transfers/TransferQueue.ts:54 |
onProgress? | (event: TransferProgressEvent) => void | Progress observer shared across queued jobs. | src/transfers/TransferQueue.ts:50 |
onReceipt? | (receipt: TransferReceipt) => void | Completion observer for successful jobs. | src/transfers/TransferQueue.ts:52 |
resolveExecutor? | TransferQueueExecutorResolver | Dynamic executor resolver used when no per-job executor or default executor exists. | src/transfers/TransferQueue.ts:42 |
retry? | TransferRetryPolicy | Retry policy passed to engine executions. Falls back to client.defaults.retry. | src/transfers/TransferQueue.ts:44 |
timeout? | TransferTimeoutPolicy | Timeout policy passed to engine executions. Falls back to client.defaults.timeout. | src/transfers/TransferQueue.ts:46 |