HLS Downloaderv0.0.0-semantic-release

DownloaderOptions

interface DownloaderOptions extends module:services/HttpClient.HttpClientOptions { concurrency?: number; destination?: string; headers?: Record<string, string>; noProxy?: string[]; overwrite?: boolean; playlistURL: string; proxy?: string; retry?: { delay: number; limit: number }; timeout?: number; }

Source: Downloader.ts:92

Configuration contract for Downloader.

Hierarchy


Properties

concurrency: number

Maximum number of simultaneous network requests.

Default: ```ts (CPU_CORES - 1) ```

destination: string

The local directory where files will be saved. If omitted, the downloader runs in 'dry-run' mode.

Default: ```ts "" ```

headers: Record<string, string>

Inherited from headers

Custom HTTP headers to be sent with every request. Useful for Auth tokens, Cookies, or custom User-Agents.

noProxy: string[]

Inherited from noProxy

List of hostnames that should bypass the proxy

overwrite: boolean

Indicates whether existing files should be overwritten.

Default: ```ts false ```

playlistURL: string

The absolute URL to the master or variant .m3u8 playlist.

proxy: string

Inherited from proxy

Corporate proxy URL (e.g., http://proxy.corp.com:8080)

retry: { delay: number; limit: number }

Inherited from retry

Retry strategy for transient network failures

Properties

  • delay (number) — Base delay in milliseconds for exponential backoff
  • limit (number) — Maximum number of retry attempts

timeout: number

Inherited from timeout

Request timeout in milliseconds (Default: 10000)