@ourongxing/downloader/Downloader.td.ts

A file downloader for NodeJs

import http from "http"
export default Downloader

interface DownloaderConfig {
  url: string
  directory?: string
  fileName?: string
  useHashFileName?: boolean
  cloneFiles?: boolean
  skipExistingFileName?: boolean
  timeout?: number
  maxAttempts?: number
  headers?: object
  httpsAgent?: any
  proxy?: string
  onError?(e: Error): void
  onResponse?(r: http.IncomingMessage): boolean | void
  onBeforeSave?(finalName: string): string | void
  onProgress?(percentage: string, chunk: object, remainingSize: number): void
  shouldStop?(e: Error): boolean | void
  shouldBufferResponse?: boolean
  useSynchronousMode?: boolean
}

type DownloaderReport =
  | {
      downloadStatus: "ABORTED"
    }
  | {
      downloadStatus: "COMPLETE"
      filePath: string
      fileName: string
      fileHash: string
    }
declare class Downloader {
  constructor(config: DownloaderConfig)

  download(): Promise<DownloaderReport>

  cancel(): void
}