OptionsType
OptionsType =
OptionsType&object
Defined in: packages/synapse-core/src/sp/pull-pieces.ts:152
Options for polling pull status.
Type Declaration
Section titled “Type Declaration”onStatus?
Section titled “onStatus?”
optionalonStatus?: (response) =>void
Callback invoked on each poll with current status.
Parameters
Section titled “Parameters”| Parameter | Type |
|---|---|
response | ReturnType |
Returns
Section titled “Returns”void
pollInterval?
Section titled “pollInterval?”
optionalpollInterval?:number
The poll interval in milliseconds. Defaults to RETRY_CONSTANTS.POLL_INTERVAL.
retryCount?
Section titled “retryCount?”
optionalretryCount?:number
The number of retries. Defaults to 2.
retryDelay?
Section titled “retryDelay?”
optionalretryDelay?:number
The delay with exponential backoff between retries in milliseconds. Defaults to RETRY_CONSTANTS.RETRY_DELAY.
timeout?
Section titled “timeout?”
optionaltimeout?:number
Total time in milliseconds to wait for the pull to finish. Defaults to RETRY_CONSTANTS.PULL_TIMEOUT (2 hours).