X-Git-Url: https://git.piment-noir.org/?a=blobdiff_plain;f=docs%2Finterfaces%2FMessageValue.html;h=69e3491a0375082a9c5395f720ca66d2a34d7bbc;hb=f4ff239c096df6dfb39c94eb3f83fd070d3d85d8;hp=ba77a3c678a11c07c438bc7a36b60edaf4454574;hpb=15d6dfaf877ec6a99e2bde48cb3c8a9e8671c075;p=poolifier.git diff --git a/docs/interfaces/MessageValue.html b/docs/interfaces/MessageValue.html index ba77a3c6..69e3491a 100644 --- a/docs/interfaces/MessageValue.html +++ b/docs/interfaces/MessageValue.html @@ -1,4 +1,4 @@ -MessageValue | poolifier
+MessageValue | poolifier - v2.6.23
  • Preparing search index...
    • -
  • The search index is not available
poolifier
+
  • The search index is not available
    • poolifier - v2.6.23
    @@ -14,7 +14,7 @@ -

    Interface MessageValue<Data, MainWorker>Internal

    +

    Interface MessageValue<Data, ErrorData>Internal

    Message object that is passed between main worker and worker.

    @@ -24,12 +24,12 @@
    @@ -39,7 +39,7 @@
    +
  • Defined in src/utility-types.ts:95
    • @@ -47,103 +47,122 @@

    Properties

    -
    data? -error? -errorData? -id? +
    checkActive? +data? kill? name? -parent? -runTime? -submissionTimestamp? -waitTime? +port? +ready? +statistics? +taskError? +taskId? +taskPerformance? +timestamp? +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.

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

    Optional Readonly kill

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

    Kill code.

    +
    +
    +
    +

    Optional Readonly name

    +
    name?: string
    +

    Task name.

    -
    -

    Optional Readonly errorData

    -
    errorData?: unknown
    -

    Task data triggering task error.

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

    Optional Readonly port

    +
    port?: MessagePort
    +

    Message port.

    -
    -

    Optional Readonly id

    -
    id?: string
    -

    Message UUID.

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

    Optional Readonly ready

    +
    ready?: boolean
    +

    Whether the worker is ready or not.

    -
    -

    Optional Readonly kill

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

    Kill code.

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

    Optional Readonly statistics

    +
    statistics?: WorkerStatistics
    +

    Whether the worker computes the given statistics or not.

    -
    -

    Optional Readonly name

    -
    name?: string
    -

    Task name.

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

    Optional Readonly taskError

    +
    taskError?: TaskError<ErrorData>
    +

    Task error.

    -
    -

    Optional Readonly parent

    -
    parent?: MainWorker
    -

    Reference to main worker.

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

    Optional Readonly taskId

    +
    taskId?: string
    +

    Task UUID.

    -
    -

    Optional Readonly runTime

    -
    runTime?: number
    -

    Runtime.

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

    Optional Readonly taskPerformance

    +
    taskPerformance?: TaskPerformance
    +

    Task performance.

    -
    -

    Optional Readonly submissionTimestamp

    -
    submissionTimestamp?: number
    -

    Submission timestamp.

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

    Optional Readonly timestamp

    +
    timestamp?: number
    +

    Timestamp.

    -
    -

    Optional Readonly waitTime

    -
    waitTime?: number
    -

    Wait time.

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

    Readonly workerId

    +
    workerId: number
    +

    Worker id.

    +
  • Defined in src/utility-types.ts:69
    • @@ -163,18 +182,20 @@

    On This Page

    +
  • port
    • +
  • ready
    • +
  • statistics
    • +
  • taskError
    • +
  • taskId
    • +
  • taskPerformance
    • +
  • timestamp
    • +
  • workerId
    • -
    +
  • WorkerTypes
    • +
  • availableParallelism

    • Generated using TypeDoc

    \ No newline at end of file