Options
All
  • Public
  • Public/Protected
  • All
Menu

External module "download"

Index

Type aliases

DownloadClientConfigMappings

DownloadClientConfigMappings: object

Type declaration

DownloadClientConfigTargetType

DownloadClientConfigTargetType: undefined | null | "bool" | "int" | "string_array"

Downloader

Downloader: function

Type declaration

    • (url: Url): Buffer | PromiseLike<Buffer>
    • Parameters

      • url: Url

      Returns Buffer | PromiseLike<Buffer>

Functions

createDownloadConfig

download

  • download(url: string | Url, scopes?: string | string[], outVal?: DownloadOutValue): Promise<Buffer>
  • Downloads something from a source.

    Parameters

    • url: string | Url

      The URL.

    • Optional scopes: string | string[]
    • Optional outVal: DownloadOutValue

    Returns Promise<Buffer>

    The promise with the downloaded data.

download_dropbox

  • download_dropbox(url: Url): Promise<Buffer>

download_ftp

  • download_ftp(url: Url): Promise<Buffer>

download_http

  • download_http(url: Url): Promise<Buffer>

download_sftp

  • download_sftp(url: Url): Promise<Buffer>

download_slack

  • download_slack(url: Url): Promise<Buffer>

getHostAndPort

  • getHostAndPort(url: Url): object
  • Parameters

    • url: Url

    Returns object

    • host: string
    • port: number

getUserNameAndPassword

  • getUserNameAndPassword(url: Url): object
  • Parameters

    • url: Url

    Returns object

    • password: string
    • user: string

Generated using TypeDoc