Classdefault`Abstract`

Hierarchy (view full)

default
- default

Implements

RetrieverInterface

Index

Constructors

Methods

addToHistory buildPath checkIsValidDownloadedFile clearHistory download getBasePath getDownloader retrieve retrieveHistory setDownloader urlParts

Constructors

`Protected`constructor

new default(basePath, downloader?): default
Retriever constructor
Parameters
- basePath: string
  path base
- Optionaldownloader: DownloaderInterface
  implementation of downloader interface
Returns default
- Defined in abstract_base_retriever.ts:23

Methods

`Protected`addToHistory

addToHistory(source, localPath): void
Parameters
- source: string
- localPath: string
Returns void
- Defined in abstract_base_retriever.ts:86

buildPath

buildPath(url): string
Return the path where an url would be located
Parameters
- url: string
Returns string
Implementation of RetrieverInterface.buildPath
- Defined in abstract_base_retriever.ts:40

`Protected` `Abstract`checkIsValidDownloadedFile

checkIsValidDownloadedFile(source, localPath): Promise<void>
Parameters
- source: string
- localPath: string
Returns Promise<void>
- Defined in abstract_base_retriever.ts:114

`Protected`clearHistory

clearHistory(): void
Returns void
- Defined in abstract_base_retriever.ts:82

download

download(url): Promise<string>
Download an url without its related resources Return the path where the resource is located (as in buildPath)
Parameters
- url: string
Returns Promise<string>
Implementation of RetrieverInterface.download
- Defined in abstract_base_retriever.ts:49

getBasePath

getBasePath(): string
Must return the base path where the elements will be downloaded

Returns string
Implementation of RetrieverInterface.getBasePath
- Defined in abstract_base_retriever.ts:28

getDownloader

getDownloader(): DownloaderInterface
Returns DownloaderInterface
- Defined in abstract_base_retriever.ts:32

`Abstract`retrieve

retrieve(url): Promise<string>
Retrieve an url and all its related resources Return the path where the resource is located (as in buildPath)
Parameters
- url: string
Returns Promise<string>
Implementation of RetrieverInterface.retrieve
- Defined in abstract_base_retriever.ts:80

retrieveHistory

retrieveHistory(): Record<string, string>
Returns the history of the last retrieve operation The return is un record of key value pairs where the key is the url retrieved and the value is the path

Returns Record<string, string>
Implementation of RetrieverInterface.retrieveHistory
- Defined in abstract_base_retriever.ts:76

setDownloader

setDownloader(downloader): void
Parameters
- downloader: DownloaderInterface
Returns void
- Defined in abstract_base_retriever.ts:36

`Protected`urlParts

urlParts(url): undefined | Record<string, string>
Retrieve url parts If url is malformed return false
Parameters
- url: string
  string url
Returns undefined | Record<string, string>
- Defined in abstract_base_retriever.ts:96