UnsplashExecArgs.md

downflux

---

downflux / UnsplashExecArgs

Interface: UnsplashExecArgs

Defined in: packages/providers/unsplash/UnsplashContracts.ts:3

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

Extends

• ExecutionArgs

Properties

headers?

optional headers?: Record<string, string>

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

Custom request headers

Inherited from

ExecutionArgs.headers

---

timeoutMs?

optional timeoutMs?: number

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

Request timeout in milliseconds

Inherited from

ExecutionArgs.timeoutMs

---

retries?

optional retries?: number

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

Failed request retry count

Inherited from

ExecutionArgs.retries

---

referer?

optional referer?: string

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

Request referer URL

Inherited from

ExecutionArgs.referer

---

formData?

optional formData?: Record<string, string>

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

Optional FormData for POST requests

Inherited from

ExecutionArgs.formData

---

provider

provider: Provider

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

Inherited from

ExecutionArgs.provider

---

method

method: string

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

Inherited from

ExecutionArgs.method

---

entryUrl

entryUrl: string

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

Inherited from

ExecutionArgs.entryUrl

---

targets

targets: string[]

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

Inherited from

ExecutionArgs.targets

---

executionShape

executionShape: ExecutionShape

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

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

Inherited from

ExecutionArgs.executionShape

---

executionType?

optional executionType?: ExecutionType

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

Job execution strategy

Inherited from

ExecutionArgs.executionType

---

extractionTarget

extractionTarget: ExtractionTarget

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

Inherited from

ExecutionArgs.extractionTarget

---

providerMetadata?

optional providerMetadata?: ProviderMetadata

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

Provider capabilities and restrictions

Inherited from

ExecutionArgs.providerMetadata

---

dirConfig?

optional dirConfig?: DirectoryOutputOptions

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

Directory output configuration

Inherited from

ExecutionArgs.dirConfig

---

allowedExtensions?

optional allowedExtensions?: AllowedExtension[]

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

Allowed file extensions

Inherited from

ExecutionArgs.allowedExtensions

---

allowedVideoQuality?

optional allowedVideoQuality?: VideoQuality

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

Allowed video quality

Inherited from

ExecutionArgs.allowedVideoQuality

---

preferredVideoFormat?

optional preferredVideoFormat?: VideoFormat

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

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

Inherited from

ExecutionArgs.preferredVideoFormat

---

preferredVideoCodec?

optional preferredVideoCodec?: VideoCodec

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

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

Inherited from

ExecutionArgs.preferredVideoCodec

---

tagFilterOptions?

optional tagFilterOptions?: TagFilterOptions

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

Tag filtering options

Inherited from

ExecutionArgs.tagFilterOptions

---

maxDownloads?

optional maxDownloads?: number

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

Maximum number of items to download

Inherited from

ExecutionArgs.maxDownloads

---

transformOutput?

optional transformOutput?: boolean

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

Transform output to service-specific result type

Inherited from

ExecutionArgs.transformOutput

---

concurrency?

optional concurrency?: number

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

Download phase concurrency

Inherited from

ExecutionArgs.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

ExecutionArgs.noDownload

---

extractConcurrency?

optional extractConcurrency?: number

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

Extraction phase concurrency

Inherited from

ExecutionArgs.extractConcurrency

---

transcodeOptions?

optional transcodeOptions?: TranscodeOptions

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

Transcoding options

Inherited from

ExecutionArgs.transcodeOptions

---

downloadRetries?

optional downloadRetries?: number

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

Download retry count

Inherited from

ExecutionArgs.downloadRetries

---

retryDelayMs?

optional retryDelayMs?: number

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

Delay between download retries in milliseconds

Inherited from

ExecutionArgs.retryDelayMs

---

pipelineHooks?

optional pipelineHooks?: PipelineHook[]

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

PipelineRegistry lifecycle hooks

Inherited from

ExecutionArgs.pipelineHooks

---

onProgress?

optional onProgress?: (event) => void

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

Progress event handler

Parameters

event

JobProgressEvent

Returns

void

Inherited from

ExecutionArgs.onProgress

---

logProgress?

optional logProgress?: boolean

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

Enables console progress logging

Inherited from

ExecutionArgs.logProgress

---

outputType?

optional outputType?: OutputType

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

Output format for ExecutionCoordinator results

Inherited from

ExecutionArgs.outputType

---

signal?

optional signal?: AbortSignal

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

Abort signal for cancelling the ExecutionCoordinator

Inherited from

ExecutionArgs.signal

---

userAgent?

optional userAgent?: string

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

Inherited from

ExecutionArgs.userAgent

---

enableSniSpoofing?

optional enableSniSpoofing?: boolean

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

Inherited from

ExecutionArgs.enableSniSpoofing

---

proxy?

optional proxy?: ProxyOptions

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

Inherited from

ExecutionArgs.proxy

---

dispatcher?

optional dispatcher?: Dispatcher

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

Inherited from

ExecutionArgs.dispatcher