X-Git-Url: https://git.piment-noir.org/?a=blobdiff_plain;f=docs%2Finterfaces%2FTask.html;h=b2bacebf97362f3cfde31d34438ab11987968391;hb=0e16e60a89029abe61cda7ba293c036298cced05;hp=219826f261c4df1c99c5a2e04411ddd7024d4428;hpb=e1d3eccbb484bfbe36f6dcb9c4ef22a11621a00b;p=poolifier.git diff --git a/docs/interfaces/Task.html b/docs/interfaces/Task.html index 219826f2..b8b5610d 100644 --- a/docs/interfaces/Task.html +++ b/docs/interfaces/Task.html @@ -1,4 +1,4 @@ -Task | poolifier
+Task | poolifier - v2.6.26
  • Preparing search index...
    • -
  • The search index is not available
poolifier
+
  • The search index is not available
    • poolifier - v2.6.26
    @@ -17,22 +17,24 @@

    Interface Task<Data>Internal

    Message object that is passed as a task between main worker and worker.

    -
    -
    +
    +
    +

    Type Parameters

    -
    +

    Data = unknown

    +

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

    +
    +

    Hierarchy

    @@ -40,30 +42,68 @@

    Properties

    -
    data? -id? +
    data? +name? +taskId? +timestamp? +transferList? +workerId

    Properties

    -
    -

    Optional Readonly data

    -
    data?: Data
    +
    +

    Optional Readonly data

    +
    data?: Data

    Task input data that will be passed to the worker.

    -
    -
    -

    Optional Readonly id

    -
    id?: string
    -

    UUID of the message.

    -
    +
    +

    Optional Readonly name

    +
    name?: string
    +

    Task name.

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

    Optional Readonly taskId

    +
    taskId?: string
    +

    Task UUID.

    +
    +
    +
    +

    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

    @@ -73,54 +113,80 @@
    • -

    Theme

    +

    Theme

    -

    On This Page

     +

    On This Page

    +
  • data
    • +
  • name
    • +
  • taskId
    • +
  • timestamp
    • +
  • transferList
    • +
  • 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
    • +
  • KillHandler
    • +
  • Measurement
    • +
  • MessageHandler
    • +
  • OnlineHandler
    • +
  • PoolEvent
    • +
  • PoolType
    • +
  • TaskAsyncFunction
    • +
  • TaskFunction
    • +
  • TaskFunctions
    • +
  • TaskSyncFunction
    • +
  • WorkerChoiceStrategy
    • +
  • WorkerType
    • +
  • KillBehaviors
    • +
  • Measurements
    • +
  • PoolEvents
    • +
  • PoolTypes
    • +
  • WorkerChoiceStrategies
    • +
  • WorkerTypes
    • +
  • availableParallelism

    • Generated using TypeDoc

    \ No newline at end of file