X-Git-Url: https://git.piment-noir.org/?a=blobdiff_plain;f=docs%2Finterfaces%2FMessageValue.html;h=d59d57f04cb70060cd3036d8b22d6c360b833d3b;hb=800480935c90f3847c389dd5dbfca11760e78675;hp=ea1fef1972916f3da1467d2ad19b396f9635b70a;hpb=a97f9c80aa49c6152547fb6fa8de4b0f089c2353;p=poolifier.git diff --git a/docs/interfaces/MessageValue.html b/docs/interfaces/MessageValue.html index ea1fef19..73546779 100644 --- a/docs/interfaces/MessageValue.html +++ b/docs/interfaces/MessageValue.html @@ -1,13 +1,13 @@ -MessageValue | poolifier
+MessageValue | poolifier - v3.0.1
-
+
  • The search index is not available
  • poolifier - v3.0.1 +
    @@ -39,51 +39,60 @@
    • MessageValue
    +
  • Defined in src/utility-types.ts:105
  • - +

    Properties

    +
    + +
    checkActive?: boolean
    +

    Whether the worker starts or stops its activity check.

    +
    +
    - +
    data?: Data

    Task input data that will be passed to the worker.

    -
    - -
    id?: string
    -

    Message UUID.

    -
    -
    +
  • Defined in src/utility-types.ts:83
  • -
    kill?: 1 | "SOFT" | "HARD"
    +
    kill?: true | "success" | "SOFT" | "HARD" | "failure"

    Kill code.

    +
  • Defined in src/utility-types.ts:110
  • name?: string
    @@ -92,7 +101,23 @@
    +
  • Defined in src/utility-types.ts:79
  • +
    + +
    port?: MessagePort
    +

    Message port.

    +
    +
    +
    + +
    ready?: boolean
    +

    Whether the worker is ready or not.

    +
    +
    statistics?: WorkerStatistics
    @@ -100,15 +125,61 @@
    -
    - -
    taskError?: TaskError<ErrorData>
    -

    Task error.

    +
  • Defined in src/utility-types.ts:145
  • +
    + +
    taskFunction?: string
    +

    Task function serialized to string.

    +
    +
    +
    + +
    taskFunctionName?: string
    +

    Task function name.

    +
  • Defined in src/utility-types.ts:137
  • +
    + +
    taskFunctionNames?: string[]
    +

    Task function names.

    +
    +
    +
    + +
    taskFunctionOperation?: "add" | "default" | "remove"
    +

    Task function operation:

    +
      +
    • 'add' - Add a task function.
    • +
    • 'remove' - Remove a task function.
    • +
    • 'default' - Set a task function as default.
    • +
    +
    +
    +
    + +
    taskFunctionOperationStatus?: boolean
    +

    Whether the task function operation is successful or not.

    +
    +
    +
    + +
    taskId?: string
    +

    Task UUID.

    +
    +
    taskPerformance?: TaskPerformance
    @@ -116,7 +187,7 @@
    +
  • Defined in src/utility-types.ts:118
  • timestamp?: number
    @@ -125,12 +196,38 @@
    +
  • Defined in src/utility-types.ts:91
  • +
    + +
    transferList?: TransferListItem[]
    +

    Array of transferable objects.

    +
    +
    +
    + +
    workerError?: WorkerError<ErrorData>
    +

    Worker error.

    +
    +
    +
    + +
    workerId?: number
    +

    Worker id.

    +
    +
    +
    -

    Generated using TypeDoc

    -
    \ No newline at end of file +

    Generated using TypeDoc

    +
    \ No newline at end of file