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

    Properties

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

    Properties

    -

    Optional Readonly checkActive

    +

    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
    @@ -78,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
    @@ -104,7 +101,7 @@
    +
  • Defined in src/utility-types.ts:79

    • Optional Readonly port

    port?: MessagePort
    @@ -112,7 +109,7 @@
    +
  • Defined in src/utility-types.ts:157

    • Optional Readonly ready

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

    • Optional Readonly statistics

    statistics?: WorkerStatistics
    @@ -128,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:

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

    Optional Readonly taskFunctionOperationStatus

    +
    taskFunctionOperationStatus?: boolean
    +

    Whether the task function operation is successful or not.

    +
    +
    +
    +

    Optional Readonly taskId

    +
    taskId?: string
    +

    Task UUID.

    +
    +

    Optional Readonly taskPerformance

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

    • Optional Readonly timestamp

    timestamp?: number
    @@ -153,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

    @@ -184,78 +244,47 @@
    -
    +
    -

    Generated using TypeDoc

    -
    \ No newline at end of file +

    Generated using TypeDoc

    +
    \ No newline at end of file