downflux / ExecutionOptions
Defined in: packages/contracts/ExecutionContracts.ts:66
Configuration options for a DownFlux ExecutionCoordinator. Combines fetch, extraction, pipeline, and output settings.
optionalheaders?:Record<string,string>
Defined in: packages/contracts/DownloadContracts.ts:76
Custom request headers
optionaltimeoutMs?:number
Defined in: packages/contracts/DownloadContracts.ts:79
Request timeout in milliseconds
optionalretries?:number
Defined in: packages/contracts/DownloadContracts.ts:82
Failed request retry count
optionalreferer?:string
Defined in: packages/contracts/DownloadContracts.ts:85
Request referer URL
optionalformData?:Record<string,string>
Defined in: packages/contracts/DownloadContracts.ts:88
Optional FormData for POST requests
optionaldirConfig?:DirectoryOutputOptions
Defined in: packages/contracts/ExecutionContracts.ts:68
Directory output configuration
optionalallowedExtensions?:AllowedExtension[]
Defined in: packages/contracts/ExecutionContracts.ts:71
Allowed file extensions
optionalallowedVideoQuality?:VideoQuality
Defined in: packages/contracts/ExecutionContracts.ts:74
Allowed video quality
optionalpreferredVideoFormat?:VideoFormat
Defined in: packages/contracts/ExecutionContracts.ts:77
Preferred video format (e.g. hls, mp4)
optionalpreferredVideoCodec?:VideoCodec
Defined in: packages/contracts/ExecutionContracts.ts:80
Preferred video codec (e.g. h264, av1)
optionaltagFilterOptions?:TagFilterOptions
Defined in: packages/contracts/ExecutionContracts.ts:83
Tag filtering options
optionalmaxDownloads?:number
Defined in: packages/contracts/ExecutionContracts.ts:86
Maximum number of items to download
optionaltransformOutput?:boolean
Defined in: packages/contracts/ExecutionContracts.ts:89
Transform output to service-specific result type
optionalconcurrency?:number
Defined in: packages/contracts/ExecutionContracts.ts:92
Download phase concurrency
optionalnoDownload?:boolean
Defined in: packages/contracts/ExecutionContracts.ts:95
Iterate only-- this prop is only used for logging http-services
optionalextractConcurrency?:number
Defined in: packages/contracts/ExecutionContracts.ts:98
Extraction phase concurrency
optionaltranscodeOptions?:TranscodeOptions
Defined in: packages/contracts/ExecutionContracts.ts:101
Transcoding options
optionaldownloadRetries?:number
Defined in: packages/contracts/ExecutionContracts.ts:104
Download retry count
optionalretryDelayMs?:number
Defined in: packages/contracts/ExecutionContracts.ts:107
Delay between download retries in milliseconds
optionalpipelineHooks?:PipelineHook[]
Defined in: packages/contracts/ExecutionContracts.ts:110
PipelineRegistry lifecycle hooks
optionalonProgress?: (event) =>void
Defined in: packages/contracts/ExecutionContracts.ts:113
Progress event handler
void
optionallogProgress?:boolean
Defined in: packages/contracts/ExecutionContracts.ts:116
Enables console progress logging
optionaloutputType?:OutputType
Defined in: packages/contracts/ExecutionContracts.ts:119
Output format for ExecutionCoordinator results
optionalexecutionType?:ExecutionType
Defined in: packages/contracts/ExecutionContracts.ts:122
Job execution strategy
optionalsignal?:AbortSignal
Defined in: packages/contracts/ExecutionContracts.ts:125
Abort signal for cancelling the ExecutionCoordinator
optionaluserAgent?:string
Defined in: packages/contracts/ExecutionContracts.ts:129
optionalenableSniSpoofing?:boolean
Defined in: packages/contracts/ExecutionContracts.ts:131
HttpFetchOptions.enableSniSpoofing
optionalproxy?:ProxyOptions
Defined in: packages/contracts/ExecutionContracts.ts:133
optionaldispatcher?:Dispatcher
Defined in: packages/contracts/ExecutionContracts.ts:135