Skip to content

Latest commit

 

History

History
348 lines (175 loc) · 10 KB

File metadata and controls

348 lines (175 loc) · 10 KB

downflux


downflux / ExecutionOptions

Interface: ExecutionOptions

Defined in: packages/contracts/ExecutionContracts.ts:66

Configuration options for a DownFlux ExecutionCoordinator. Combines fetch, extraction, pipeline, and output settings.

Extends

Extended by

Properties

headers?

optional headers?: Record<string, string>

Defined in: packages/contracts/DownloadContracts.ts:76

Custom request headers

Inherited from

HttpFetchOptions.headers


timeoutMs?

optional timeoutMs?: number

Defined in: packages/contracts/DownloadContracts.ts:79

Request timeout in milliseconds

Inherited from

HttpFetchOptions.timeoutMs


retries?

optional retries?: number

Defined in: packages/contracts/DownloadContracts.ts:82

Failed request retry count

Inherited from

HttpFetchOptions.retries


referer?

optional referer?: string

Defined in: packages/contracts/DownloadContracts.ts:85

Request referer URL

Inherited from

HttpFetchOptions.referer


formData?

optional formData?: Record<string, string>

Defined in: packages/contracts/DownloadContracts.ts:88

Optional FormData for POST requests

Inherited from

HttpFetchOptions.formData


dirConfig?

optional dirConfig?: DirectoryOutputOptions

Defined in: packages/contracts/ExecutionContracts.ts:68

Directory output configuration


allowedExtensions?

optional allowedExtensions?: AllowedExtension[]

Defined in: packages/contracts/ExecutionContracts.ts:71

Allowed file extensions


allowedVideoQuality?

optional allowedVideoQuality?: VideoQuality

Defined in: packages/contracts/ExecutionContracts.ts:74

Allowed video quality


preferredVideoFormat?

optional preferredVideoFormat?: VideoFormat

Defined in: packages/contracts/ExecutionContracts.ts:77

Preferred video format (e.g. hls, mp4)


preferredVideoCodec?

optional preferredVideoCodec?: VideoCodec

Defined in: packages/contracts/ExecutionContracts.ts:80

Preferred video codec (e.g. h264, av1)


tagFilterOptions?

optional tagFilterOptions?: TagFilterOptions

Defined in: packages/contracts/ExecutionContracts.ts:83

Tag filtering options


maxDownloads?

optional maxDownloads?: number

Defined in: packages/contracts/ExecutionContracts.ts:86

Maximum number of items to download


transformOutput?

optional transformOutput?: boolean

Defined in: packages/contracts/ExecutionContracts.ts:89

Transform output to service-specific result type


concurrency?

optional concurrency?: number

Defined in: packages/contracts/ExecutionContracts.ts:92

Download phase concurrency


noDownload?

optional noDownload?: boolean

Defined in: packages/contracts/ExecutionContracts.ts:95

Iterate only-- this prop is only used for logging http-services


extractConcurrency?

optional extractConcurrency?: number

Defined in: packages/contracts/ExecutionContracts.ts:98

Extraction phase concurrency


transcodeOptions?

optional transcodeOptions?: TranscodeOptions

Defined in: packages/contracts/ExecutionContracts.ts:101

Transcoding options


downloadRetries?

optional downloadRetries?: number

Defined in: packages/contracts/ExecutionContracts.ts:104

Download retry count


retryDelayMs?

optional retryDelayMs?: number

Defined in: packages/contracts/ExecutionContracts.ts:107

Delay between download retries in milliseconds


pipelineHooks?

optional pipelineHooks?: PipelineHook[]

Defined in: packages/contracts/ExecutionContracts.ts:110

PipelineRegistry lifecycle hooks


onProgress?

optional onProgress?: (event) => void

Defined in: packages/contracts/ExecutionContracts.ts:113

Progress event handler

Parameters

event

JobProgressEvent

Returns

void


logProgress?

optional logProgress?: boolean

Defined in: packages/contracts/ExecutionContracts.ts:116

Enables console progress logging


outputType?

optional outputType?: OutputType

Defined in: packages/contracts/ExecutionContracts.ts:119

Output format for ExecutionCoordinator results


executionType?

optional executionType?: ExecutionType

Defined in: packages/contracts/ExecutionContracts.ts:122

Job execution strategy


signal?

optional signal?: AbortSignal

Defined in: packages/contracts/ExecutionContracts.ts:125

Abort signal for cancelling the ExecutionCoordinator


userAgent?

optional userAgent?: string

Defined in: packages/contracts/ExecutionContracts.ts:129

Inherited from

HttpFetchOptions.userAgent


enableSniSpoofing?

optional enableSniSpoofing?: boolean

Defined in: packages/contracts/ExecutionContracts.ts:131

Inherited from

HttpFetchOptions.enableSniSpoofing


proxy?

optional proxy?: ProxyOptions

Defined in: packages/contracts/ExecutionContracts.ts:133

Inherited from

HttpFetchOptions.proxy


dispatcher?

optional dispatcher?: Dispatcher

Defined in: packages/contracts/ExecutionContracts.ts:135

Inherited from

HttpFetchOptions.dispatcher