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

    Interface MessageValue<Data, MainWorker>Internal

    +

    Interface MessageValue<Data, ErrorData>Internal

    Message object that is passed between main worker and worker.

    -
    +
    +

    Type Parameters

    +

    ErrorData = unknown

    +

    Type of data sent to the worker triggering an error. This can only be structured-cloneable data.

    +
    +

    Hierarchy

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

    Properties

    -
    data? -error? -errorData? -id? -kill? -name? -parent? -runTime? -submissionTimestamp? -waitTime? +
    checkActive? +data? +kill? +name? +port? +ready? +statistics? +taskFunction? +taskFunctionName? +taskFunctionNames? +taskFunctionOperation? +taskFunctionOperationStatus? +taskId? +taskPerformance? +timestamp? +transferList? +workerError? +workerId?

    Properties

    +
    +

    Optional Readonly checkActive

    +
    checkActive?: boolean
    +

    Whether the worker starts or stops its activity check.

    +
    +
    -

    Optional Readonly data

    +

    Optional Readonly data

    data?: Data

    Task input data that will be passed to the worker.

    -
    -
    -

    Optional Readonly error

    -
    error?: string
    -

    Task error.

    -
    -
    -

    Optional Readonly errorData

    -
    errorData?: unknown
    -

    Task data triggering task error.

    -
    -
    -

    Optional Readonly id

    -
    id?: string
    -

    Message UUID.

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

    Optional Readonly kill

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

    Optional Readonly kill

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

    Kill code.

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

    Optional Readonly name

    +

    Optional Readonly name

    name?: string

    Task name.

    -
    -
    -

    Optional Readonly parent

    -
    parent?: MainWorker
    -

    Reference to main worker.

    -
    -
    -

    Optional Readonly runTime

    -
    runTime?: number
    -

    Runtime.

    -
    -
    -

    Optional Readonly submissionTimestamp

    -
    submissionTimestamp?: number
    -

    Submission timestamp.

    -
    -
    -

    Optional Readonly waitTime

    -
    waitTime?: number
    -

    Wait time.

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

    Optional Readonly port

    +
    port?: MessagePort
    +

    Message port.

    +
    +
    +
    +

    Optional Readonly ready

    +
    ready?: boolean
    +

    Whether the worker is ready or not.

    +
    +
    +
    +

    Optional Readonly statistics

    +
    statistics?: WorkerStatistics
    +

    Whether the worker computes the given statistics or not.

    +
    +
    +
    +

    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:

    + +
    +
    +
    +

    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
    +

    Task performance.

    +
    +
    +
    +

    Optional Readonly timestamp

    +
    timestamp?: number
    +

    Timestamp.

    +
    +
    +
    +

    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

    @@ -147,65 +239,52 @@

    Theme

    -

    On This Page

     +

    On This Page

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

    Generated using TypeDoc

    -
    \ No newline at end of file +

    Generated using TypeDoc

    +
    \ No newline at end of file