X-Git-Url: https://git.piment-noir.org/?a=blobdiff_plain;ds=sidebyside;f=docs%2Finterfaces%2FMessageValue.html;h=7e22a7ecb8cfd56a120c728cc4a6a67e2ab13522;hb=8c6d4acf22398bf755be85612cf1e79f3dd5fbf7;hp=d9b845fa1c5f5ed6af55eaf12feb42efe29f28a2;hpb=aac8863d208eadcb0ecb33dc44d045c26f5a444f;p=poolifier.git diff --git a/docs/interfaces/MessageValue.html b/docs/interfaces/MessageValue.html index d9b845fa..7e22a7ec 100644 --- a/docs/interfaces/MessageValue.html +++ b/docs/interfaces/MessageValue.html @@ -1,4 +1,4 @@ -MessageValue | poolifier
+MessageValue | poolifier - v2.6.25
  • Preparing search index...
    • -
  • The search index is not available
poolifier
+
  • The search index is not available
    • poolifier - v2.6.25
    @@ -14,7 +14,7 @@ -

    Interface MessageValue<MessageData, Data, MainWorker>Internal

    +

    Interface MessageValue<Data, ErrorData>Internal

    Message object that is passed between main worker and worker.

    @@ -23,28 +23,23 @@

    Type Parameters

    Hierarchy

    +
  • Defined in src/utility-types.ts:99
    • @@ -52,44 +47,47 @@

    Properties

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

    Optional Readonly data

    +
    data?: Data
    +

    Task input data that will be passed to the worker.

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

    • Optional Readonly kill

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

    Kill code.

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

    • Optional Readonly name

    name?: string
    @@ -98,31 +96,48 @@
    -
    -

    Optional Readonly parent

    -
    parent?: MainWorker
    -

    Reference to main worker.

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

    Optional Readonly port

    +
    port?: MessagePort
    +

    Message port.

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

    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.

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

    • Optional Readonly taskError

    -
    taskError?: TaskError<Data>
    +
    taskError?: TaskError<ErrorData>

    Task error.

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

    Optional Readonly taskId

    +
    taskId?: string
    +

    Task UUID.

    +
    +

    Optional Readonly taskPerformance

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

    • Optional Readonly timestamp

    timestamp?: number
    @@ -139,7 +154,25 @@
    +
  • Defined in src/utility-types.ts:85
    • +
    +

    Optional Readonly transferList

    +
    transferList?: TransferListItem[]
    +

    Array of transferable objects.

    +
    +
    +
    +

    Readonly workerId

    +
    workerId: number
    +

    Worker id.

    +
    +
    @@ -159,17 +192,21 @@

    On This Page

    +
  • timestamp
    • +
  • transferList
    • +
  • workerId
    • -
    +
  • WorkerTypes
    • +
  • availableParallelism

    • Generated using TypeDoc

    \ No newline at end of file