X-Git-Url: https://git.piment-noir.org/?a=blobdiff_plain;f=docs%2Finterfaces%2FMessageValue.html;h=2d134e0ad7d60f7c751bb0a6637ab706e5b67650;hb=cb4889b43e6935f6dd70d8011ba085c9ca7218ba;hp=7f6d59ce82193feacd5b8ed8c942f4cd3a09bfaf;hpb=2f4ae5a6c14efa15bafa4ab0e68f166ec80d719b;p=poolifier.git diff --git a/docs/interfaces/MessageValue.html b/docs/interfaces/MessageValue.html index 7f6d59ce..ca097c8c 100644 --- a/docs/interfaces/MessageValue.html +++ b/docs/interfaces/MessageValue.html @@ -1,171 +1,245 @@ -MessageValue | poolifier
+MessageValue | poolifier - v2.6.41
-
+
  • The search index is not available
    • poolifier - v2.6.41 +
    -

    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? -id? -kill? -parent? -runTime? +
    checkActive? +data? +kill? +name? +port? +ready? +statistics? +taskError? +taskFunctions? +taskId? +taskPerformance? +timestamp? +transferList? +workerId

    Properties

    -
    -

    Optional Readonly data

    -
    data?: Data
    +
    +

    Optional Readonly checkActive

    +
    checkActive?: boolean
    +

    Whether the worker starts or stops its activity check.

    +
    +
    +
    +

    Optional Readonly data

    +
    data?: Data

    Task input data that will be passed to the worker.

    -
    -
    -

    Optional Readonly error

    -
    error?: string
    -

    Error.

    -
    -
    -

    Optional Readonly id

    -
    id?: string
    -

    UUID of the message.

    -
    -
    -

    Optional Readonly kill

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

    Optional Readonly kill

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

    Kill code.

    -
    -
    -

    Optional Readonly parent

    -
    parent?: MainWorker
    -

    Reference to main worker.

    -
    -
    -

    Optional Readonly runTime

    -
    runTime?: number
    -

    Runtime.

    -
    + +
    +
    +

    Optional Readonly name

    +
    name?: string
    +

    Task name.

    +
    +
    +
    +

    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 taskError

    +
    taskError?: TaskError<ErrorData>
    +

    Task error.

    +
    +
    +
    +

    Optional Readonly taskFunctions

    +
    taskFunctions?: string[]
    +

    Task function names.

    +
    +
    +
    +

    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.

    +
    +
    +
    +

    Readonly workerId

    +
    workerId: number
    +

    Worker id.

    +
    +
    -

    Settings

     +

    Settings

    Member Visibility

      -
      • -
      • -
      • -
    +
    • +
    • +
    • +
    • -

    Theme

    +

    Theme

    -

    On This Page

     +

    On This Page

    +
  • checkActive
    • +
  • data
    • +
  • kill
    • +
  • name
    • +
  • port
    • +
  • ready
    • +
  • statistics
    • +
  • taskError
    • +
  • taskFunctions
    • +
  • taskId
    • +
  • taskPerformance
    • +
  • timestamp
    • +
  • transferList
    • +
  • workerId
    • -
    +
    -

    Generated using TypeDoc

    -
    \ No newline at end of file +

    Generated using TypeDoc

    +
    \ No newline at end of file