- initiateDownload(options, [number])
- createRequest(params)
- Request(params)
- startDownload(sudFile)
- suDownloader()
- setSettings(settings)
- QueueDownload(downloadOptions)
- startDownload(key)
- startQueue()
- stopQueue()
- pauseDownload(key)
- resumeDownload(key)
- clearDownload(key, [deleteFile])
public util method to get .sud file
Kind: global constant
Param | Type |
---|---|
filepath | string |
Initiates a download, creating a new .sud file which has relevant metadata appended. Does not return anything.
Kind: global function
Param | Type | Default | Description |
---|---|---|---|
options | object |
||
options.url | string |
url to download | |
options.path | string |
file save path (relative) | |
[number] | 4 |
options.concurrent - number of concurrent downloads |
creates request object and events
Kind: global function
Param | Type | Description |
---|---|---|
params | object |
request params object |
returns response and data streams
Kind: global function
Param | Type | Description |
---|---|---|
params | object |
request params object |
starts/resumes downloading from the specified .sud file returns an observable that emits the progress of the download
Kind: global function
Param | Type | Description |
---|---|---|
sudFile | string |
existing .sud file created with initiateDownload |
create file
Kind: inner constant of startDownload
suDownloader
Kind: global function
Param | Type | Description |
---|---|---|
settings | object |
set downloader settings (maxConcurrentDownloads, autoQueue) |
Kind: global function
Param | Type | Description |
---|---|---|
downloadOptions | object |
adds a download to queue, will automatically start download when queue is free if autoQueue is on |
Kind: global function
Param | Type | Description |
---|---|---|
key | string |
starts a download |
create file
Kind: inner constant of startDownload
starts the queue
stops the queue
Kind: global function
Param | Type | Description |
---|---|---|
key | string |
pauses a download |
Kind: global function
Param | Type | Description |
---|---|---|
key | string |
resumes a paused download |
Kind: global function
Param | Type | Default | Description |
---|---|---|---|
key | object |
||
[deleteFile] | boolean |
false |
whether to delete the file or just clear from queue/active |