X-Git-Url: https://git.piment-noir.org/?a=blobdiff_plain;f=docs%2Finterfaces%2FMessageValue.html;h=1cc063bec19077809a1a2550026792d4b72edf5f;hb=e8b3a5abad7d3ae4fa836ab0b76d54c1efd146e9;hp=ba77a3c678a11c07c438bc7a36b60edaf4454574;hpb=8d20e449d72975f6add9177d1097d5a204d14f71;p=poolifier.git diff --git a/docs/interfaces/MessageValue.html b/docs/interfaces/MessageValue.html index ba77a3c6..1cc063be 100644 --- a/docs/interfaces/MessageValue.html +++ b/docs/interfaces/MessageValue.html @@ -14,7 +14,7 @@ -

Interface MessageValue<Data, MainWorker>Internal

+

Interface MessageValue<MessageData, Data, MainWorker>Internal

Message object that is passed between main worker and worker.

@@ -23,6 +23,11 @@

Type Parameters

@@ -48,43 +53,26 @@

Properties

data? -error? -errorData? id? kill? name? parent? -runTime? -submissionTimestamp? -waitTime? +statistics? +taskError? +taskPerformance? +timestamp?

Properties

Optional Readonly data

-
data?: Data
+
data?: MessageData

Task input data that will be passed to the worker.

-
-

Optional Readonly error

-
error?: string
-

Task error.

-
-
-
-

Optional Readonly errorData

-
errorData?: unknown
-

Task data triggering task error.

-
-
+
  • Defined in src/pools/worker.ts:47

    • Optional Readonly id

    id?: string
    @@ -93,7 +81,7 @@
    +
  • Defined in src/pools/worker.ts:55

    • Optional Readonly kill

    kill?: 1 | "SOFT" | "HARD"
    @@ -101,7 +89,7 @@
    +
  • Defined in src/utility-types.ts:72

    • Optional Readonly name

    name?: string
    @@ -110,7 +98,7 @@
    +
  • Defined in src/pools/worker.ts:43

    • Optional Readonly parent

    parent?: MainWorker
    @@ -118,32 +106,40 @@
    -
    -

    Optional Readonly runTime

    -
    runTime?: number
    -

    Runtime.

    +
  • Defined in src/utility-types.ts:84
    • +
    +

    Optional Readonly statistics

    +
    statistics?: WorkerStatistics
    +

    Whether to compute the given statistics or not.

    +
    +
    +
    +

    Optional Readonly taskError

    +
    taskError?: TaskError<Data>
    +

    Task error.

    -
    -

    Optional Readonly submissionTimestamp

    -
    submissionTimestamp?: number
    -

    Submission timestamp.

    +
  • Defined in src/utility-types.ts:76
    • +
    +

    Optional Readonly taskPerformance

    +
    taskPerformance?: TaskPerformance
    +

    Task performance.

    -
    -

    Optional Readonly waitTime

    -
    waitTime?: number
    -

    Wait time.

    +
  • Defined in src/utility-types.ts:80
    • +
    +

    Optional Readonly timestamp

    +
    timestamp?: number
    +

    Timestamp.

    +
  • Defined in src/pools/worker.ts:51
    • @@ -164,15 +160,14 @@
    +
  • statistics
    • +
  • taskError
    • +
  • taskPerformance
    • +
  • timestamp