X-Git-Url: https://git.piment-noir.org/?a=blobdiff_plain;ds=sidebyside;f=docs%2Finterfaces%2FMessageValue.html;h=8f60cdb1321c7d722e2c98a84811ed901f89686b;hb=52f4e8137eab5d72c663eb9ae9289c08d804e559;hp=3f612975f354af3f49bd21e762b7227701660228;hpb=afa30fd0dd5bbc5d305cc30be663966a449efc08;p=poolifier.git diff --git a/docs/interfaces/MessageValue.html b/docs/interfaces/MessageValue.html index 3f612975..8f60cdb1 100644 --- a/docs/interfaces/MessageValue.html +++ b/docs/interfaces/MessageValue.html @@ -1,4 +1,4 @@ -MessageValue | poolifier
+MessageValue | poolifier - v2.6.12
  • Preparing search index...
    • -
  • The search index is not available
poolifier
+
  • The search index is not available
    • poolifier - v2.6.12
    @@ -14,7 +14,7 @@ -

    Interface MessageValue<Data, MainWorker>Internal

    +

    Interface MessageValue<Data, ErrorData>Internal

    Message object that is passed between main worker and worker.

    @@ -24,12 +24,12 @@
    @@ -39,7 +39,7 @@
    +
  • Defined in src/utility-types.ts:66
    • @@ -47,54 +47,37 @@

    Properties

    -
    data? -elu? -error? -errorData? +
    checkAlive? +data? id? kill? name? -parent? -runTime? +ready? statistics? +taskError? +taskPerformance? timestamp? -waitTime? +workerId

    Properties

    +
    +

    Optional Readonly checkAlive

    +
    checkAlive?: boolean
    +

    Whether the worker starts or stops its aliveness check.

    +
    +
    -

    Optional Readonly data

    +

    Optional Readonly data

    data?: Data

    Task input data that will be passed to the worker.

    -
    -

    Optional Readonly elu

    -
    elu?: EventLoopUtilization
    -

    Event loop utilization.

    -
    -
    -
    -

    Optional Readonly error

    -
    error?: string
    -

    Task error.

    -
    -
    -
    -

    Optional Readonly errorData

    -
    errorData?: unknown
    -

    Task data triggering task error.

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

    • Optional Readonly id

    id?: string
    @@ -103,15 +86,15 @@
    +
  • Defined in src/pools/worker.ts:58

    • Optional Readonly kill

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

    Kill code.

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

    • Optional Readonly name

    name?: string
    @@ -120,31 +103,39 @@
    -
    -

    Optional Readonly parent

    -
    parent?: MainWorker
    -

    Reference to main worker.

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

    Optional Readonly ready

    +
    ready?: boolean
    +

    Whether the worker is ready or not.

    -
    -

    Optional Readonly runTime

    -
    runTime?: number
    -

    Runtime.

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

    Optional Readonly statistics

    +
    statistics?: WorkerStatistics
    +

    Whether the worker computes the given statistics or not.

    -
    -

    Optional Readonly statistics

    -
    statistics?: WorkerStatistics
    -

    Whether to compute the given statistics or not.

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

    Optional Readonly taskError

    +
    taskError?: TaskError<ErrorData>
    +

    Task error.

    +
    +
    +
    +

    Optional Readonly taskPerformance

    +
    taskPerformance?: TaskPerformance
    +

    Task performance.

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

    • Optional Readonly timestamp

    timestamp?: number
    @@ -153,15 +144,16 @@
    -
    -

    Optional Readonly waitTime

    -
    waitTime?: number
    -

    Wait time.

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

    Readonly workerId

    +
    workerId: number
    +

    Worker id.

    +
  • Defined in src/pools/worker.ts:42
    • @@ -181,20 +173,19 @@

    On This Page

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

    • Generated using TypeDoc

    \ No newline at end of file