X-Git-Url: https://git.piment-noir.org/?a=blobdiff_plain;f=docs%2Finterfaces%2FMessageValue.html;h=d59d57f04cb70060cd3036d8b22d6c360b833d3b;hb=800480935c90f3847c389dd5dbfca11760e78675;hp=1cc063bec19077809a1a2550026792d4b72edf5f;hpb=aba8d9bd41f1bd46f3cc3863c0c2e74bdfacb7b6;p=poolifier.git diff --git a/docs/interfaces/MessageValue.html b/docs/interfaces/MessageValue.html index 1cc063be..73546779 100644 --- a/docs/interfaces/MessageValue.html +++ b/docs/interfaces/MessageValue.html @@ -1,20 +1,20 @@ -MessageValue | poolifier
+MessageValue | poolifier - v3.0.1
-
+
  • The search index is not available
    • poolifier - v3.0.1 +
    -

    Interface MessageValue<MessageData, Data, MainWorker>Internal

    +

    Interface MessageValue<Data, ErrorData>Internal

    Message object that is passed between main worker and worker.

    @@ -23,73 +23,76 @@

    Type Parameters

    Hierarchy

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

    Properties

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

    Properties

    -
    -

    Optional Readonly data

    -
    data?: MessageData
    -

    Task input data that will be passed to the worker.

    +
    +

    Optional Readonly checkActive

    +
    checkActive?: boolean
    +

    Whether the worker starts or stops its activity check.

    -
    -

    Optional Readonly id

    -
    id?: string
    -

    Message UUID.

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

    Optional Readonly data

    +
    data?: Data
    +

    Task input data that will be passed to the worker.

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

    • Optional Readonly kill

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

    Kill code.

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

    • Optional Readonly name

    name?: string
    @@ -98,31 +101,85 @@
    -
    -

    Optional Readonly parent

    -
    parent?: MainWorker
    -

    Reference to main worker.

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

    Optional Readonly port

    +
    port?: MessagePort
    +

    Message port.

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

    Optional Readonly ready

    +
    ready?: boolean
    +

    Whether the worker is ready or not.

    +
    +

    Optional Readonly statistics

    statistics?: WorkerStatistics
    -

    Whether to compute the given statistics or not.

    +

    Whether the worker computes the given statistics or not.

    +
    +
    +
    +

    Optional Readonly taskFunction

    +
    taskFunction?: string
    +

    Task function serialized to string.

    -
    -

    Optional Readonly taskError

    -
    taskError?: TaskError<Data>
    -

    Task error.

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

    Optional Readonly taskFunctionName

    +
    taskFunctionName?: string
    +

    Task function name.

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

    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.

    +
    +

    Optional Readonly taskPerformance

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

    • Optional Readonly timestamp

    timestamp?: number
    @@ -139,12 +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.

    +
    +
    +
    +

    Optional Readonly workerId

    +
    workerId?: number
    +

    Worker id.

    +
    +
    -

    Settings

     +

    Settings

    Member Visibility

    @@ -159,77 +242,49 @@

    On This Page

    +
  • timestamp
    • +
  • transferList
    • +
  • workerError
    • +
  • workerId
    • -
    +
    -

    Generated using TypeDoc

    -
    \ No newline at end of file +

    Generated using TypeDoc

    +
    \ No newline at end of file