RetrieverInterface: {
    buildPath(url: string): string;
    download(url: string): Promise<string>;
    getBasePath(): string;
    retrieve(url: string): Promise<string>;
    retrieveHistory(): Record<string, string>;
}

Type declaration

  • buildPath:function
    • Return the path where an url would be located

      Parameters

      • url: string

      Returns string

  • download:function
    • Download an url without its related resources Return the path where the resource is located (as in buildPath)

      Parameters

      • url: string

      Returns Promise<string>

  • getBasePath:function
    • Must return the base path where the elements will be downloaded

      Returns string

  • retrieve:function
    • 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>

  • retrieveHistory:function
    • 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>

Generated using TypeDoc