X-Git-Url: https://git.piment-noir.org/?a=blobdiff_plain;f=docs%2Finterfaces%2FMessageValue.html;h=8f60cdb1321c7d722e2c98a84811ed901f89686b;hb=52f4e8137eab5d72c663eb9ae9289c08d804e559;hp=2f0e901657f94d5b26d3a2cddcfe34b5bcbec0f2;hpb=6c7727ff79d651547ca10f44504d61e5073f07da;p=poolifier.git diff --git a/docs/interfaces/MessageValue.html b/docs/interfaces/MessageValue.html index 2f0e9016..8f60cdb1 100644 --- a/docs/interfaces/MessageValue.html +++ b/docs/interfaces/MessageValue.html @@ -1,4 +1,4 @@ -MessageValue | poolifier
+MessageValue | poolifier - v2.6.12
  • Preparing search index...
    • -
  • The search index is not available
poolifier
+
  • The search index is not available
    • poolifier - v2.6.12
    @@ -14,21 +14,24 @@ -

    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:66
    • @@ -44,73 +47,118 @@

    Properties

    -
    data? -error? -id? -kill? -name? -parent? -runTime? +
    checkAlive? +data? +id? +kill? +name? +ready? +statistics? +taskError? +taskPerformance? +timestamp? +workerId

    Properties

    +
    +

    Optional Readonly checkAlive

    +
    checkAlive?: boolean
    +

    Whether the worker starts or stops its aliveness check.

    +
    +
    -

    Optional Readonly data

    +

    Optional Readonly data

    data?: Data

    Task input data that will be passed to the worker.

    -
    -
    -

    Optional Readonly error

    -
    error?: string
    -

    Error.

    -
    +
  • Defined in src/pools/worker.ts:50
    • -

    Optional Readonly id

    +

    Optional Readonly id

    id?: string

    Message UUID.

    -
    +
  • Defined in src/pools/worker.ts:58
    • -

    Optional Readonly kill

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

    Optional Readonly kill

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

    Kill code.

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

    Optional Readonly name

    +

    Optional Readonly name

    name?: string

    Task name.

    -
    -
    -

    Optional Readonly parent

    -
    parent?: MainWorker
    -

    Reference to main worker.

    -
    +
    +

    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 taskPerformance

    +
    taskPerformance?: TaskPerformance
    +

    Task performance.

    +
    +
    +
    +

    Optional Readonly timestamp

    +
    timestamp?: number
    +

    Timestamp.

    +
    +
    -
    -

    Optional Readonly runTime

    -
    runTime?: number
    -

    Runtime.

    -
    +
    +

    Readonly workerId

    +
    workerId: number
    +

    Worker id.

    +
    +
    +
  • Defined in src/pools/worker.ts:42
    • -

    Settings

     +

    Settings

    Member Visibility

    @@ -122,62 +170,82 @@

    Theme

    -

    On This Page

     +

    On This Page

    +
  • checkAlive
    • +
  • data
    • +
  • id
    • +
  • kill
    • +
  • name
    • +
  • ready
    • +
  • statistics
    • +
  • taskError
    • +
  • taskPerformance
    • +
  • timestamp
    • +
  • workerId
    • -
    +
  • AbstractPool
    • +
  • AbstractWorker
    • +
  • CircularArray
    • +
  • ClusterWorker
    • +
  • DynamicClusterPool
    • +
  • DynamicThreadPool
    • +
  • FixedClusterPool
    • +
  • FixedThreadPool
    • +
  • PoolEmitter
    • +
  • Queue
    • +
  • ThreadWorker
    • +
  • WorkerChoiceStrategyContext
    • +
  • ClusterPoolOptions
    • +
  • EventLoopUtilizationMeasurementStatistics
    • +
  • IPool
    • +
  • IWorker
    • +
  • IWorkerChoiceStrategy
    • +
  • IWorkerNode
    • +
  • MeasurementOptions
    • +
  • MeasurementStatistics
    • +
  • MeasurementStatisticsRequirements
    • +
  • MessageValue
    • +
  • PoolInfo
    • +
  • PoolOptions
    • +
  • PromiseResponseWrapper
    • +
  • StrategyPolicy
    • +
  • Task
    • +
  • TaskError
    • +
  • TaskPerformance
    • +
  • TaskStatistics
    • +
  • TaskStatisticsRequirements
    • +
  • TasksQueueOptions
    • +
  • ThreadPoolOptions
    • +
  • WorkerChoiceStrategyOptions
    • +
  • WorkerInfo
    • +
  • WorkerOptions
    • +
  • WorkerStatistics
    • +
  • WorkerUsage
    • +
  • ErrorHandler
    • +
  • ExitHandler
    • +
  • KillBehavior
    • +
  • Measurement
    • +
  • MessageHandler
    • +
  • OnlineHandler
    • +
  • PoolEvent
    • +
  • PoolType
    • +
  • TaskFunctions
    • +
  • WorkerAsyncFunction
    • +
  • WorkerChoiceStrategy
    • +
  • WorkerFunction
    • +
  • WorkerSyncFunction
    • +
  • WorkerType
    • +
  • KillBehaviors
    • +
  • Measurements
    • +
  • PoolEvents
    • +
  • PoolTypes
    • +
  • WorkerChoiceStrategies
    • +
  • WorkerTypes
    • +
  • availableParallelism

    • Generated using TypeDoc

    \ No newline at end of file