Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface IDownloadEventEmitter2

Hierarchy

  • IDownloadEventEmitter2

Index

Events

error

error: function

triggered by startDownloading2 when there is an error. Use [[on]] to subscribe for this event.

Type declaration

    • (event: Error): void
    • Parameters

      • event: Error

      Returns void

finish

finish: function

triggered by [[startDownloading]] when there is an download ends. Use [[on]] to subscribe for this event.

Type declaration

    • (event: object): void
    • Parameters

      • event: object
        • bytes: Buffer
        • codec: number[]
        • url: String
        • when: Date

      Returns void

progress

progress: function

triggered by [[startDownloading]] on progress. Use [[on]] to subscribe for this event.

Type declaration

    • (event: object): void
    • Parameters

      • event: object
        • bytes: Buffer
        • codec: number[]
        • progress: number
        • url: String
        • when: Date

      Returns void

Methods

startDownloading2

  • startDownloading2(config: object): Promise<any>
  • This method trigger events. Unfortunately I don't know yet how to express that in typedoc. This method might trigger error event in case something goes wrong or if it rains. Also susceptible of triggering progress event ro indicate how is going and finish when is done ni which case resolve returned

    Parameters

    • config: object
      • data: number[]
      • ts: Date
      • url: string

    Returns Promise<any>

Generated using TypeDoc