Skip to content

Latest commit

 

History

History
562 lines (316 loc) · 17.2 KB

File metadata and controls

562 lines (316 loc) · 17.2 KB

downflux


downflux / ExecutionArgs

Interface: ExecutionArgs<S>

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

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

Extends

Extended by

Type Parameters

S

S extends ExecutionShape = ExecutionShape

Properties

headers?

optional headers?: Record<string, string>

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

Custom request headers

Inherited from

ExecutionOptions.headers


timeoutMs?

optional timeoutMs?: number

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

Request timeout in milliseconds

Inherited from

ExecutionOptions.timeoutMs


retries?

optional retries?: number

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

Failed request retry count

Inherited from

ExecutionOptions.retries


referer?

optional referer?: string

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

Request referer URL

Inherited from

ExecutionOptions.referer


formData?

optional formData?: Record<string, string>

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

Optional FormData for POST requests

Inherited from

ExecutionOptions.formData


provider

provider: Provider

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


method

method: string

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


entryUrl

entryUrl: string

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


targets

targets: string[]

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


executionShape

executionShape: S

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

Internal runtime metadata describing the structural shape of extracted output. single -> TResult; multiple -> TResult[]


executionType?

optional executionType?: ExecutionType

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

Job execution strategy

Overrides

ExecutionOptions.executionType


extractionTarget

extractionTarget: ExtractionTarget

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


providerMetadata?

optional providerMetadata?: ProviderMetadata

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

Provider capabilities and restrictions


dirConfig?

optional dirConfig?: DirectoryOutputOptions

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

Directory output configuration

Inherited from

ExecutionOptions.dirConfig


allowedExtensions?

optional allowedExtensions?: AllowedExtension[]

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

Allowed file extensions

Inherited from

ExecutionOptions.allowedExtensions


allowedVideoQuality?

optional allowedVideoQuality?: VideoQuality

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

Allowed video quality

Inherited from

ExecutionOptions.allowedVideoQuality


preferredVideoFormat?

optional preferredVideoFormat?: VideoFormat

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

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

Inherited from

ExecutionOptions.preferredVideoFormat


preferredVideoCodec?

optional preferredVideoCodec?: VideoCodec

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

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

Inherited from

ExecutionOptions.preferredVideoCodec


tagFilterOptions?

optional tagFilterOptions?: TagFilterOptions

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

Tag filtering options

Inherited from

ExecutionOptions.tagFilterOptions


maxDownloads?

optional maxDownloads?: number

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

Maximum number of items to download

Inherited from

ExecutionOptions.maxDownloads


transformOutput?

optional transformOutput?: boolean

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

Transform output to service-specific result type

Inherited from

ExecutionOptions.transformOutput


concurrency?

optional concurrency?: number

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

Download phase concurrency

Inherited from

ExecutionOptions.concurrency


noDownload?

optional noDownload?: boolean

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

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

Inherited from

ExecutionOptions.noDownload


extractConcurrency?

optional extractConcurrency?: number

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

Extraction phase concurrency

Inherited from

ExecutionOptions.extractConcurrency


transcodeOptions?

optional transcodeOptions?: TranscodeOptions

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

Transcoding options

Inherited from

ExecutionOptions.transcodeOptions


downloadRetries?

optional downloadRetries?: number

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

Download retry count

Inherited from

ExecutionOptions.downloadRetries


retryDelayMs?

optional retryDelayMs?: number

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

Delay between download retries in milliseconds

Inherited from

ExecutionOptions.retryDelayMs


pipelineHooks?

optional pipelineHooks?: PipelineHook[]

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

PipelineRegistry lifecycle hooks

Inherited from

ExecutionOptions.pipelineHooks


onProgress?

optional onProgress?: (event) => void

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

Progress event handler

Parameters

event

JobProgressEvent

Returns

void

Inherited from

ExecutionOptions.onProgress


logProgress?

optional logProgress?: boolean

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

Enables console progress logging

Inherited from

ExecutionOptions.logProgress


outputType?

optional outputType?: OutputType

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

Output format for ExecutionCoordinator results

Inherited from

ExecutionOptions.outputType


signal?

optional signal?: AbortSignal

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

Abort signal for cancelling the ExecutionCoordinator

Inherited from

ExecutionOptions.signal


userAgent?

optional userAgent?: string

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

Inherited from

ExecutionOptions.userAgent


enableSniSpoofing?

optional enableSniSpoofing?: boolean

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

Inherited from

ExecutionOptions.enableSniSpoofing


proxy?

optional proxy?: ProxyOptions

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

Inherited from

ExecutionOptions.proxy


dispatcher?

optional dispatcher?: Dispatcher

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

Inherited from

ExecutionOptions.dispatcher