Options
All
  • Public
  • Public/Protected
  • All
Menu

Model for events emitted by Client.

experimental

Hierarchy

  • ClientEvents

Index

Methods

Methods

done

  • done(success: boolean): void
  • All jobs have completed. The progress event will not trigger again.

    Parameters

    • success: boolean

      whether all jobs were successful.

    Returns void

error

  • error(err: Error): void
  • An unrecoverable network error occurred.

    Parameters

    • err: Error

      the underlying network error

    Returns void

progress

  • One job completed, and returned some data.

    Parameters

    • job: Job

      the job which completed

    • data: JobResult

      the result of that job

    Returns void

Generated using TypeDoc