HLSDownloader. Downloader

Main donwloader class of HLSDownloader Package

Constructor

new Downloader(downloderOptions)

Parameters:
NameTypeDescription
downloderOptionsobject

Options to build downloader

Properties
NameTypeAttributesDefaultDescription
playlistURLstring

Playlist URL to download

concurrencynumber<optional>
1

concurrency limit to download playlist chunk

destinationobject<optional>
''

Absolute path to download

onDataobject | function<optional>
null

onData hook

onErrorobject | function<optional>
null

onError hook

overwriteboolean<optional>
false

Overwrite files toggler

optionsobject<optional>
{}

Options to override from Ky

Author
  • Nur Rony<pro.nmrony@gmail.com>
Source
Throws:

  • TypeError

  • ProtocolNotSupported

Members

concurrency :number

Concurrency limit to download items

Type:
  • number
Default Value
  • 1
Source

defaultKyOptions :object

Default Ky options values set by HLSDownloader

Type:
  • object
Default Value
  • {
  retry: { limit: 0 }
}
Source

destination :string

Absolute path to download the TS files with corresponding playlist file

Type:
  • string
Default Value
  • ''
Source

errors :Array.<{url: string, name: string, message: string}>

items that are not downloaded successfully

Type:
  • Array.<{url: string, name: string, message: string}>
Source

items :Array.<string>

items that are downloaded successfully

Type:
  • Array.<string>
Source

kyOptions :object

Extra options to pass into Ky

Type:
  • object
Default Value
  • {}
Source

onData :function|null

Function to track downloaded data

Type:
  • function | null
Default Value
  • null
Source

onError :function|null

Function to track error

Type:
  • function | null
Default Value
  • null
Source

overwrite :boolean

concurrency controller

Type:
  • boolean
Default Value
  • false
Source

playlistURL :string

Playlist URL to download

Type:
  • string
Default Value
  • ''
Source

pool :object

concurrency controller

Type:
  • object
Default Value
  • 1
Source

unSupportedOptions :Array.<string>

Type:
  • Array.<string>
Default Value
  • [
 'uri',
 'url',
 'json',
 'form',
 'body',
 'method',
 'setHost',
 'isStream',
 'parseJson',
 'prefixUrl',
 'cookieJar',
 'playlistURL',
 'concurrency',
 'allowGetBody',
 'stringifyJson',
 'methodRewriting'
]
Source

Methods

(async) createDirectory(url) → {Promise.<string>}

create directory to download

Parameters:
NameTypeDescription
urlstring

url to construct the path from

Source
Returns:

destination path

Type: 
Promise.<string>

(async) downloadItem(item) → {Promise.<any>}

Download each iteam

Parameters:
NameTypeDescription
itemstring

item to download

Source
Returns:
Type: 
Promise.<any>

(async) downloadItems() → {Promise.<any>}

Download playlist and items

Source
Returns:
Type: 
Promise.<any>

(async) fetchItems() → {Promise.<any>}

Fetch playlist items

Source
Returns:
Type: 
Promise.<any>

(async) fetchPlaylist() → {Promise.<{url, body}>}

fetch playlist content

Source
Returns:
Type: 
Promise.<{url, body}>

formatPlaylistContent(playlistContentResults) → {Array.<{url: string, body: string}>}

filter playlist contents

Parameters:
NameTypeDescription
playlistContentResultsArray.<object>

list of fetched playlist content

Source
Returns:

list of object containing url and its content

Type: 
Array.<{url: string, body: string}>

mergeOptions(options) → {object}

merge options

Parameters:
NameTypeDescription
optionsobject
Source
Returns:
Type: 
object

parsePlaylist(playlistContent)

Parse playlist content and index the TS chunk to download.

Parameters:
NameTypeDescription
playlistContentstring
Source
Returns:

string[] Array of url

(async) processPlaylistItems() → {Promise.<any>}

Process playlist items

Source
Returns:
Type: 
Promise.<any>

(async) shouldOverwrite(url) → {Promise.<boolean>}

Checks for overwrite flag

Parameters:
NameTypeDescription
urlstring

url to build path from

Source
Returns:
Type: 
Promise.<boolean>