Interface WebSocketEvents

interface WebSocketEvents {
    onCollected?: ((files?) => Awaitable<void>);
    onFinished?: ((files?, errors?) => Awaitable<void>);
    onPathsCollected?: ((paths?) => Awaitable<void>);
    onTaskUpdate?: ((packs) => Awaitable<void>);
    onUserConsoleLog?: ((log) => Awaitable<void>);
    onCancel(reason): void;
}

Hierarchy

  • Pick<Reporter, "onCollected" | "onFinished" | "onTaskUpdate" | "onUserConsoleLog" | "onPathsCollected">
    • WebSocketEvents

Properties

onCollected? onFinished? onPathsCollected? onTaskUpdate? onUserConsoleLog?

Methods

onCancel

Properties

Optional onCollected

onCollected?: ((files?) => Awaitable<void>)

Type declaration

Optional onFinished

onFinished?: ((files?, errors?) => Awaitable<void>)

Type declaration

    • (files?, errors?): Awaitable<void>

    • Parameters

      • Optional files: File[]
      • Optional errors: unknown[]

      Returns Awaitable<void>

Optional onPathsCollected

onPathsCollected?: ((paths?) => Awaitable<void>)

Type declaration

Optional onTaskUpdate

onTaskUpdate?: ((packs) => Awaitable<void>)

Type declaration

Optional onUserConsoleLog

onUserConsoleLog?: ((log) => Awaitable<void>)

Type declaration

Methods

onCancel

  • onCancel(reason): void

  • Parameters

    • reason: CancelReason

    Returns void

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc