X-Git-Url: https://git.piment-noir.org/?a=blobdiff_plain;f=docs%2Finterfaces%2FMessageValue.html;h=f36a76f83b1b98b4701af54744c4ef4581c34c02;hb=93fd07e85783713d3195316fa2e417f0bc97ebbe;hp=b623323ab33337b22b76f66ca989daad08572222;hpb=5e5a659e2b415c7d533dad095eda082989983f8e;p=poolifier.git diff --git a/docs/interfaces/MessageValue.html b/docs/interfaces/MessageValue.html index b623323a..f36a76f8 100644 --- a/docs/interfaces/MessageValue.html +++ b/docs/interfaces/MessageValue.html @@ -1,4 +1,4 @@ -MessageValue | poolifier
+MessageValue | poolifier - v2.6.9
  • Preparing search index...
    • -
  • The search index is not available
poolifier
+
  • The search index is not available
    • poolifier - v2.6.9
    @@ -14,7 +14,7 @@ -

    Interface MessageValue<MessageData, Data, MainWorker>Internal

    +

    Interface MessageValue<Data, ErrorData>Internal

    Message object that is passed between main worker and worker.

    @@ -23,28 +23,23 @@

    Type Parameters

    Hierarchy

    +
  • Defined in src/utility-types.ts:62
    • @@ -53,26 +48,36 @@

    Properties

    data? +dynamic? id? kill? name? -parent? +started? statistics? taskError? taskPerformance? timestamp? +workerId?

    Properties

    Optional Readonly data

    -
    data?: MessageData
    +
    data?: Data

    Task input data that will be passed to the worker.

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

    Optional Readonly dynamic

    +
    dynamic?: boolean
    +

    Whether the worker is dynamic or not.

    +
    +

    Optional Readonly id

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

    • Optional Readonly kill

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

    • Optional Readonly name

    name?: string
    @@ -98,31 +103,31 @@
    -
    -

    Optional Readonly parent

    -
    parent?: MainWorker
    -

    Reference to main worker.

    +
  • Defined in src/pools/worker.ts:43
    • +
    +

    Optional Readonly started

    +
    started?: boolean
    +

    Whether the worker has started or not.

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

    • Optional Readonly statistics

    statistics?: WorkerStatistics
    -

    Whether to compute the given statistics or not.

    +

    Whether the worker computes the given statistics or not.

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

    • Optional Readonly taskError

    -
    taskError?: TaskError<Data>
    +
    taskError?: TaskError<ErrorData>

    Task error.

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

    • Optional Readonly taskPerformance

    taskPerformance?: TaskPerformance
    @@ -130,7 +135,7 @@
    +
  • Defined in src/utility-types.ts:79

    • Optional Readonly timestamp

    timestamp?: number
    @@ -139,7 +144,15 @@
    +
  • Defined in src/pools/worker.ts:51
    • +
    +

    Optional Readonly workerId

    +
    workerId?: number
    +

    Worker id.

    +
    +
    @@ -160,16 +173,18 @@
    +
  • timestamp
    • +
  • workerId
    • -
    +
  • WorkerTypes
    • +
  • availableParallelism

    • Generated using TypeDoc

    \ No newline at end of file