X-Git-Url: https://git.piment-noir.org/?a=blobdiff_plain;f=docs%2Finterfaces%2FMessageValue.html;h=52aff7ae87c0251a05a6eeedaf74cb1312f7f6fb;hb=88499cf9c298c12aa8235e60d27657f50d3c38ee;hp=7eea515565d6cc48dfe6d446c2b0b7a4ab79c89f;hpb=6be0ab6d5c78c8e91cc4668d3d03db95f15cbfab;p=poolifier.git diff --git a/docs/interfaces/MessageValue.html b/docs/interfaces/MessageValue.html index 7eea5155..52aff7ae 100644 --- a/docs/interfaces/MessageValue.html +++ b/docs/interfaces/MessageValue.html @@ -1,4 +1,4 @@ -MessageValue | poolifier
+MessageValue | poolifier - v2.6.17
  • Preparing search index...
    • -
  • The search index is not available
poolifier
+
  • The search index is not available
    • poolifier - v2.6.17
    @@ -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:95
    • @@ -52,27 +47,37 @@

    Properties

    -
    data? +
    checkActive? +data? id? kill? name? -parent? +ready? statistics? taskError? taskPerformance? timestamp? +workerId

    Properties

    +
    +

    Optional Readonly checkActive

    +
    checkActive?: boolean
    +

    Whether the worker starts or stops its activity check.

    +
    +
    -

    Optional Readonly data

    -
    data?: MessageData
    +

    Optional Readonly data

    +
    data?: Data

    Task input data that will be passed to the worker.

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

    • Optional Readonly id

    id?: string
    @@ -81,15 +86,15 @@
    +
  • Defined in src/utility-types.ts:85

    • Optional Readonly kill

    -
    kill?: 1 | "SOFT" | "HARD"
    +
    kill?: true | "SOFT" | "HARD"

    Kill code.

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

    • Optional Readonly name

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

    Optional Readonly parent

    -
    parent?: MainWorker
    -

    Reference to main worker.

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

    Optional Readonly ready

    +
    ready?: boolean
    +

    Whether the worker is ready or not.

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

    • 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:112

    • Optional Readonly taskError

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

    Task error.

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

    • Optional Readonly taskPerformance

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

    • Optional Readonly timestamp

    timestamp?: number
    @@ -139,7 +144,16 @@
    +
  • Defined in src/utility-types.ts:81
    • +
    +

    Readonly workerId

    +
    workerId: number
    +

    Worker id.

    +
    +
    @@ -159,17 +173,19 @@

    On This Page

    +
  • timestamp
    • +
  • workerId
    • -
    +
  • WorkerTypes
    • +
  • availableParallelism

    • Generated using TypeDoc

    \ No newline at end of file