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

    Properties

    -
    checkAlive? +
    checkActive? data? -id? kill? name? +port? ready? statistics? -taskError? +taskFunction? +taskFunctionName? +taskFunctionNames? +taskFunctionOperation? +taskFunctionOperationStatus? +taskId? taskPerformance? timestamp? -workerId +transferList? +workerError? +workerId?

    Properties

    -
    -

    Optional Readonly checkAlive

    -
    checkAlive?: boolean
    -

    Whether the worker starts or stops its aliveness check.

    +
    +

    Optional Readonly checkActive

    +
    checkActive?: boolean
    +

    Whether the worker starts or stops its activity check.

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

    • Optional Readonly data

    data?: Data
    @@ -77,24 +84,15 @@
    -
    -

    Optional Readonly id

    -
    id?: string
    -

    Message UUID.

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

    • Optional Readonly kill

    -
    kill?: true | "SOFT" | "HARD"
    +
    kill?: true | "success" | "SOFT" | "HARD" | "failure"

    Kill code.

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

    • Optional Readonly name

    name?: string
    @@ -103,7 +101,15 @@
    +
  • Defined in src/utility-types.ts:79
    • +
    +

    Optional Readonly port

    +
    port?: MessagePort
    +

    Message port.

    +
    +

    Optional Readonly ready

    ready?: boolean
    @@ -111,7 +117,7 @@
    +
  • Defined in src/utility-types.ts:149

    • Optional Readonly statistics

    statistics?: WorkerStatistics
    @@ -119,15 +125,61 @@
    -
    -

    Optional Readonly taskError

    -
    taskError?: TaskError<ErrorData>
    -

    Task error.

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

    Optional Readonly taskFunction

    +
    taskFunction?: string
    +

    Task function serialized to string.

    +
    +
    +
    +

    Optional Readonly taskFunctionName

    +
    taskFunctionName?: string
    +

    Task function name.

    +
    +
    +
    +

    Optional Readonly taskFunctionNames

    +
    taskFunctionNames?: string[]
    +

    Task function names.

    +
    +
    +
    +

    Optional Readonly taskFunctionOperation

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

    Task function operation:

    +
      +
    • 'add' - Add a task function.
      • +
    • 'remove' - Remove a task function.
      • +
    • 'default' - Set a task function as default.
      • +
    +
    +
    +
    +

    Optional Readonly taskFunctionOperationStatus

    +
    taskFunctionOperationStatus?: boolean
    +

    Whether the task function operation is successful or not.

    +
    +
    +
    +

    Optional Readonly taskId

    +
    taskId?: string
    +

    Task UUID.

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

    • Optional Readonly taskPerformance

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

    • Optional Readonly timestamp

    timestamp?: number
    @@ -144,21 +196,38 @@
    +
  • Defined in src/utility-types.ts:91
    • +
    +

    Optional Readonly transferList

    +
    transferList?: TransferListItem[]
    +

    Array of transferable objects.

    +
    +
    +
    +

    Optional Readonly workerError

    +
    workerError?: WorkerError<ErrorData>
    +

    Worker error.

    +
    +
    -

    Readonly workerId

    -
    workerId: number
    +

    Optional Readonly workerId

    +
    workerId?: number

    Worker id.

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

    Settings

     +

    Settings

    Member Visibility

    @@ -173,79 +242,49 @@

    On This Page

    -
    +
    -

    Generated using TypeDoc

    -
    \ No newline at end of file +

    Generated using TypeDoc

    +
    \ No newline at end of file